C# Class Axiom.Samples.SdkSample

Base SDK sample class. Includes default player camera and SDK trays.

Inheritance: Sample

Protected Properties

Property	Type	Description
Camera	Axiom.Core.Camera
CameraManager	SdkCameraManager
CursorWasVisible	bool
DetailsPanel	ParamsPanel
TrayManager	SdkTrayManager
Viewport	Axiom.Core.Viewport

Public Methods

Method	Description
FrameRenderingQueued ( FrameEventArgs evt ) : bool
KeyPressed ( SharpInputSystem evt ) : bool
KeyReleased ( SharpInputSystem evt ) : bool
MouseMoved ( SharpInputSystem evt ) : bool	IMPORTANT: When overriding this handler, remember to allow the tray manager to filter out any interface-related mouse events before processing them in your scene. If the tray manager handler returns true, the event was meant for the trays, not you.
MousePressed ( SharpInputSystem evt, SharpInputSystem id ) : bool	IMPORTANT: When overriding this handler, remember to allow the tray manager to filter out any interface-related mouse events before processing them in your scene. If the tray manager handler returns true, the event was meant for the trays, not you.
MouseReleased ( SharpInputSystem evt, SharpInputSystem id ) : bool	IMPORTANT: When overriding this handler, remember to allow the tray manager to filter out any interface-related mouse events before processing them in your scene. If the tray manager handler returns true, the event was meant for the trays, not you.
RestoreState ( NameValuePairList state ) : void	Automatically restores position and orientation for free-look cameras.
SaveState ( NameValuePairList state ) : void	Automatically saves position and orientation for free-look cameras.
SdkSample ( ) : System
Shutdown ( ) : void
Unpaused ( ) : void	Manually update the cursor position after being unpaused.
WindowResized ( Axiom.Graphics.RenderWindow rw ) : void

Protected Methods

Method	Description
Setup ( Axiom.Graphics.RenderWindow window, SharpInputSystem keyboard, SharpInputSystem mouse ) : void	Extendeded to setup a default tray interface and camera controller.
SetupView ( ) : void

Method Details

FrameRenderingQueued() public method

public FrameRenderingQueued ( FrameEventArgs evt ) : bool
evt	FrameEventArgs
return	bool

KeyPressed() public method

public KeyPressed ( SharpInputSystem evt ) : bool
evt	SharpInputSystem
return	bool

KeyReleased() public method

public KeyReleased ( SharpInputSystem evt ) : bool
evt	SharpInputSystem
return	bool

MouseMoved() public method

IMPORTANT: When overriding this handler, remember to allow the tray manager to filter out any interface-related mouse events before processing them in your scene. If the tray manager handler returns true, the event was meant for the trays, not you.

public MouseMoved ( SharpInputSystem evt ) : bool
evt	SharpInputSystem
return	bool

MousePressed() public method

public MousePressed ( SharpInputSystem evt, SharpInputSystem id ) : bool
evt	SharpInputSystem
id	SharpInputSystem
return	bool

MouseReleased() public method

public MouseReleased ( SharpInputSystem evt, SharpInputSystem id ) : bool
evt	SharpInputSystem
id	SharpInputSystem
return	bool

RestoreState() public method

Automatically restores position and orientation for free-look cameras.

public RestoreState ( NameValuePairList state ) : void
state	NameValuePairList
return	void

SaveState() public method

Automatically saves position and orientation for free-look cameras.

public SaveState ( NameValuePairList state ) : void
state	NameValuePairList
return	void

SdkSample() public method

public SdkSample ( ) : System
return	System

Setup() protected method

Extendeded to setup a default tray interface and camera controller.

protected Setup ( Axiom.Graphics.RenderWindow window, SharpInputSystem keyboard, SharpInputSystem mouse ) : void
window	Axiom.Graphics.RenderWindow
keyboard	SharpInputSystem
mouse	SharpInputSystem
return	void

SetupView() protected method

protected SetupView ( ) : void
return	void

Shutdown() public method

public Shutdown ( ) : void
return	void

Unpaused() public method

Manually update the cursor position after being unpaused.

public Unpaused ( ) : void
return	void

WindowResized() public method

public WindowResized ( Axiom.Graphics.RenderWindow rw ) : void
rw	Axiom.Graphics.RenderWindow
return	void

Property Details

Camera protected_oe property

Main Camera

protected Camera,Axiom.Core Camera
return	Axiom.Core.Camera

CameraManager protected_oe property

Basic Camera Manager

protected SdkCameraManager,Axiom.Samples CameraManager
return	SdkCameraManager

CursorWasVisible protected_oe property

Was the cursor visible before dialog appeared

protected bool CursorWasVisible
return	bool

DetailsPanel protected_oe property

Simple Details Panel

protected ParamsPanel,Axiom.Samples DetailsPanel
return	ParamsPanel

TrayManager protected_oe property

Tray Interface Manager

protected SdkTrayManager,Axiom.Samples TrayManager
return	SdkTrayManager

Viewport protected_oe property

Main Viewport

protected Viewport,Axiom.Core Viewport
return	Axiom.Core.Viewport