C# Class Axiom.Samples.Widget

Abstract base class for all widgets.

Show file Open project: WolfgangSt/axiom Class Usage Examples

Protected Properties

Property	Type	Description
element	Axiom.Overlays.OverlayElement
listener	ISdkTrayListener
trayLoc	TrayLocation

Public Methods

Method	Description
Cleanup ( ) : void
CursorOffset ( OverlayElement element, Vector2 cursorPos ) : Vector2	Static utility method used to get the cursor's offset from the center of an overlay element in pixels.
FitCaptionToArea ( String caption, TextArea area, Real maxWidth ) : void	Static utility method to cut off a string to fit in a text area.
GetCaptionWidth ( String caption, TextArea area ) : Real	Static utility method used to get the width of a caption in a text area.
Hide ( ) : void
IsCursorOver ( OverlayElement element, Vector2 cursorPos ) : bool	Static utility method to check if the cursor is over an overlay element.
IsCursorOver ( OverlayElement element, Vector2 cursorPos, Real voidBorder ) : bool
NukeOverlayElement ( OverlayElement element ) : void	Static utility method to recursively delete an overlay element plus all of its children from the system.
OnCursorMoved ( Vector2 cursorPos ) : void	Raises the CursorMoved event.
OnCursorPressed ( Vector2 cursorPos ) : void	Raises the CursorPressed event.
OnCursorReleased ( Vector2 cursorPos ) : void	Raises the CursorReleased event.
OnLostFocus ( ) : void	Raises raises the LostFocus event.
Show ( ) : void
Widget ( ) : System

Method Details

Cleanup() public method

public Cleanup ( ) : void
return	void

CursorOffset() public static method

Static utility method used to get the cursor's offset from the center

of an overlay element in pixels.

public static CursorOffset ( OverlayElement element, Vector2 cursorPos ) : Vector2
element	Axiom.Overlays.OverlayElement
cursorPos	Vector2
return	Vector2

FitCaptionToArea() public static method

Static utility method to cut off a string to fit in a text area.

public static FitCaptionToArea ( String caption, TextArea area, Real maxWidth ) : void
caption	String
area	Axiom.Overlays.Elements.TextArea
maxWidth	Real
return	void

GetCaptionWidth() public static method

Static utility method used to get the width of a caption in a text area.

public static GetCaptionWidth ( String caption, TextArea area ) : Real
caption	String
area	Axiom.Overlays.Elements.TextArea
return	Real

Hide() public method

public Hide ( ) : void
return	void

IsCursorOver() public static method

Static utility method to check if the cursor is over an overlay element.

public static IsCursorOver ( OverlayElement element, Vector2 cursorPos ) : bool
element	Axiom.Overlays.OverlayElement
cursorPos	Vector2
return	bool

IsCursorOver() public static method

public static IsCursorOver ( OverlayElement element, Vector2 cursorPos, Real voidBorder ) : bool
element	Axiom.Overlays.OverlayElement
cursorPos	Vector2
voidBorder	Real
return	bool

NukeOverlayElement() public static method

Static utility method to recursively delete an overlay element plus

all of its children from the system.

public static NukeOverlayElement ( OverlayElement element ) : void
element	Axiom.Overlays.OverlayElement
return	void

OnCursorMoved() public method

Raises the CursorMoved event.

public OnCursorMoved ( Vector2 cursorPos ) : void
cursorPos	Vector2	current cursor position
return	void

OnCursorPressed() public method

Raises the CursorPressed event.

public OnCursorPressed ( Vector2 cursorPos ) : void
cursorPos	Vector2	current cursor position
return	void

OnCursorReleased() public method

Raises the CursorReleased event.

public OnCursorReleased ( Vector2 cursorPos ) : void
cursorPos	Vector2	current cursor position
return	void

OnLostFocus() public method

Raises raises the LostFocus event.

public OnLostFocus ( ) : void
return	void

Show() public method

public Show ( ) : void
return	void

Widget() public method

public Widget ( ) : System
return	System

Property Details

element protected property

protected OverlayElement,Axiom.Overlays element
return	Axiom.Overlays.OverlayElement

listener protected property

protected ISdkTrayListener listener
return	ISdkTrayListener

trayLoc protected property

protected TrayLocation trayLoc
return	TrayLocation