• Home
• FSO
• Client
• UI
• Framework
• UIElement

C# Class FSO.Client.UI.Framework.UIElement

Show file Open project: RHY3756547/FreeSO Class Usage Examples

Public Properties

Property	Type	Description
MASK_COLORS	uint[]
Visible	bool

Protected Properties

Property	Type	Description
_BlendColor	Color
_HasOpacity	bool
_Mtx	float[]
_MtxDirty	bool
_Opacity	float
_OpacityDirty	bool
_Parent	UIContainer
_Scale	Vector2
_ScaleParent	Vector2
_ScaleX	float
_ScaleY	float
_Tooltip	string
_X	float
_Y	float
m_StringID	string

Private Properties

Property	Type	Description

Public Methods

Method	Description
AddUpdateHook ( UpdateHookDelegate hook ) : void	Adds a callback that will be executed every update loop.
Async ( AsyncHandler handler ) : void	Little utility to make it easier to do work outside of the UI thread
Draw ( FSO.Client.UI.Framework.UISpriteBatch batch ) : void	Basic draw method. Your component should implement this and add any drawing behavior it needs.
DrawLocalString ( SpriteBatch batch, string text, Vector2 to, TextStyle style ) : void	This utility will draw a line of text onto the UIElement.
DrawLocalString ( SpriteBatch batch, string text, Vector2 to, TextStyle style, Rectangle bounds, TextAlignment align ) : void	This utility will draw a line of text onto the UIElement.
DrawLocalString ( SpriteBatch batch, string text, Vector2 to, TextStyle style, Rectangle bounds, TextAlignment align, Rectangle margin ) : void	This utility will draw a line of text onto the UIElement.
DrawLocalString ( SpriteBatch batch, string text, Vector2 to, TextStyle style, Rectangle bounds, TextAlignment align, Rectangle margin, UIElementState state ) : void	This utility will draw a line of text onto the UIElement.
DrawLocalTexture ( SpriteBatch batch, Microsoft.Xna.Framework.Graphics.Texture2D texture, Nullable from, Vector2 to, Vector2 scale ) : void	Draws a texture to the UIElement. This method will deal with the matrix calculations
DrawLocalTexture ( SpriteBatch batch, Microsoft.Xna.Framework.Graphics.Texture2D texture, Nullable from, Vector2 to, Vector2 scale, Color blend ) : void	Draws a texture to the UIElement. This method will deal with the matrix calculations
DrawLocalTexture ( SpriteBatch batch, Microsoft.Xna.Framework.Graphics.Texture2D texture, Rectangle from, Vector2 to ) : void	Draws a texture to the UIElement. This method will deal with the matrix calculations
DrawLocalTexture ( SpriteBatch batch, Microsoft.Xna.Framework.Graphics.Texture2D texture, Vector2 to ) : void	Draws a texture to the UIElement. This method will deal with the matrix calculations
DrawTiledTexture ( SpriteBatch batch, Microsoft.Xna.Framework.Graphics.Texture2D texture, Rectangle dest, Color blend ) : void
FlooredLocalPoint ( Vector2 point ) : Vector2
GetBounds ( ) : Rectangle	Gets the bounding box for the component
GetMousePosition ( Microsoft.Xna.Framework.Input.MouseState mouse ) : Vector2	Gets the local mouse coordinates for the given mouse state
GetTexture ( ContentID id ) : Microsoft.Xna.Framework.Graphics.Texture2D
GetTexture ( ulong id ) : Microsoft.Xna.Framework.Graphics.Texture2D
GlobalPoint ( Vector2 globalPoint ) : Vector2	Converts a point relative to the screen into a point relative to this component
HitTestArea ( UpdateState state, Rectangle area, bool cache ) : bool	Returns true if the mouse is over the given area
InvalidateMatrix ( ) : void	Utility to force the component to recalculate its matrix
InvalidateOpacity ( ) : void	Utility to force the component to recalculate its blend colour
ListenForMouse ( Rectangle region, UIMouseEvent callback ) : UIMouseEventRef
LocalPoint ( Vector2 point ) : Vector2	Converts a point relative to this UIElement into a point relative to the screen
LocalPoint ( float x, float y ) : Vector2	Converts a point relative to this UIElement into a point relative to the screen
LocalRect ( float x, float y, float w, float h ) : Rectangle	Converts a rectangle relative to this UIElement into a rectangle relative to the screen.
LocalRect ( float x, float y, float w, float h, float mtx ) : Rectangle	Converts a rectangle relative to this UIElement into a rectangle relative to the screen.
PreDraw ( FSO.Client.UI.Framework.UISpriteBatch batch ) : void	May be removed - Called before the draw method.
RemoveMouseListener ( UIMouseEventRef item ) : void
RemoveUpdateHook ( UpdateHookDelegate hook ) : void	Removes a previously added update hook.
StoreTexture ( ulong id, ContentResource assetData ) : Microsoft.Xna.Framework.Graphics.Texture2D
StoreTexture ( ulong id, ContentResource assetData, bool mask, bool cacheOnDisk ) : Microsoft.Xna.Framework.Graphics.Texture2D
ToString ( ) : string
Update ( UpdateState state ) : void	Standard UIElement update method. All sub-classes should call this super method. The argument is an UpdateState object, this object contains everything you may need during update including GameTime, MouseState, KeyboardState etc. This is useful because it means we dont ask for Mouse & Keyboard state in every UIElement which would be wasteful
WillDraw ( ) : bool	Scans through parents to determine if this element will be drawn.

Protected Methods

Method	Description
CalculateMatrix ( ) : void	Calculate a matrix which represents this objects position in screen space
CalculateOpacity ( ) : void	When the opacity changes this method is used to calculate the blend colour.
ManualTextureMask ( Microsoft.Xna.Framework.Graphics.Texture2D &Texture, Color ColorFrom ) : void	Manually replaces a specified color in a texture with transparent black, thereby masking it.

Method Details

Property Details