C# Class Axiom.Samples.SdkTrayManager

Main class to manage a cursor, backdrop, trays and widgets.
Inheritance: ISdkTrayListener, IResourceGroupListener
ファイルを表示 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

AdjustTrays() public method

Fits trays to their contents and snaps them to their anchor locations.
public AdjustTrays ( ) : void
return void

CheckboxToggled() public method

public CheckboxToggled ( CheckBox box ) : void
box CheckBox
return void

ClearAllTrays() public method

Removes all widgets from all widget trays.
public ClearAllTrays ( ) : void
return void

ClearTray() public method

Removes all widgets from a widget tray.
public ClearTray ( TrayLocation trayLoc ) : void
trayLoc TrayLocation
return void

CloseDialog() public method

Hides whatever dialog is currently showing.
public CloseDialog ( ) : void
return void

CreateButton() public method

public CreateButton ( TrayLocation trayLoc, String name, String caption ) : Axiom.Samples.Button
trayLoc TrayLocation
name String
caption String
return Axiom.Samples.Button

CreateButton() public method

public CreateButton ( TrayLocation trayLoc, String name, String caption, Real width ) : Axiom.Samples.Button
trayLoc TrayLocation
name String
caption String
width Real
return Axiom.Samples.Button

CreateCheckBox() public method

public CreateCheckBox ( TrayLocation trayLoc, String name, System.String caption ) : CheckBox
trayLoc TrayLocation
name String
caption System.String
return CheckBox

CreateCheckBox() public method

public CreateCheckBox ( TrayLocation trayLoc, String name, System.String caption, Real width ) : CheckBox
trayLoc TrayLocation
name String
caption System.String
width Real
return CheckBox

CreateDecorWidget() public method

public CreateDecorWidget ( TrayLocation trayLoc, String name, String typeName, String templateName ) : DecorWidget
trayLoc TrayLocation
name String
typeName String
templateName String
return DecorWidget

CreateLabel() public method

public CreateLabel ( TrayLocation trayLoc, String name, System.String caption ) : Label
trayLoc TrayLocation
name String
caption System.String
return Label

CreateLabel() public method

public CreateLabel ( TrayLocation trayLoc, String name, System.String caption, Real width ) : Label
trayLoc TrayLocation
name String
caption System.String
width Real
return Label

CreateLogoWidget() public method

public CreateLogoWidget ( TrayLocation trayLoc, String name, String typeName, String templateName ) : DecorWidget
trayLoc TrayLocation
name String
typeName String
templateName String
return DecorWidget

CreateLongSelectMenu() public method

public CreateLongSelectMenu ( TrayLocation trayLoc, String name, System.String caption, Real width, Real boxWidth, int maxItemsShown ) : SelectMenu
trayLoc TrayLocation
name String
caption System.String
width Real
boxWidth Real
maxItemsShown int
return SelectMenu

CreateLongSelectMenu() public method

public CreateLongSelectMenu ( TrayLocation trayLoc, String name, System.String caption, Real width, Real boxWidth, int maxItemsShown, IList items ) : SelectMenu
trayLoc TrayLocation
name String
caption System.String
width Real
boxWidth Real
maxItemsShown int
items IList
return SelectMenu

CreateLongSlider() public method

public CreateLongSlider ( TrayLocation trayLoc, String name, System.String caption, Real width, Real trackWidth, Real valueBoxWidth, Real minValue, Real maxValue, int snaps ) : Axiom.Samples.Slider
trayLoc TrayLocation
name String
caption System.String
width Real
trackWidth Real
valueBoxWidth Real
minValue Real
maxValue Real
snaps int
return Axiom.Samples.Slider

CreateLongSlider() public method

public CreateLongSlider ( TrayLocation trayLoc, String name, System.String caption, Real trackWidth, Real valueBoxWidth, Real minValue, Real maxValue, int snaps ) : Axiom.Samples.Slider
trayLoc TrayLocation
name String
caption System.String
trackWidth Real
valueBoxWidth Real
minValue Real
maxValue Real
snaps int
return Axiom.Samples.Slider

