Property | Type | Description | |
---|---|---|---|
clippingRegion | |||
color | |||
customParams | List |
||
derivedLeft | float | ||
emptyLightList | LightList | ||
horzAlign | HorizontalAlignment | ||
isCloneable | bool | ||
isDerivedOutOfDate | bool | ||
isEnabled | bool | ||
isGeomPositionsOutOfDate | bool | ||
isGeomUVsOutOfDate | bool | ||
isInitialized | bool | ||
isVisible | bool | ||
left | float | ||
material | |||
materialName | string | ||
metricsMode | MetricsMode | ||
name | string | ||
overlay | |||
parent | |||
pixelHeight | float | ||
pixelLeft | float | ||
pixelScaleX | float | ||
pixelScaleY | float | ||
pixelTop | float | ||
pixelWidth | float | ||
renderOperation | |||
sourceTemplate | |||
text | string | ||
vertAlign | VerticalAlignment | ||
xform | Axiom.MathLib.Matrix4[] | ||
zOrder | int |
Method | Description | |
---|---|---|
Clone ( string instanceName ) : |
||
Contains ( float x, float y ) : bool |
Returns true if xy is within the constraints of the component
|
|
CopyFromTemplate ( |
Copys data from the template element to this element to clone it.
|
|
CopyParametersTo ( |
||
FindElementAt ( float x, float y ) : |
Returns true if xy is within the constraints of the component
|
|
GetCustomParameter ( int index ) : Vector4 | ||
GetSquaredViewDepth ( |
Implementation of IRenderable.
|
|
GetWorldOrientation ( ) : Axiom.MathLib.Quaternion |
|
|
GetWorldPosition ( ) : Vector3 | ||
GetWorldTransforms ( Axiom.MathLib.Matrix4 matrices ) : void |
|
|
Hide ( ) : void |
Hides an element if it is currently visible.
|
|
Initialize ( ) : void |
Initialize the OverlayElement.
|
|
NotifyParent ( |
Internal method for notifying the gui element of it's parent and ultimate overlay.
|
|
NotifyViewport ( ) : void |
Notifies the viewport.
|
|
NotifyWorldTransforms ( Axiom.MathLib.Matrix4 xform ) : void |
Notifies the world transforms.
|
|
NotifyZOrder ( int zOrder ) : int |
Internal method to notify the element when Zorder of parent overlay has changed. Overlays have explicit Z orders. OverlayElements do not, they inherit the ZOrder of the overlay, and the Zorder is incremented for every container nested within this to ensure that containers are displayed behind contained items. This method is used internally to notify the element of a change in final zorder which is used to render the element. |
|
PositionsOutOfDate ( ) : void |
Tells this element to recaculate it's position.
|
|
ScreenDimensions ( float width, float height ) : void |
Sets the width and height of this element in relation to the screen (where 1.0 = screen width)
|
|
ScreenHeight ( float height ) : void |
Sets the height of this element in relation to the screen (where 1.0 = screen width)
|
|
ScreenLeft ( float left ) : void |
Sets the left of this element in relation to the screen (where 1.0 = screen width)
|
|
ScreenPosition ( float left, float top ) : void |
Sets the left and top of this element in relation to the screen (where 1.0 = screen width)
|
|
ScreenTop ( float top ) : void |
Sets the top of this element in relation to the screen (where 1.0 = screen width)
|
|
ScreenWidth ( float width ) : void |
Sets the width of this element in relation to the screen (where 1.0 = screen width)
|
|
SetCustomParameter ( int index, Vector4 val ) : void | ||
SetDimensions ( float width, float height ) : void |
Sets the dimensions.
|
|
SetParam ( string param, string val ) : bool |
Sets param values from script values. Subclasses can define their own params in addition to what this base class already defines.
|
|
SetPosition ( float left, float top ) : void |
Sets the position of this element.
|
|
Show ( ) : void |
Shows this element if it was previously hidden.
|
|
Update ( ) : void |
Internal method to update the element based on transforms applied.
|
|
UpdateCustomGpuParameter ( |
||
UpdateFromParent ( ) : void |
Updates this elements transform based on it's parent.
|
|
UpdateRenderQueue ( |
Internal method to put the contents onto the render queue.
|
Method | Description | |
---|---|---|
OverlayElement ( string name ) : System |
|
|
UpdatePositionGeometry ( ) : void |
Internal method which is triggered when the positions of the element get updated, meaning the element should be rebuilding it's mesh positions. Abstract since subclasses must implement this.
|
|
UpdateTextureGeometry ( ) : void |
Internal method which is triggered when the UVs of the element get updated, meaning the element should be rebuilding it's mesh UVs. Abstract since subclasses must implement this.
|
|
dispose ( bool disposeManagedResources ) : void |
Class level dispose method When implementing this method in an inherited class the following template should be used; protected override void dispose( bool disposeManagedResources ) { if ( !isDisposed ) { if ( disposeManagedResources ) { // Dispose managed resources. } // There are no unmanaged resources to release, but // if we add them, they need to be released here. } // If it is available, make the call to the // base class's Dispose(Boolean) method base.dispose( disposeManagedResources ); } |
public Clone ( string instanceName ) : |
||
instanceName | string | |
return |
public CopyFromTemplate ( |
||
template | ||
return | void |
public CopyParametersTo ( |
||
instance | ||
return | void |
public FindElementAt ( float x, float y ) : |
||
x | float | The x. |
y | float | The y. |
return |
public GetCustomParameter ( int index ) : Vector4 | ||
index | int | |
return | Vector4 |
public GetSquaredViewDepth ( |
||
camera | ||
return | float |
public GetWorldOrientation ( ) : Axiom.MathLib.Quaternion | ||
return | Axiom.MathLib.Quaternion |
public GetWorldTransforms ( Axiom.MathLib.Matrix4 matrices ) : void | ||
matrices | Axiom.MathLib.Matrix4 | |
return | void |
public NotifyParent ( |
||
parent | Parent of this element. | |
overlay | Overlay this element belongs to. | |
return | void |
public NotifyWorldTransforms ( Axiom.MathLib.Matrix4 xform ) : void | ||
xform | Axiom.MathLib.Matrix4 | The xform. |
return | void |
public NotifyZOrder ( int zOrder ) : int | ||
zOrder | int | The z order. |
return | int |
protected OverlayElement ( string name ) : System | ||
name | string | |
return | System |
public ScreenDimensions ( float width, float height ) : void | ||
width | float | |
height | float | |
return | void |
public ScreenPosition ( float left, float top ) : void | ||
left | float | |
top | float | |
return | void |
public SetCustomParameter ( int index, Vector4 val ) : void | ||
index | int | |
val | Vector4 | |
return | void |
public SetDimensions ( float width, float height ) : void | ||
width | float | The width. |
height | float | The height. |
return | void |
public SetParam ( string param, string val ) : bool | ||
param | string | |
val | string | |
return | bool |
public SetPosition ( float left, float top ) : void | ||
left | float | The left. |
top | float | The top. |
return | void |
public UpdateCustomGpuParameter ( |
||
entry | ||
gpuParams | ||
return | void |
protected abstract UpdatePositionGeometry ( ) : void | ||
return | void |
public UpdateRenderQueue ( |
||
queue | Current render queue. | |
return | void |
protected abstract UpdateTextureGeometry ( ) : void | ||
return | void |
protected dispose ( bool disposeManagedResources ) : void | ||
disposeManagedResources | bool | True if Unmanaged resources should be released. |
return | void |
protected Rectangle,Axiom.Core clippingRegion | ||
return |
protected Material,Axiom.Graphics material | ||
return |
protected OverlayElementContainer,Axiom.Overlays parent | ||
return |
protected RenderOperation,Axiom.Graphics renderOperation | ||
return |
protected OverlayElement,Axiom.Overlays sourceTemplate | ||
return |