VR-Forces 4.1 Class Documentation
List of all members | Public Member Functions | Public Attributes | Protected Attributes
makVrv::DtRenderer Class Reference

The DtRenderer is the component responsible for rendering 3D images onto the screen. More...

Inheritance diagram for makVrv::DtRenderer:
Inheritance graph
[legend]

Public Member Functions

 DtRenderer (DtDe &de)
 CTOR.
virtual ~DtRenderer ()
 DTOR.
virtual void update ()
 Abstract update.
virtual void postUpdate ()
 Called after tick; time to update observers.
DtObserverObjectManagerobserverObjectManager ()
 Get the observer object manager.
DtTickableManagerInterfacetickableManager ()
 Get the scene manager's attachable scene object manager.
const DtTickableManagerInterfacetickableManager () const
DtOverlayManageroverlayManager ()
 Get the manager's over the 2D overlays.
const DtOverlayManageroverlayManager () const
virtual bool exportTerrainAndProps (const std::string &)=0
 Saves terrain geometry and props to specified file.
virtual void render ()=0
 Abstract render.
virtual void resetSceneGraph ()=0
 Removes all nodes from the scene graph.
virtual void setWireframeRendering (bool enabled)=0
 Turn wireframe mode on/off.
virtual bool wireframeRendering () const =0
 Get status of wireframe mode.
virtual void setShadowState (bool enabled, int quality, bool entity, bool props, bool terrain)=0
 Set the shadow mode and settings.
virtual bool shadowsEnabled () const =0
 Get status of shadow mode.
virtual int shadowQuality () const =0
 Get quality of shadow rendering.
virtual bool entityShadowsEnabled () const =0
 Get entity shadow mode.
virtual bool propShadowsEnabled () const =0
 Get prop shadow mode.
virtual bool terrainShadowsEnabled () const =0
 Get terrain shadow mode.
virtual void releaseResources ()=0
 Release all openGL objects in the scene graph.
virtual bool makeContextCurrent ()=0
 Attempt to make a context current.
void createManagers ()
 Create overlay manager, must be called after creating the renderer as the manager may expect a specific subclasses of renderer.

Public Attributes

boost::signal< void(double
simTime)> 
signal_update
 Signal used to update systems.
boost::signal< void(double
simTime)> 
signal_postUpdate
 Signal used to update systems.
boost::signal< void()> signal_releaseResources
 Signal used to update systems.

Protected Attributes

DtDemyDe
DtObserverObjectManagermyObserverObjectManager
DtTickableManagerInterfacemyTickableManager
DtOverlayManagermyOverlayManager

Detailed Description

The DtRenderer is the component responsible for rendering 3D images onto the screen.

The component responsible for drawing 3D images onto a screen is the DtRenderer. Each display engine owns one. The DtRenderer provides an interface for updating the scene graph and rendering the scene. Its update() and render() functions are called each display engine tick.

The core VR-Vantage Toolkit framework abstracts away from the underlying rendering implementation. This separation ensures that the rendering-independent code remains independent of OSG, while the rendering code exists in the libraries that depend on OSG. (VR-Vantage can support alternate rendering solutions.)

Constructor & Destructor Documentation

makVrv::DtRenderer::DtRenderer ( DtDe de)

CTOR.

virtual makVrv::DtRenderer::~DtRenderer ( )
virtual

DTOR.

Member Function Documentation

virtual void makVrv::DtRenderer::update ( )
virtual

Abstract update.

Reimplemented in makVrv::DtOsgRenderer.

virtual void makVrv::DtRenderer::postUpdate ( )
virtual

Called after tick; time to update observers.

DtObserverObjectManager* makVrv::DtRenderer::observerObjectManager ( )

Get the observer object manager.

DtTickableManagerInterface& makVrv::DtRenderer::tickableManager ( )

Get the scene manager's attachable scene object manager.