CreateParamsPanel() public method

public CreateParamsPanel ( TrayLocation trayLoc, String name, Real width, IList paramNames ) : ParamsPanel
trayLoc TrayLocation
name String
width Real
paramNames IList
return ParamsPanel

CreateParamsPanel() public method

public CreateParamsPanel ( TrayLocation trayLoc, String name, Real width, int lines ) : ParamsPanel
trayLoc TrayLocation
name String
width Real
lines int
return ParamsPanel

CreateProgressBar() public method

public CreateProgressBar ( TrayLocation trayLoc, String name, System.String caption, Real width, Real commentBoxWidth ) : Axiom.Samples.ProgressBar
trayLoc TrayLocation
name String
caption System.String
width Real
commentBoxWidth Real
return Axiom.Samples.ProgressBar

CreateSeparator() public method

public CreateSeparator ( TrayLocation trayLoc, String name ) : Separator
trayLoc TrayLocation
name String
return Separator

CreateSeparator() public method

public CreateSeparator ( TrayLocation trayLoc, String name, Real width ) : Separator
trayLoc TrayLocation
name String
width Real
return Separator

CreateTextBox() public method

public CreateTextBox ( TrayLocation trayLoc, String name, System.String caption, Real width, Real height ) : TextBox
trayLoc TrayLocation
name String
caption System.String
width Real
height Real
return TextBox

CreateThickSelectMenu() public method

public CreateThickSelectMenu ( TrayLocation trayLoc, String name, System.String caption, Real width, int maxItemsShown ) : SelectMenu
trayLoc TrayLocation
name String
caption System.String
width Real
maxItemsShown int
return SelectMenu

CreateThickSelectMenu() public method

public CreateThickSelectMenu ( TrayLocation trayLoc, String name, System.String caption, Real width, int maxItemsShown, IList items ) : SelectMenu
trayLoc TrayLocation
name String
caption System.String
width Real
maxItemsShown int
items IList
return SelectMenu

CreateThickSlider() public method

public CreateThickSlider ( TrayLocation trayLoc, String name, System.String caption, Real width, Real valueBoxWidth, Real minValue, Real maxValue, int snaps ) : Axiom.Samples.Slider
trayLoc TrayLocation
name String
caption System.String
width Real
valueBoxWidth Real
minValue Real
maxValue Real
snaps int
return Axiom.Samples.Slider

DestroyAllWidgets() public method

Destroys all widgets.
public DestroyAllWidgets ( ) : void
return void

DestroyAllWidgetsInTray() public method

Destroys all widgets in a tray.
public DestroyAllWidgetsInTray ( TrayLocation trayLoc ) : void
trayLoc TrayLocation
return void

DestroyWidget() public method

Destroys a widget.
public DestroyWidget ( String name ) : void
name String
return void

DestroyWidget() public method

Destroys a widget.
public DestroyWidget ( TrayLocation trayLoc, String name ) : void
trayLoc TrayLocation
name String
return void

DestroyWidget() public method

Destroys a widget.
public DestroyWidget ( TrayLocation trayLoc, int place ) : void
trayLoc TrayLocation
place int
return void

DestroyWidget() public method

Destroys a widget.
public DestroyWidget ( Widget widget ) : void
widget Widget
return void

Dispose() public method

Destroys background, cursor, widgets, and trays.
public Dispose ( ) : void
return void

FrameRenderingQueued() public method

Process frame events. Updates frame statistics widget set and deletes all widgets queued for destruction.
public FrameRenderingQueued ( FrameEventArgs evt ) : bool
evt FrameEventArgs
return bool

GetCursorRay() public method

Returns a 3D ray into the scene that is directly underneath the cursor.
public GetCursorRay ( Camera cam ) : Ray
cam Axiom.Core.Camera
return Axiom.Math.Ray

GetWidget() public method

Gets a widget by name.
public GetWidget ( String name ) : Widget
name String
return Widget

GetWidget() public method

