OmegaEngine API  1.0.3
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties Events
Public Member Functions | Protected Member Functions | Properties | List of all members
OmegaEngine.RenderPanel Class Reference

A Panel that automatically provides an OmegaEngine.Engine instance for rendering on it, an optional timer-driver render loop, input handling, etc. More...

Inheritance diagram for OmegaEngine.RenderPanel:
NanoByte::Common::Controls::TouchPanel NanoByte::Common::Controls::ITouchControl

Public Member Functions

Engine Setup ()
 Initializes the OmegaEngine.Engine for rendering on this Panel. More...
 
void AddInputReceiver (IInputReceiver receiver)
 Calls InputProvider.AddReceiver for all default InputProviders. More...
 
void RemoveInputReceiver (IInputReceiver receiver)
 Calls InputProvider.RemoveReceiver for all default InputProviders. More...
 

Protected Member Functions

override void OnPaint (PaintEventArgs e)
 
override void OnResize (EventArgs eventargs)
 
override void Dispose (bool disposing)
 

Properties

Engine Engine [get, set]
 The OmegaEngine.Engine used to render graphics onto this panel. More...
 
KeyboardInputProvider KeyboardInputProvider [get, set]
 A default Input.KeyboardInputProvider hooked up to the Panel. More...
 
MouseInputProvider MouseInputProvider [get, set]
 A default Input.MouseInputProvider hooked up to the Panel. More...
 
TouchInputProvider TouchInputProvider [get, set]
 A default Input.TouchInputProvider hooked up to the Panel. More...
 
bool AutoRender [get, set]
 When set to true OmegaEngine.Engine.Render() is automatically called in regular intervals. More...
 
int AutoRenderInterval [get, set]
 The interval in milliseconds in which OmegaEngine.Engine.Render() is automatically called. More...
 

Additional Inherited Members

- Events inherited from NanoByte::Common::Controls::TouchPanel
EventHandler< TouchEventArgsTouchDown
 
EventHandler< TouchEventArgsTouchUp
 
EventHandler< TouchEventArgsTouchMove
 
- Events inherited from NanoByte::Common::Controls::ITouchControl
EventHandler< TouchEventArgsTouchDown
 
EventHandler< TouchEventArgsTouchUp
 
EventHandler< TouchEventArgsTouchMove
 

Detailed Description

A Panel that automatically provides an OmegaEngine.Engine instance for rendering on it, an optional timer-driver render loop, input handling, etc.

Member Function Documentation

void OmegaEngine.RenderPanel.AddInputReceiver ( IInputReceiver  receiver)
inline

Calls InputProvider.AddReceiver for all default InputProviders.

Parameters
receiverThe object to receive the commands.
void OmegaEngine.RenderPanel.RemoveInputReceiver ( IInputReceiver  receiver)
inline

Calls InputProvider.RemoveReceiver for all default InputProviders.

Parameters
receiverThe object to no longer receive the commands.
Engine OmegaEngine.RenderPanel.Setup ( )
inline

Initializes the OmegaEngine.Engine for rendering on this Panel.

Returns
The newly initialized Engine.
Exceptions
NotSupportedExceptionThe graphics card does not meet the engine's minimum requirements.
Direct3D9NotFoundExceptionThrow if required DirectX version is missing.
Direct3DX9NotFoundExceptionThrow if required DirectX version is missing.
Direct3D9Exceptioninternal errors occurred while intiliazing the graphics card.
SlimDX.DirectSound.DirectSoundExceptioninternal errors occurred while intiliazing the sound card.

Calling this multiple times will always return the same OmegaEngine.Engine instance.

Property Documentation

bool OmegaEngine.RenderPanel.AutoRender
getset

When set to true OmegaEngine.Engine.Render() is automatically called in regular intervals.

See Also
AutoRenderInterval
int OmegaEngine.RenderPanel.AutoRenderInterval
getset

The interval in milliseconds in which OmegaEngine.Engine.Render() is automatically called.

See Also
AutoRender
Engine OmegaEngine.RenderPanel.Engine
getset

The OmegaEngine.Engine used to render graphics onto this panel.

KeyboardInputProvider OmegaEngine.RenderPanel.KeyboardInputProvider
getset

A default Input.KeyboardInputProvider hooked up to the Panel.

MouseInputProvider OmegaEngine.RenderPanel.MouseInputProvider
getset

A default Input.MouseInputProvider hooked up to the Panel.

TouchInputProvider OmegaEngine.RenderPanel.TouchInputProvider
getset

A default Input.TouchInputProvider hooked up to the Panel.


The documentation for this class was generated from the following file: