• Home
• Axiom
• Samples
• SdkTrayManager

C# Class Axiom.Samples.SdkTrayManager

Show file Open project: WolfgangSt/axiom Class Usage Examples

Protected Properties

Property	Type	Description
CursorWasVisible	bool
Dialog	TextBox
LoadBar	Axiom.Samples.ProgressBar
Logo	DecorWidget
Mouse	SharpInputSystem.Mouse
StatsPanel	ParamsPanel
backdrop	Axiom.Overlays.OverlayElementContainer
backdropLayer	Axiom.Overlays.Overlay
cursor	Axiom.Overlays.OverlayElementContainer
cursorLayer	Axiom.Overlays.Overlay
expandedMenu	SelectMenu
groupInitProportion	Real
groupLoadProportion	Real
listener	ISdkTrayListener
loadInc	Real
mDialogShade	Axiom.Overlays.OverlayElementContainer
mFpsLabel	Label
mName	String
mNo	Axiom.Samples.Button
mOk	Axiom.Samples.Button
mPriorityLayer	Axiom.Overlays.Overlay
mTrayDrag	bool
mTrayPadding	Real
mTrays	Axiom.Overlays.OverlayElementContainer[]
mTraysLayer	Axiom.Overlays.Overlay
mWidgetDeathRow	System.Collections.Generic.List
mWidgetPadding	Real
mWidgetSpacing	Real
mWidgets	WidgetList[]
mWindow	Axiom.Graphics.RenderWindow
mYes	Axiom.Samples.Button
trayWidgetAlign	HorizontalAlignment[]

Public Methods