Gets a widget from a tray by name.
public GetWidget ( TrayLocation trayLoc, String name ) : Widget
trayLoc TrayLocation
name String
return Widget

GetWidget() public method

Gets a widget from a tray by place.
public GetWidget ( TrayLocation trayLoc, int place ) : Widget
trayLoc TrayLocation
place int
return Widget

GetWidgetCount() public method

Gets the number of widgets in a tray.
public GetWidgetCount ( TrayLocation trayLoc ) : int
trayLoc TrayLocation
return int

GetWidgetEnumerator() public method

Gets all the widgets of a specific tray.
public GetWidgetEnumerator ( TrayLocation trayLoc ) : IEnumerator
trayLoc TrayLocation
return IEnumerator

HideAll() public method

public HideAll ( ) : void
return void

HideBackdrop() public method

public HideBackdrop ( ) : void
return void

HideCursor() public method

public HideCursor ( ) : void
return void

HideFrameStats() public method

Hides frame statistics widget set.
public HideFrameStats ( ) : void
return void

HideLoadingBar() public method

public HideLoadingBar ( ) : void
return void

HideLogo() public method

public HideLogo ( ) : void
return void

HideTrays() public method

public HideTrays ( ) : void
return void

InjectMouseDown() public method

Processes mouse button down events. Returns true if the event was

consumed and should not be passed on to other handlers.
public InjectMouseDown ( SharpInputSystem evt, SharpInputSystem id ) : bool
evt SharpInputSystem
id SharpInputSystem
return bool

InjectMouseMove() public method

Updates cursor position. Returns true if the event was

consumed and should not be passed on to other handlers.
public InjectMouseMove ( SharpInputSystem evt ) : bool
evt SharpInputSystem
return bool

InjectMouseUp() public method

Processes mouse button up events. Returns true if the event was

consumed and should not be passed on to other handlers.
public InjectMouseUp ( SharpInputSystem evt, SharpInputSystem id ) : bool
evt SharpInputSystem
id SharpInputSystem
return bool

ItemSelected() public method

public ItemSelected ( SelectMenu menu ) : void
menu SelectMenu
return void

LabelHit() public method

Toggles visibility of advanced statistics.
public LabelHit ( Label label ) : void
label Label
return void

LocateWidgetInTray() public method

Gets a widget's position in its tray.
public LocateWidgetInTray ( Widget widget ) : int
widget Widget
return int

MoveWidgetToTray() public method

Adds a widget to a specified tray.
public MoveWidgetToTray ( String name, TrayLocation trayLoc ) : void
name String
trayLoc TrayLocation
return void

MoveWidgetToTray() public method

Adds a widget to a specified tray.
public MoveWidgetToTray ( String name, TrayLocation trayLoc, int place ) : void
name String
trayLoc TrayLocation
place int
return void

MoveWidgetToTray() public method

Adds a widget to a specified tray.
public MoveWidgetToTray ( TrayLocation currentTrayLoc, String name, TrayLocation targetTrayLoc ) : void
currentTrayLoc TrayLocation
name String
targetTrayLoc TrayLocation
return void

MoveWidgetToTray() public method

Adds a widget to a specified tray.
public MoveWidgetToTray ( TrayLocation currentTrayLoc, String name, TrayLocation targetTrayLoc, int place ) : void
currentTrayLoc TrayLocation
name String
targetTrayLoc TrayLocation
place int
return void

MoveWidgetToTray() public method

Adds a widget to a specified tray.
public MoveWidgetToTray ( TrayLocation currentTrayLoc, int currentPlace, TrayLocation targetTrayLoc ) : void
currentTrayLoc TrayLocation
currentPlace int
targetTrayLoc TrayLocation
return void

MoveWidgetToTray() public method

Adds a widget to a specified tray.
public MoveWidgetToTray ( TrayLocation currentTrayLoc, int currentPlace, TrayLocation targetTrayLoc, int targetPlace ) : void
currentTrayLoc TrayLocation
currentPlace int
targetTrayLoc TrayLocation
targetPlace int
return void

MoveWidgetToTray() public method

