• Home
• Axiom
• Overlays
• OverlayElement

C# Class Axiom.Overlays.OverlayElement

Show file Open project: WolfgangSt/axiom Class Usage Examples

Protected Properties

Property	Type	Description
clippingRegion	Axiom.Core.Rectangle
color	Axiom.Core.ColorEx
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	Axiom.Graphics.Material
materialName	string
metricsMode	MetricsMode
name	string
overlay	Overlay
parent	OverlayElementContainer
pixelHeight	float
pixelLeft	float
pixelScaleX	float
pixelScaleY	float
pixelTop	float
pixelWidth	float
renderOperation	Axiom.Graphics.RenderOperation
sourceTemplate	OverlayElement
text	string
vertAlign	VerticalAlignment
xform	Axiom.MathLib.Matrix4[]
zOrder	int

Public Methods

Method	Description
Clone ( string instanceName ) : OverlayElement
Contains ( float x, float y ) : bool	Returns true if xy is within the constraints of the component
CopyFromTemplate ( OverlayElement template ) : void	Copys data from the template element to this element to clone it.
CopyParametersTo ( OverlayElement instance ) : void
FindElementAt ( float x, float y ) : OverlayElement	Returns true if xy is within the constraints of the component
GetCustomParameter ( int index ) : Vector4
GetSquaredViewDepth ( Camera camera ) : float	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 ( OverlayElementContainer parent, Overlay overlay ) : void	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 ( GpuProgramParameters entry, GpuProgramParameters gpuParams ) : void
UpdateFromParent ( ) : void	Updates this elements transform based on it's parent.
UpdateRenderQueue ( RenderQueue queue ) : void	Internal method to put the contents onto the render queue.

Protected Methods

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 ); }

Method Details

Property Details