VR-Forces Development_Version Class Documentation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
List of all members | Public Types | Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes
makVrf::DtDebugLineDriver Class Reference

This driver owns a DtExampleDrawObject, and is responsible for keeping track of the draw object's state & creating or destroying it when the driver is started or stopped. More...

Inheritance diagram for makVrf::DtDebugLineDriver:
Inheritance graph
[legend]

Public Types

typedef
DtDebugDrawerLinesModel::BufferVector 
BufferVector

Public Member Functions

 DtDebugLineDriver (makVrv::DtAgentManager &agentManager, const std::string &instanceName)
 CTOR.
virtual ~DtDebugLineDriver ()
 DTOR.
virtual const std::string & className () const
 Get the class name as a string.
virtual void toggleDrawDebugLines ()
 Toggle drawing of debug lines via the F_11 key.
virtual void setDrawDebugLines (bool enabled)
 Enable/disable drawing of debug lines.
virtual BufferVector bufferInfo ()
virtual bool drawBuffer (std::string name, bool draw)
- Public Member Functions inherited from makVrv::DtDriver
 DtDriver (DtAgentManager &agentManager, const std::string &instanceName)
 CTOR.
virtual ~DtDriver ()
 DTOR.
virtual void realizeConfiguration (const DtConfiguration &configuration)
 Realize the driver using the configuration.
virtual DtConfiguration createConfiguration () const
 Create a configuration for the driver.
DtAgentManageragentManager ()
 Get the master scene for this host.
virtual DtAgentManagerInterfacesceneInterface ()
 Get the scene manager interface for creating agents.
bool started () const
 Get this driver's active state.
virtual const std::string & instanceName () const
 Get this driver's instance name.
virtual bool autoStart () const
 Get whether this driver is set to automatically start if it is persistent.
virtual void setAutoStart (bool autoStart)
 Set whether this driver automatically starts if it is persistent.
virtual bool isWindowDependent () const
 Get whether this driver is set to automatically start when the first window is created and stop when the last window is destroyed.
virtual void setIsWindowDependent (bool dep)
 Set whether this driver is set to automatically start when the first window is created and stop when the last window is destroyed.
virtual void setIsUserControllable (bool)
 Set whether this driver can be started and stopped by the user.
virtual bool isUserControllable () const
 Get whether this driver can be started and stopped by the user.
virtual void setIsPersistent (bool per)
 Set if the driver is persistent and should be saved between runs.
virtual bool isPersistent () const
 Get if the driver is persistent and should be saved between runs.
virtual bool isOnDriverSelectionList () const
 Returns whether or not this driver is to be automatically started/stopped from the driver selection list.
virtual void setOnDriverSelectionList (bool)
 Sets whether or not this item is on the driver selection list.
bool objectFromAgentManager (const DtUniqueID &id) const
 check to see if the object was created using this driver's agent manager.

Protected Types

typedef DtMutex Mutex
typedef DtScopedLock ScopedLock

Protected Member Functions

virtual bool onStart ()
 Called when the driver is started by the display engine Calls init.
virtual bool onTick ()
 calls to our drawer to draw the debug lines
virtual bool onStop ()
 Called when the driver is stopped by the display engine Calls exit.
- Protected Member Functions inherited from makVrv::DtDriver
void applyChangesAndDelete (DtElementChanges *changes)
 Function for apply changes from a changes object and deleting it.
void reportElementCreated (DtElementID id, DtElementID parentId, DtElementEntry::ElementType type)
 Report an element created.
void reportElementAttribute (DtElementID id, DtElementAttribute *attribute)
 Report an element attribute changed.
void reportElementDestroyed (DtElementID id)
 Report an element destroyed.
void start ()
 Start the driver.
void stop ()
 Stop the driver.
bool tick ()
 Tick the host driver.
virtual void slot_displayEngineAdded (const DtDeRecord &igRecord)
 Called when a display engine is added.
virtual void setInstanceName (const std::string &name)
 set the Instance name.
virtual void installAccessories ()
 Installs accessories on this driver.
virtual void uninstallAccessories ()
 Removes accessories from this driver.

Protected Attributes

DtMutex myMutex
std::string myName
std::auto_ptr
< DtDebugDrawerLinesModelAgent > 
myLineDrawer
- Protected Attributes inherited from makVrv::DtDriver
DtAgentManagermyAgentManager
bool myStartedFlag
std::string myName
DtConfiguration myConfiguration
bool myPersistentFlag
bool myUserControllableFlag
bool myRequestStateDiffPendingFlag
DtElementChanges myChanges

Detailed Description

This driver owns a DtExampleDrawObject, and is responsible for keeping track of the draw object's state & creating or destroying it when the driver is started or stopped.

Member Typedef Documentation

typedef DtMutex makVrf::DtDebugLineDriver::Mutex
protected
typedef DtScopedLock makVrf::DtDebugLineDriver::ScopedLock
protected

Constructor & Destructor Documentation

makVrf::DtDebugLineDriver::DtDebugLineDriver ( makVrv::DtAgentManager agentManager,
const std::string &  instanceName 
)

CTOR.

virtual makVrf::DtDebugLineDriver::~DtDebugLineDriver ( )
virtual

DTOR.

Member Function Documentation

virtual const std::string& makVrf::DtDebugLineDriver::className ( ) const
virtual

Get the class name as a string.

Implements makVrv::DtDriver.

virtual void makVrf::DtDebugLineDriver::toggleDrawDebugLines ( )
virtual

Toggle drawing of debug lines via the F_11 key.

virtual void makVrf::DtDebugLineDriver::setDrawDebugLines ( bool  enabled)
virtual

Enable/disable drawing of debug lines.

virtual BufferVector makVrf::DtDebugLineDriver::bufferInfo ( )
virtual
virtual bool makVrf::DtDebugLineDriver::drawBuffer ( std::string  name,
bool  draw 
)
virtual
virtual bool makVrf::DtDebugLineDriver::onStart ( )
protectedvirtual

Called when the driver is started by the display engine Calls init.

Implements makVrv::DtDriver.

virtual bool makVrf::DtDebugLineDriver::onTick ( )
protectedvirtual

calls to our drawer to draw the debug lines

Implements makVrv::DtDriver.

virtual bool makVrf::DtDebugLineDriver::onStop ( )
protectedvirtual

Called when the driver is stopped by the display engine Calls exit.

Implements makVrv::DtDriver.

Member Data Documentation

DtMutex makVrf::DtDebugLineDriver::myMutex
mutableprotected
std::string makVrf::DtDebugLineDriver::myName
protected
std::auto_ptr<DtDebugDrawerLinesModelAgent> makVrf::DtDebugLineDriver::myLineDrawer
protected

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

Document ID: Generated on Tue Mar 8 22:13:38 EST 2016 from SVN revision 162938
Copyright © 2005-2015 VT MÄK. All Rights Reserved (www.mak.com)