const DtTickableManagerInterface& makVrv::DtRenderer::tickableManager ( ) const
DtOverlayManager& makVrv::DtRenderer::overlayManager ( )

Get the manager's over the 2D overlays.

const DtOverlayManager& makVrv::DtRenderer::overlayManager ( ) const
virtual bool makVrv::DtRenderer::exportTerrainAndProps ( const std::string &  )
pure virtual

Saves terrain geometry and props to specified file.

This file will be saved in the format specified by the file extension. Currently only the .gdb extension is supported

Implemented in makVrv::DtOsgRenderer.

virtual void makVrv::DtRenderer::render ( )
pure virtual

Abstract render.

Implemented in makVrv::DtOsgRenderer.

virtual void makVrv::DtRenderer::resetSceneGraph ( )
pure virtual

Removes all nodes from the scene graph.

Implemented in makVrv::DtOsgRenderer.

virtual void makVrv::DtRenderer::setWireframeRendering ( bool  enabled)
pure virtual

Turn wireframe mode on/off.

Implemented in makVrv::DtOsgRenderer.

virtual bool makVrv::DtRenderer::wireframeRendering ( ) const
pure virtual

Get status of wireframe mode.

Implemented in makVrv::DtOsgRenderer.

virtual void makVrv::DtRenderer::setShadowState ( bool  enabled,
int  quality,
bool  entity,
bool  props,
bool  terrain 
)
pure virtual

Set the shadow mode and settings.

Implemented in makVrv::DtOsgRenderer.

virtual bool makVrv::DtRenderer::shadowsEnabled ( ) const
pure virtual

Get status of shadow mode.

Implemented in makVrv::DtOsgRenderer.

virtual int makVrv::DtRenderer::shadowQuality ( ) const
pure virtual

Get quality of shadow rendering.

Implemented in makVrv::DtOsgRenderer.

virtual bool makVrv::DtRenderer::entityShadowsEnabled ( ) const
pure virtual

Get entity shadow mode.

Implemented in makVrv::DtOsgRenderer.

virtual bool makVrv::DtRenderer::propShadowsEnabled ( ) const
pure virtual

Get prop shadow mode.

Implemented in makVrv::DtOsgRenderer.

virtual bool makVrv::DtRenderer::terrainShadowsEnabled ( ) const
pure virtual

Get terrain shadow mode.

Implemented in makVrv::DtOsgRenderer.

virtual void makVrv::DtRenderer::releaseResources ( )
pure virtual

Release all openGL objects in the scene graph.

Implemented in makVrv::DtOsgRenderer.

virtual bool makVrv::DtRenderer::makeContextCurrent ( )
pure virtual

Attempt to make a context current.

Returns
true if a context was made current.

Implemented in makVrv::DtOsgRenderer.

void makVrv::DtRenderer::createManagers ( )

Create overlay manager, must be called after creating the renderer as the manager may expect a specific subclasses of renderer.

Member Data Documentation

boost::signal<void (double simTime)> makVrv::DtRenderer::signal_update

Signal used to update systems.

Connect functions to this signal that need to be called once per tick in the update phase.

boost::signal<void (double simTime)> makVrv::DtRenderer::signal_postUpdate

Signal used to update systems.

Connect functions to this signal that need to be called once per tick in the post update phase.

boost::signal<void ()> makVrv::DtRenderer::signal_releaseResources

Signal used to update systems.

Connect functions to this signal that need to be called once per tick in the post update phase.

DtDe& makVrv::DtRenderer::myDe
protected
DtObserverObjectManager* makVrv::DtRenderer::myObserverObjectManager
protected
DtTickableManagerInterface* makVrv::DtRenderer::myTickableManager
protected
DtOverlayManager* makVrv::DtRenderer::myOverlayManager
protected

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

Document ID: Generated on Tue Jan 29 18:21:16 EST 2013 from SVN revision 123193
Copyright © 2005-2013 VT MÄK Inc. All Rights Reserved (www.mak.com)