C# Class Axiom.Overlays.OverlayElementContainer

A 2D element which contains other OverlayElement instances.
This is a specialization of OverlayElement for 2D elements that contain other elements. These are also the smallest elements that can be attached directly to an Overlay.

OverlayElementContainers should be managed using OverlayElementManager. This class is responsible for instantiating elements, and also for accepting new types of element from plugins etc.

Inheritance: OverlayElement
Show file Open project: WolfgangSt/axiom Class Usage Examples

Protected Properties

Property Type Description
childContainers OverlayElement>.Dictionary
children OverlayElement>.Dictionary
childrenProcessEvents bool

Public Methods

Method Description
AddChild ( OverlayElement element ) : void

Adds another OverlayElement to this container.
AddChildContainer ( OverlayElementContainer container ) : void

Add a nested container to this container.
AddChildElement ( OverlayElement element ) : void

Adds another OverlayElement to this container.
Clone ( string instanceName ) : OverlayElement
CopyFromTemplate ( OverlayElement templateOverlay ) : void
FindElementAt ( float x, float y ) : OverlayElement
GetChild ( string name ) : OverlayElement

Gets the named child of this container.
Initialize ( ) : void
NotifyParent ( OverlayElementContainer parent, Overlay overlay ) : void
NotifyViewport ( ) : void
NotifyWorldTransforms ( Matrix4 xform ) : void
NotifyZOrder ( int zOrder ) : int
PositionsOutOfDate ( ) : void

Tell the object and its children to recalculate their positions.
RemoveChild ( string name ) : void

Removes a child element by its name
Update ( ) : void
UpdateRenderQueue ( RenderQueue queue ) : void
UpdateRenderQueue ( RenderQueue queue, bool updateChildren ) : void

Protected Methods

Method Description
OverlayElementContainer ( string name ) : System

Don't use directly, create through GuiManager.CreateElement.
dispose ( bool disposeManagedResources ) : void

Method Details

AddChild() public method

Adds another OverlayElement to this container.
public AddChild ( OverlayElement element ) : void
element OverlayElement
return void

AddChildContainer() public method

Add a nested container to this container.
public AddChildContainer ( OverlayElementContainer container ) : void
container OverlayElementContainer
return void

AddChildElement() public method

Adds another OverlayElement to this container.
public AddChildElement ( OverlayElement element ) : void
element OverlayElement
return void

Clone() public method

public Clone ( string instanceName ) : OverlayElement
instanceName string
return OverlayElement

CopyFromTemplate() public method

public CopyFromTemplate ( OverlayElement templateOverlay ) : void
templateOverlay OverlayElement
return void

FindElementAt() public method

public FindElementAt ( float x, float y ) : OverlayElement
x float
y float
return OverlayElement

GetChild() public method

Gets the named child of this container.
public GetChild ( string name ) : OverlayElement
name string
return OverlayElement

Initialize() public method

public Initialize ( ) : void
return void

NotifyParent() public method

public NotifyParent ( OverlayElementContainer parent, Overlay overlay ) : void
parent OverlayElementContainer
overlay Overlay
return void

NotifyViewport() public method

public NotifyViewport ( ) : void
return void

NotifyWorldTransforms() public method

public NotifyWorldTransforms ( Matrix4 xform ) : void
xform Axiom.Math.Matrix4
return void

NotifyZOrder() public method

public NotifyZOrder ( int zOrder ) : int
zOrder int
return int

OverlayElementContainer() protected method

Don't use directly, create through GuiManager.CreateElement.
protected OverlayElementContainer ( string name ) : System
name string
return System

PositionsOutOfDate() public method

Tell the object and its children to recalculate their positions.
public PositionsOutOfDate ( ) : void
return void

RemoveChild() public method

Removes a child element by its name
public RemoveChild ( string name ) : void
name string
return void

Update() public method

public Update ( ) : void
return void

UpdateRenderQueue() public method

public UpdateRenderQueue ( RenderQueue queue ) : void
queue Axiom.Graphics.RenderQueue
return void

UpdateRenderQueue() public method

public UpdateRenderQueue ( RenderQueue queue, bool updateChildren ) : void
queue Axiom.Graphics.RenderQueue
updateChildren bool
return void

dispose() protected method

protected dispose ( bool disposeManagedResources ) : void
disposeManagedResources bool
return void

Property Details

childContainers protected property

protected Dictionary childContainers
return OverlayElement>.Dictionary

children protected property

protected Dictionary children
return OverlayElement>.Dictionary

childrenProcessEvents protected property

protected bool childrenProcessEvents
return bool