• Home
• Axiom
• Samples
• SampleContext

C# Class Axiom.Samples.SampleContext

Show file Open project: WolfgangSt/axiom

Protected Properties

Property	Type	Description
ConfigurationManager	IConfigurationManager
InputManager	SharpInputSystem.InputManager
IsLastRun	bool
IsSamplePaused	bool
Keyboard	SharpInputSystem.Keyboard
LastSample	Sample
LastSampleState	NameValuePairList
Mouse	SharpInputSystem.Mouse
NextRenderer	String
Root	Axiom.Core.Root

Public Methods

Method	Description
Dispose ( ) : void
FrameEnded ( object sender, FrameEventArgs evt ) : void	Processes frame ended events.
FrameRenderingQueued ( object sender, FrameEventArgs evt ) : void	Processes rendering queued events.
FrameStarted ( object sender, FrameEventArgs evt ) : void	Processes frame started events.
Go ( ) : void	This function encapsulates the entire lifetime of the context.
Go ( Sample initialSample ) : void	This function encapsulates the entire lifetime of the context.
KeyPressed ( SharpInputSystem evt ) : bool
KeyReleased ( SharpInputSystem evt ) : bool
MouseMoved ( SharpInputSystem evt ) : bool
MousePressed ( SharpInputSystem evt, SharpInputSystem id ) : bool
MouseReleased ( SharpInputSystem evt, SharpInputSystem id ) : bool
PauseCurrentSample ( ) : void	Pauses the current running sample
RunSample ( Sample s ) : void	Quits the current sample and starts a new one.
SampleContext ( IConfigurationManager cfgManager ) : System	Creates a new instance of the type SampleContext
UnpauseCurrentSample ( ) : void	Unpauses the current sample
WindowClosed ( Axiom.Graphics.RenderWindow rw ) : void
WindowClosing ( Axiom.Graphics.RenderWindow rw ) : bool
WindowFocusChange ( Axiom.Graphics.RenderWindow rw ) : void
WindowMoved ( Axiom.Graphics.RenderWindow rw ) : void
WindowResized ( Axiom.Graphics.RenderWindow rw ) : void	Processes window size change event. Adjusts mouse's region to match that of the window. You could also override this method to prevent resizing.

Protected Methods

Method	Description
CaptureInputDevices ( ) : void	Captures input device states.
CreateInputDevices ( ) : void	Creates the individual input devices. I only create a keyboard and mouse here because they are the most common, but you can override this method for other modes and devices.
CreateRoot ( ) : void	Creates the Axiom root.
CreateWindow ( ) : void	Creates the render window to be used for this context. I use an auto-created window here, but you can also create an external window if you wish. Just don't forget to initialize the root.
LoadResources ( ) : void	Loads context-wide resource groups. I chose here to simply initialise all groups, but you can fully load specific ones if you wish.
LocateResources ( ) : void	Finds context-wide resource groups. I load paths from a config file here, but you can choose your resource locations however you want.
Log ( string msg ) : void	Logs a message to the default logfile.
OneTimeConfig ( ) : bool	Configures the startup settings for Axiom. It will first load the settings from a configuration file, then open a dialog for any further configuration.
Reconfigure ( String renderer, NameValuePairList options ) : void	Reconfigures the context. Attempts to preserve the current sample state.
RecoverLastSample ( ) : void	Recovers the last sample after a reset. You can override in the case that the last sample is destroyed in the process of resetting, and you have to recover it through another means.
Setup ( ) : void	Sets up the context after configuration.
SetupInput ( ) : void	Sets up SIS input.
Shutdown ( ) : void	Cleans up and shuts down the context.
ShutdownInput ( ) : void	Destroys SIS input devices and the input manager.

Method Details

Property Details