Method	Description
AdjustTrays ( ) : void	Fits trays to their contents and snaps them to their anchor locations.
CheckboxToggled ( CheckBox box ) : void
ClearAllTrays ( ) : void	Removes all widgets from all widget trays.
ClearTray ( TrayLocation trayLoc ) : void	Removes all widgets from a widget tray.
CloseDialog ( ) : void	Hides whatever dialog is currently showing.
CreateButton ( TrayLocation trayLoc, String name, String caption ) : Axiom.Samples.Button
CreateButton ( TrayLocation trayLoc, String name, String caption, Real width ) : Axiom.Samples.Button
CreateCheckBox ( TrayLocation trayLoc, String name, System.String caption ) : CheckBox
CreateCheckBox ( TrayLocation trayLoc, String name, System.String caption, Real width ) : CheckBox
CreateDecorWidget ( TrayLocation trayLoc, String name, String typeName, String templateName ) : DecorWidget
CreateLabel ( TrayLocation trayLoc, String name, System.String caption ) : Label
CreateLabel ( TrayLocation trayLoc, String name, System.String caption, Real width ) : Label
CreateLogoWidget ( TrayLocation trayLoc, String name, String typeName, String templateName ) : DecorWidget
CreateLongSelectMenu ( TrayLocation trayLoc, String name, System.String caption, Real width, Real boxWidth, int maxItemsShown ) : SelectMenu
CreateLongSelectMenu ( TrayLocation trayLoc, String name, System.String caption, Real width, Real boxWidth, int maxItemsShown, IList items ) : SelectMenu
CreateLongSlider ( TrayLocation trayLoc, String name, System.String caption, Real width, Real trackWidth, Real valueBoxWidth, Real minValue, Real maxValue, int snaps ) : Axiom.Samples.Slider
CreateLongSlider ( TrayLocation trayLoc, String name, System.String caption, Real trackWidth, Real valueBoxWidth, Real minValue, Real maxValue, int snaps ) : Axiom.Samples.Slider
CreateParamsPanel ( TrayLocation trayLoc, String name, Real width, IList paramNames ) : ParamsPanel
CreateParamsPanel ( TrayLocation trayLoc, String name, Real width, int lines ) : ParamsPanel
CreateProgressBar ( TrayLocation trayLoc, String name, System.String caption, Real width, Real commentBoxWidth ) : Axiom.Samples.ProgressBar
CreateSeparator ( TrayLocation trayLoc, String name ) : Separator
CreateSeparator ( TrayLocation trayLoc, String name, Real width ) : Separator
CreateTextBox ( TrayLocation trayLoc, String name, System.String caption, Real width, Real height ) : TextBox
CreateThickSelectMenu ( TrayLocation trayLoc, String name, System.String caption, Real width, int maxItemsShown ) : SelectMenu
CreateThickSelectMenu ( TrayLocation trayLoc, String name, System.String caption, Real width, int maxItemsShown, IList items ) : SelectMenu
CreateThickSlider ( TrayLocation trayLoc, String name, System.String caption, Real width, Real valueBoxWidth, Real minValue, Real maxValue, int snaps ) : Axiom.Samples.Slider
DestroyAllWidgets ( ) : void	Destroys all widgets.
DestroyAllWidgetsInTray ( TrayLocation trayLoc ) : void	Destroys all widgets in a tray.
DestroyWidget ( String name ) : void	Destroys a widget.
DestroyWidget ( TrayLocation trayLoc, String name ) : void	Destroys a widget.
DestroyWidget ( TrayLocation trayLoc, int place ) : void	Destroys a widget.
DestroyWidget ( Widget widget ) : void	Destroys a widget.
Dispose ( ) : void	Destroys background, cursor, widgets, and trays.
FrameRenderingQueued ( FrameEventArgs evt ) : bool	Process frame events. Updates frame statistics widget set and deletes all widgets queued for destruction.
GetCursorRay ( Camera cam ) : Ray	Returns a 3D ray into the scene that is directly underneath the cursor.
GetWidget ( String name ) : Widget	Gets a widget by name.
GetWidget ( TrayLocation trayLoc, String name ) : Widget	Gets a widget from a tray by name.
GetWidget ( TrayLocation trayLoc, int place ) : Widget	Gets a widget from a tray by place.
GetWidgetCount ( TrayLocation trayLoc ) : int	Gets the number of widgets in a tray.
GetWidgetEnumerator ( TrayLocation trayLoc ) : IEnumerator	Gets all the widgets of a specific tray.
HideAll ( ) : void
HideBackdrop ( ) : void
HideCursor ( ) : void
HideFrameStats ( ) : void	Hides frame statistics widget set.
HideLoadingBar ( ) : void
HideLogo ( ) : void
HideTrays ( ) : void
InjectMouseDown ( SharpInputSystem evt, SharpInputSystem id ) : bool	Processes mouse button down events. Returns true if the event was consumed and should not be passed on to other handlers.
InjectMouseMove ( SharpInputSystem evt ) : bool	Updates cursor position. Returns true if the event was consumed and should not be passed on to other handlers.
InjectMouseUp ( SharpInputSystem evt, SharpInputSystem id ) : bool	Processes mouse button up events. Returns true if the event was consumed and should not be passed on to other handlers.
ItemSelected ( SelectMenu menu ) : void
LabelHit ( Label label ) : void	Toggles visibility of advanced statistics.
LocateWidgetInTray ( Widget widget ) : int	Gets a widget's position in its tray.
MoveWidgetToTray ( String name, TrayLocation trayLoc ) : void	Adds a widget to a specified tray.
MoveWidgetToTray ( String name, TrayLocation trayLoc, int place ) : void	Adds a widget to a specified tray.
MoveWidgetToTray ( TrayLocation currentTrayLoc, String name, TrayLocation targetTrayLoc ) : void	Adds a widget to a specified tray.
MoveWidgetToTray ( TrayLocation currentTrayLoc, String name, TrayLocation targetTrayLoc, int place ) : void	Adds a widget to a specified tray.
MoveWidgetToTray ( TrayLocation currentTrayLoc, int currentPlace, TrayLocation targetTrayLoc ) : void	Adds a widget to a specified tray.
MoveWidgetToTray ( TrayLocation currentTrayLoc, int currentPlace, TrayLocation targetTrayLoc, int targetPlace ) : void	Adds a widget to a specified tray.
MoveWidgetToTray ( Widget widget, TrayLocation trayLoc ) : void	Adds a widget to a specified tray.
MoveWidgetToTray ( Widget widget, TrayLocation trayLoc, int place ) : void	Adds a widget to a specified tray.
OkDialogClosed ( string text ) : void
OnButtonHit ( object sender, Axiom.Samples.Button button ) : void	Destroys dialog widgets, notifies listener, and ends high priority session.
RefreshCursor ( ) : void	Updates cursor position based on unbuffered mouse state. This is necessary because if the tray manager has been cut off from mouse events for a time, the cursor position will be out of date.
RemoveWidgetFromTray ( String name ) : void	Removes a widget from its tray. Same as moving it to the null tray.
RemoveWidgetFromTray ( TrayLocation trayLoc, String name ) : void	Removes a widget from its tray. Same as moving it to the null tray.
RemoveWidgetFromTray ( TrayLocation trayLoc, int place ) : void	Removes a widget from its tray. Same as moving it to the null tray.
RemoveWidgetFromTray ( Widget widget ) : void	Removes a widget from its tray. Same as moving it to the null tray.
ResourceGroupLoadEnded ( string groupName ) : void	This event is fired when a resource group finished loading.
ResourceGroupLoadStarted ( string groupName, int resourceCount ) : void	This event is fired when a resource group begins loading.
ResourceGroupPrepareEnded ( string groupName ) : void
ResourceGroupPrepareStarted ( string groupName, int resourceCount ) : void
ResourceGroupScriptingEnded ( string groupName ) : void	This event is fired when a resource group finished parsing scripts.
ResourceGroupScriptingStarted ( string groupName, int scriptCount ) : void	This event is fired when a resource group begins parsing scripts.
ResourceLoadEnded ( ) : void	This event is fired when the resource has been loaded.
ResourceLoadStarted ( Axiom.Core.Resource resource ) : void	This event is fired when a declared resource is about to be loaded.
ResourcePrepareEnded ( ) : void
ResourcePrepareStarted ( Axiom.Core.Resource resource ) : void
ScreenToScene ( Camera cam, Vector2 pt ) : Ray	Converts a 2D screen coordinate (in pixels) to a 3D ray into the scene.
ScriptParseEnded ( string scriptName, bool skipped ) : void	This event is fired when the script has been fully parsed.
ScriptParseStarted ( string scriptName, bool &skipThisScript ) : void	This event is fired when a script is about to be parsed.
SdkTrayManager ( String name, Axiom.Graphics.RenderWindow window, SharpInputSystem mouse ) : System	Creates backdrop, cursor, and trays.
SdkTrayManager ( String name, Axiom.Graphics.RenderWindow window, SharpInputSystem mouse, ISdkTrayListener listener ) : System	Creates backdrop, cursor, and trays.
SetTrayWidgetAlignment ( TrayLocation trayLoc, HorizontalAlignment gha ) : void	Sets horizontal alignment of a tray's contents.
ShowAll ( ) : void
ShowBackdrop ( ) : void	Displays specified material on backdrop, or the last material used if none specified. Good for pause menus like in the browser.
ShowBackdrop ( String materialName ) : void	Displays specified material on backdrop, or the last material used if none specified. Good for pause menus like in the browser.
ShowCursor ( ) : void	Displays specified material on cursor, or the last material used if none specified. Used to change cursor type.
ShowCursor ( String materialName ) : void	Displays specified material on cursor, or the last material used if none specified. Used to change cursor type.
ShowFrameStats ( TrayLocation trayLoc ) : void	Shows frame statistics widget set in the specified location.
ShowFrameStats ( TrayLocation trayLoc, int place ) : void	Shows frame statistics widget set in the specified location.
ShowLoadingBar ( ) : void	Shows loading bar. Also takes job settings: the number of resource groups to be initialised, the number of resource groups to be loaded, and the proportion of the job that will be taken up by initialization. Usually, script parsing takes up most time, so the default value is 0.7.
ShowLoadingBar ( int numGroupsInit, int numGroupsLoad ) : void	Shows loading bar. Also takes job settings: the number of resource groups to be initialised, the number of resource groups to be loaded, and the proportion of the job that will be taken up by initialization. Usually, script parsing takes up most time, so the default value is 0.7.
ShowLoadingBar ( int numGroupsInit, int numGroupsLoad, Real initProportion ) : void	Shows loading bar. Also takes job settings: the number of resource groups to be initialised, the number of resource groups to be loaded, and the proportion of the job that will be taken up by initialization. Usually, script parsing takes up most time, so the default value is 0.7.
ShowLogo ( TrayLocation trayLoc ) : void	Shows logo in the specified location.
ShowLogo ( TrayLocation trayLoc, int place ) : void	Shows logo in the specified location.
ShowOkDialog ( System.String caption, System.String message ) : void	Pops up a message dialog with an OK button.
ShowTrays ( ) : void
ShowYesNoDialog ( System.String caption, System.String question ) : void	Pops up a question dialog with Yes and No buttons.
SliderMoved ( Axiom.Samples.Slider slider ) : void
ToggleAdvancedFrameStats ( ) : void	Toggles visibility of advanced statistics.
WorldGeometryStageEnded ( ) : void	This event is fired when a stage of loading linked world geometry has been completed. The number of stages required will have been included in the resourceCount passed in resourceGroupLoadStarted.
WorldGeometryStageStarted ( string description ) : void	This event is fired when a stage of loading linked world geometry is about to start. The number of stages required will have been included in the resourceCount passed in resourceGroupLoadStarted.
YesNoDialogClosed ( string text, bool yesHit ) : void
createLongSelectMenu ( TrayLocation trayLoc, String name, System.String caption, Real boxWidth, int maxItemsShown ) : SelectMenu
sceneToScreen ( Camera cam, Vector3 pt ) : Vector2	Converts a 3D scene position to a 2D screen coordinate (in pixels).

Method Details

Property Details