Uses the Engine to present an IUniverse game world. More...
Inheritance diagram for AlphaFramework.Presentation.PresenterBase< TUniverse, TCoordinates >:
Public Member Functions | |
| virtual void | Initialize () |
| Generate Terrain and Renderables from UniverseBase<TCoordinates>.Positionables and keeps everything in sync using events More... | |
| virtual void | HookIn () |
| Hooks the View into OmegaEngine.Engine.Views More... | |
| virtual void | HookOut () |
| Hooks the View out of OmegaEngine.Engine.Views More... | |
| virtual void | DimDown () |
| Dims in the screen down. More... | |
| virtual void | DimUp () |
| Dims in the screen back up. More... | |
| void | Dispose () |
| Removes the Universe hooks setup by Initialize and disposes all created Views, Scenes, PositionableRenderables, etc. More... | |
Protected Member Functions | |
| PresenterBase (Engine engine, TUniverse universe) | |
| Creates a new presenter. More... | |
| virtual void | RegisterRenderablesSync () |
| Hook to configure RenderablesSync and LightsSync. More... | |
| virtual void | Dispose (bool disposing) |
| To be called by IDisposable.Dispose and the object destructor. More... | |
Protected Attributes | |
| readonly ModelViewSync< Positionable< TCoordinates >, PositionableRenderable > | RenderablesSync |
| Maps between UniverseBase<TCoordinates>.Positionables and OmegaEngine.Graphics.Scene.Positionables. More... | |
| readonly ModelViewSync< Positionable< TCoordinates >, LightSource > | LightsSync |
| Maps between UniverseBase<TCoordinates>.Positionables and OmegaEngine.Graphics.Scene.Lights. More... | |
| readonly Engine | Engine |
| The Engine reference to use for rendering operations More... | |
| readonly Scene | Scene |
| The engine scene containing the graphical representations of Positionable<TCoordinates>s More... | |
Properties | |
| View | View [get, protected set] |
| The engine view used to display the Scene More... | |
| TUniverse | Universe [get] |
| The game world to present. More... | |
| bool | Initialized [get, protected set] |
| Was Initialize already called? More... | |
| bool | Disposed [get] |
| Was this presenter already disposed? More... | |
Detailed Description
Uses the Engine to present an IUniverse game world.
- Template Parameters
-
TUniverse The type of IUniverse to present. TCoordinates Data type for storing position coordinates of objects in the game world.
- Type Constraints
-
TUniverse : UniverseBase<TCoordinates> TCoordinates : struct
Constructor & Destructor Documentation
◆ PresenterBase()
|
inlineprotected |
Creates a new presenter.
- Parameters
-
engine The engine to use for rendering. universe The game world to present.
Member Function Documentation
◆ DimDown()
|
inlinevirtual |
Dims in the screen down.
◆ DimUp()
|
inlinevirtual |
Dims in the screen back up.
◆ Dispose() [1/2]
|
inline |
Removes the Universe hooks setup by Initialize and disposes all created Views, Scenes, PositionableRenderables, etc.
◆ Dispose() [2/2]
|
inlineprotectedvirtual |
To be called by IDisposable.Dispose and the object destructor.
- Parameters
-
disposing trueif called manually and not by the garbage collector.
◆ HookIn()
|
inlinevirtual |
Hooks the View into OmegaEngine.Engine.Views
Will internally call Initialize first, if you didn't
◆ HookOut()
|
inlinevirtual |
Hooks the View out of OmegaEngine.Engine.Views
◆ Initialize()
|
inlinevirtual |
Generate Terrain and Renderables from UniverseBase<TCoordinates>.Positionables and keeps everything in sync using events
- Exceptions
-
FileNotFoundException A required Asset file could not be found. IOException There was an error reading an Asset file. InvalidDataException An Asset file contains invalid data.
Should be called before HookIn is used
◆ RegisterRenderablesSync()
|
inlineprotectedvirtual |
Hook to configure RenderablesSync and LightsSync.
Member Data Documentation
◆ Engine
|
protected |
The Engine reference to use for rendering operations
◆ LightsSync
|
protected |
Maps between UniverseBase<TCoordinates>.Positionables and OmegaEngine.Graphics.Scene.Lights.
◆ RenderablesSync
|
protected |
Maps between UniverseBase<TCoordinates>.Positionables and OmegaEngine.Graphics.Scene.Positionables.
◆ Scene
|
protected |
The engine scene containing the graphical representations of Positionable<TCoordinates>s
Property Documentation
◆ Disposed
|
get |
Was this presenter already disposed?
◆ Initialized
|
getprotected set |
Was Initialize already called?
◆ Universe
|
get |
The game world to present.
◆ View
|
getprotected set |
The engine view used to display the Scene
The documentation for this class was generated from the following file:
- Presentation/PresenterBase.cs