Adds a widget to a specified tray.
public MoveWidgetToTray ( Widget widget, TrayLocation trayLoc ) : void
widget Widget
trayLoc TrayLocation
return void

MoveWidgetToTray() public method

Adds a widget to a specified tray.
public MoveWidgetToTray ( Widget widget, TrayLocation trayLoc, int place ) : void
widget Widget
trayLoc TrayLocation
place int
return void

OkDialogClosed() public method

public OkDialogClosed ( string text ) : void
text string
return void

OnButtonHit() public method

Destroys dialog widgets, notifies listener, and ends high priority session.
public OnButtonHit ( object sender, Axiom.Samples.Button button ) : void
sender object
button Axiom.Samples.Button
return void

RefreshCursor() public method

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.
public RefreshCursor ( ) : void
return void

RemoveWidgetFromTray() public method

Removes a widget from its tray. Same as moving it to the null tray.
public RemoveWidgetFromTray ( String name ) : void
name String
return void

RemoveWidgetFromTray() public method

Removes a widget from its tray. Same as moving it to the null tray.
public RemoveWidgetFromTray ( TrayLocation trayLoc, String name ) : void
trayLoc TrayLocation
name String
return void

RemoveWidgetFromTray() public method

Removes a widget from its tray. Same as moving it to the null tray.
public RemoveWidgetFromTray ( TrayLocation trayLoc, int place ) : void
trayLoc TrayLocation
place int
return void

RemoveWidgetFromTray() public method

Removes a widget from its tray. Same as moving it to the null tray.
public RemoveWidgetFromTray ( Widget widget ) : void
widget Widget
return void

ResourceGroupLoadEnded() public method

This event is fired when a resource group finished loading.
public ResourceGroupLoadEnded ( string groupName ) : void
groupName string
return void

ResourceGroupLoadStarted() public method

This event is fired when a resource group begins loading.
public ResourceGroupLoadStarted ( string groupName, int resourceCount ) : void
groupName string The name of the group being loaded
resourceCount int /// The number of resources which will be loaded, /// including a number of stages required to load any linked world geometry ///
return void

ResourceGroupPrepareEnded() public method

public ResourceGroupPrepareEnded ( string groupName ) : void
groupName string
return void

ResourceGroupPrepareStarted() public method

public ResourceGroupPrepareStarted ( string groupName, int resourceCount ) : void
groupName string
resourceCount int
return void

ResourceGroupScriptingEnded() public method

This event is fired when a resource group finished parsing scripts.
public ResourceGroupScriptingEnded ( string groupName ) : void
groupName string The name of the group
return void

ResourceGroupScriptingStarted() public method

This event is fired when a resource group begins parsing scripts.
public ResourceGroupScriptingStarted ( string groupName, int scriptCount ) : void
groupName string The name of the group
scriptCount int The number of scripts which will be parsed
return void

ResourceLoadEnded() public method

This event is fired when the resource has been loaded.
public ResourceLoadEnded ( ) : void
return void

ResourceLoadStarted() public method

This event is fired when a declared resource is about to be loaded.
public ResourceLoadStarted ( Axiom.Core.Resource resource ) : void
resource Axiom.Core.Resource Weak reference to the resource loaded
return void

ResourcePrepareEnded() public method

public ResourcePrepareEnded ( ) : void
return void

ResourcePrepareStarted() public method

public ResourcePrepareStarted ( Axiom.Core.Resource resource ) : void
resource Axiom.Core.Resource
return void

ScreenToScene() public static method

Converts a 2D screen coordinate (in pixels) to a 3D ray into the scene.
public static ScreenToScene ( Camera cam, Vector2 pt ) : Ray
cam Axiom.Core.Camera
pt Vector2
return Axiom.Math.Ray

ScriptParseEnded() public method

This event is fired when the script has been fully parsed.
public ScriptParseEnded ( string scriptName, bool skipped ) : void
scriptName string
skipped bool
return void

ScriptParseStarted() public method

This event is fired when a script is about to be parsed.
public ScriptParseStarted ( string scriptName, bool &skipThisScript ) : void
scriptName string Name of the to be parsed
skipThisScript bool
return void

SdkTrayManager() public method

Creates backdrop, cursor, and trays.
public SdkTrayManager ( String name, Axiom.Graphics.RenderWindow window, SharpInputSystem mouse ) : System
name String
window Axiom.Graphics.RenderWindow
mouse SharpInputSystem
return System

SdkTrayManager() public method

Creates backdrop, cursor, and trays.
public SdkTrayManager ( String name, Axiom.Graphics.RenderWindow window, SharpInputSystem mouse, ISdkTrayListener listener ) : System
name String
window Axiom.Graphics.RenderWindow
mouse SharpInputSystem
listener ISdkTrayListener
return System

SetTrayWidgetAlignment() public method

Sets horizontal alignment of a tray's contents.
public SetTrayWidgetAlignment ( TrayLocation trayLoc, HorizontalAlignment gha ) : void
trayLoc TrayLocation
gha HorizontalAlignment
return void

ShowAll() public method

public ShowAll ( ) : void
return void

ShowBackdrop() public method

Displays specified material on backdrop, or the last material used if

none specified. Good for pause menus like in the browser.
public ShowBackdrop ( ) : void
return void

ShowBackdrop() public method

Displays specified material on backdrop, or the last material used if

none specified. Good for pause menus like in the browser.
public ShowBackdrop ( String materialName ) : void
materialName String
return void

ShowCursor() public method

Displays specified material on cursor, or the last material used if

none specified. Used to change cursor type.
public ShowCursor ( ) : void
return void

ShowCursor() public method

Displays specified material on cursor, or the last material used if

none specified. Used to change cursor type.
public ShowCursor ( String materialName ) : void
materialName String
return void

ShowFrameStats() public method

Shows frame statistics widget set in the specified location.
public ShowFrameStats ( TrayLocation trayLoc ) : void
trayLoc TrayLocation
return void

ShowFrameStats() public method

Shows frame statistics widget set in the specified location.
public ShowFrameStats ( TrayLocation trayLoc, int place ) : void
trayLoc TrayLocation
place int
return void

ShowLoadingBar() public method

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.
public ShowLoadingBar ( ) : void
return void

ShowLoadingBar() public method

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.
public ShowLoadingBar ( int numGroupsInit, int numGroupsLoad ) : void
numGroupsInit int
numGroupsLoad int
return void

ShowLoadingBar() public method

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.
public ShowLoadingBar ( int numGroupsInit, int numGroupsLoad, Real initProportion ) : void
numGroupsInit int
numGroupsLoad int
initProportion Real
return void

ShowLogo() public method

Shows logo in the specified location.
public ShowLogo ( TrayLocation trayLoc ) : void
trayLoc TrayLocation
return void

ShowLogo() public method

Shows logo in the specified location.
public ShowLogo ( TrayLocation trayLoc, int place ) : void
trayLoc TrayLocation
place int
return void

ShowOkDialog() public method

Pops up a message dialog with an OK button.
public ShowOkDialog ( System.String caption, System.String message ) : void
caption System.String
message System.String
return void

ShowTrays() public method

public ShowTrays ( ) : void
return void

ShowYesNoDialog() public method

Pops up a question dialog with Yes and No buttons.
public ShowYesNoDialog ( System.String caption, System.String question ) : void
caption System.String
question System.String
return void

SliderMoved() public method

public SliderMoved ( Axiom.Samples.Slider slider ) : void
slider Axiom.Samples.Slider
return void

ToggleAdvancedFrameStats() public method

Toggles visibility of advanced statistics.
public ToggleAdvancedFrameStats ( ) : void
return void

WorldGeometryStageEnded() public method

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.
public WorldGeometryStageEnded ( ) : void
return void

WorldGeometryStageStarted() public method

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.
public WorldGeometryStageStarted ( string description ) : void
description string Text description of what was just loaded
return void

YesNoDialogClosed() public method

public YesNoDialogClosed ( string text, bool yesHit ) : void
text string
yesHit bool
return void

