C# Class Axiom.Samples.Widget

Abstract base class for all widgets.

Afficher le fichier Open project: WolfgangSt/axiom Class Usage Examples

Protected Properties

Свойство	Type	Description
element	Axiom.Overlays.OverlayElement
listener	ISdkTrayListener
trayLoc	TrayLocation

Méthodes publiques

Méthode	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 méthode

public Cleanup ( ) : void
Résultat	void

CursorOffset() public static méthode

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
Résultat	Vector2

FitCaptionToArea() public static méthode

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
Résultat	void

GetCaptionWidth() public static méthode

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
Résultat	Real

Hide() public méthode

public Hide ( ) : void
Résultat	void

IsCursorOver() public static méthode

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
Résultat	bool

IsCursorOver() public static méthode

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

NukeOverlayElement() public static méthode

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
Résultat	void

OnCursorMoved() public méthode

Raises the CursorMoved event.

public OnCursorMoved ( Vector2 cursorPos ) : void
cursorPos	Vector2	current cursor position
Résultat	void

OnCursorPressed() public méthode

Raises the CursorPressed event.

public OnCursorPressed ( Vector2 cursorPos ) : void
cursorPos	Vector2	current cursor position
Résultat	void

OnCursorReleased() public méthode

Raises the CursorReleased event.

public OnCursorReleased ( Vector2 cursorPos ) : void
cursorPos	Vector2	current cursor position
Résultat	void

OnLostFocus() public méthode

Raises raises the LostFocus event.

public OnLostFocus ( ) : void
Résultat	void

Show() public méthode

public Show ( ) : void
Résultat	void

Widget() public méthode

public Widget ( ) : System
Résultat	System

Property Details

element protected_oe property

protected OverlayElement,Axiom.Overlays element
Résultat	Axiom.Overlays.OverlayElement

listener protected_oe property

protected ISdkTrayListener listener
Résultat	ISdkTrayListener

trayLoc protected_oe property

protected TrayLocation trayLoc
Résultat	TrayLocation