createLongSelectMenu() public method

public createLongSelectMenu ( TrayLocation trayLoc, String name, System.String caption, Real boxWidth, int maxItemsShown ) : SelectMenu
trayLoc TrayLocation
name String
caption System.String
boxWidth Real
maxItemsShown int
return SelectMenu

sceneToScreen() public static method

Converts a 3D scene position to a 2D screen coordinate (in pixels).
public static sceneToScreen ( Camera cam, Vector3 pt ) : Vector2
cam Axiom.Core.Camera
pt Vector3
return Vector2

Property Details

CursorWasVisible protected_oe property

protected bool CursorWasVisible
return bool

Dialog protected_oe property

protected TextBox,Axiom.Samples Dialog
return TextBox

LoadBar protected_oe property

protected ProgressBar,Axiom.Samples LoadBar
return Axiom.Samples.ProgressBar

Logo protected_oe property

protected DecorWidget,Axiom.Samples Logo
return DecorWidget

Mouse protected_oe property

protected Mouse,SharpInputSystem Mouse
return SharpInputSystem.Mouse

StatsPanel protected_oe property

protected ParamsPanel,Axiom.Samples StatsPanel
return ParamsPanel

backdrop protected_oe property

protected OverlayElementContainer,Axiom.Overlays backdrop
return Axiom.Overlays.OverlayElementContainer

backdropLayer protected_oe property

protected Overlay,Axiom.Overlays backdropLayer
return Axiom.Overlays.Overlay

cursor protected_oe property

protected OverlayElementContainer,Axiom.Overlays cursor
return Axiom.Overlays.OverlayElementContainer

cursorLayer protected_oe property

protected Overlay,Axiom.Overlays cursorLayer
return Axiom.Overlays.Overlay

expandedMenu protected_oe property

protected SelectMenu,Axiom.Samples expandedMenu
return SelectMenu

groupInitProportion protected_oe property

protected Real groupInitProportion
return Real

groupLoadProportion protected_oe property

protected Real groupLoadProportion
return Real

listener protected_oe property

protected ISdkTrayListener listener
return ISdkTrayListener

loadInc protected_oe property

protected Real loadInc
return Real

mDialogShade protected_oe property

protected OverlayElementContainer,Axiom.Overlays mDialogShade
return Axiom.Overlays.OverlayElementContainer

mFpsLabel protected_oe property

protected Label,Axiom.Samples mFpsLabel
return Label

mName protected_oe property

protected String mName
return String

mNo protected_oe property

protected Button,Axiom.Samples mNo
return Axiom.Samples.Button

mOk protected_oe property

protected Button,Axiom.Samples mOk
return Axiom.Samples.Button

mPriorityLayer protected_oe property

protected Overlay,Axiom.Overlays mPriorityLayer
return Axiom.Overlays.Overlay

mTrayDrag protected_oe property

protected bool mTrayDrag
return bool

mTrayPadding protected_oe property

protected Real mTrayPadding
return Real

mTrays protected_oe property

protected OverlayElementContainer[],Axiom.Overlays mTrays
return Axiom.Overlays.OverlayElementContainer[]

mTraysLayer protected_oe property

protected Overlay,Axiom.Overlays mTraysLayer
return Axiom.Overlays.Overlay

mWidgetDeathRow protected_oe property

protected System.Collections.Generic.List mWidgetDeathRow
return System.Collections.Generic.List

mWidgetPadding protected_oe property

protected Real mWidgetPadding
return Real

mWidgetSpacing protected_oe property

protected Real mWidgetSpacing
return Real

mWidgets protected_oe property

protected WidgetList[] mWidgets
return WidgetList[]

mWindow protected_oe property

protected RenderWindow,Axiom.Graphics mWindow
return Axiom.Graphics.RenderWindow

mYes protected_oe property

protected Button,Axiom.Samples mYes
return Axiom.Samples.Button

trayWidgetAlign protected_oe property

protected HorizontalAlignment[] trayWidgetAlign
return HorizontalAlignment[]