VR-Vantage 3.0.3 API Documentation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | Public Member Functions | Protected Member Functions | Protected Attributes
DtDistributedDrawDriver Class Reference
Inheritance diagram for DtDistributedDrawDriver:
Inheritance graph
[legend]

Public Member Functions

 DtDistributedDrawDriver (DtAgentManager &agentManager, const std::string &instanceName)
 CTOR. More...
 
virtual ~DtDistributedDrawDriver ()
 Virtual DTOR. More...
 
virtual const std::string & className () const
 Get the class name as a string. More...
 
virtual void drawRandomSphere ()
 Randomly place a sphere in the scene or move the sphere to a new random location if it's already been added. More...
 
- Public Member Functions inherited from makVrv::DtDriver
 DtDriver (DtAgentManager &agentManager, const std::string &instanceName)
 CTOR. More...
 
virtual ~DtDriver ()
 DTOR. More...
 
virtual void realizeConfiguration (const DtConfiguration &configuration)
 Realize the driver using the configuration. More...
 
virtual DtConfiguration createConfiguration () const
 Create a configuration for the driver. More...
 
DtAgentManageragentManager ()
 Get the master scene for this host. More...
 
virtual DtAgentManagerInterfacesceneInterface ()
 Get the scene manager interface for creating agents. More...
 
bool started () const
 Get this driver's active state. More...
 
virtual const std::string & instanceName () const
 Get this driver's instance name. More...
 
virtual bool autoStart () const
 Get whether this driver is set to automatically start if it is persistent. More...
 
virtual void setAutoStart (bool autoStart)
 Set whether this driver automatically starts if it is persistent. More...
 
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. More...
 
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. More...
 
virtual void setIsUserControllable (bool)
 Set whether this driver can be started and stopped by the user. More...
 
virtual bool isUserControllable () const
 Get whether this driver can be started and stopped by the user. More...
 
virtual void setIsPersistent (bool per)
 Set if the driver is persistent and should be saved between runs. More...
 
virtual bool isPersistent () const
 Get if the driver is persistent and should be saved between runs. More...
 
virtual bool isOnDriverSelectionList () const
 Returns whether or not this driver is to be automatically started/stopped from the driver selection list. More...
 
virtual void setOnDriverSelectionList (bool)
 Sets whether or not this item is on the driver selection list. More...
 
bool objectFromAgentManager (const DtUniqueID &id) const
 check to see if the object was created using this driver's agent manager. More...
 

Protected Member Functions

virtual bool onStart ()
 When late-joining display engines are connected to the master display engine, all drivers are stopped and restarted. More...
 
virtual bool onStop ()
 Called when the driver is stopped by the display engine. More...
 
virtual void slot_displayEngineAdded (const DtDeRecord &igRecord)
 Called when a display engine is connected; restarts the driver. More...
 
virtual bool onTick ()
 Stub implementation since this driver doesn't have anything that needs updating. More...
 
virtual void updateSphere ()
 Utility function add a sphere at location x,y,z in the scene. More...
 
- Protected Member Functions inherited from makVrv::DtDriver
void applyChangesAndDelete (DtElementChanges *changes)
 Function for apply changes from a changes object and deleting it. More...
 
void reportElementCreated (DtElementID id, DtElementID parentId, DtElementEntry::ElementType type)
 Report an element created. More...
 
void reportElementAttribute (DtElementID id, DtElementAttribute *attribute)
 Report an element attribute changed. More...
 
void reportElementDestroyed (DtElementID id)
 Report an element destroyed. More...
 
void start ()
 Start the driver. More...
 
void stop ()
 Stop the driver. More...
 
bool tick ()
 Tick the host driver. More...
 
virtual void setInstanceName (const std::string &name)
 set the Instance name. More...
 
virtual void installAccessories ()
 Installs accessories on this driver. More...
 
virtual void uninstallAccessories ()
 Removes accessories from this driver. More...
 

Protected Attributes

DtExampleDrawObjectAgent * myDrawAgent
 The draw agent that draws the sphere. More...
 
double mySphereX
 Saved location of the sphere. More...
 
double mySphereY
 
double mySphereZ
 
bool mySphereInScene
 Whether or not a sphere is displayed. More...
 
- Protected Attributes inherited from makVrv::DtDriver
DtAgentManagermyAgentManager
 
bool myStartedFlag
 
std::string myName
 
DtConfiguration myConfiguration
 
bool myPersistentFlag
 
bool myUserControllableFlag
 
bool myRequestStateDiffPendingFlag
 
DtElementChanges myChanges
 

Constructor & Destructor Documentation

DtDistributedDrawDriver::DtDistributedDrawDriver ( DtAgentManager agentManager,
const std::string &  instanceName 
)

CTOR.

virtual DtDistributedDrawDriver::~DtDistributedDrawDriver ( )
virtual

Virtual DTOR.

Member Function Documentation

virtual const std::string& DtDistributedDrawDriver::className ( ) const
virtual

Get the class name as a string.

Implements makVrv::DtDriver.

virtual void DtDistributedDrawDriver::drawRandomSphere ( )
virtual

Randomly place a sphere in the scene or move the sphere to a new random location if it's already been added.

virtual bool DtDistributedDrawDriver::onStart ( )
protectedvirtual

When late-joining display engines are connected to the master display engine, all drivers are stopped and restarted.

The onStop() and onStart() implementations for this driver will save the sphere's state when the driver is stopped, and recreate it when the driver is started. It is critical to implement these methods correctly to make late-joining display engines work correctly. Called when the driver is started by the display engine Restores state that existed the last time the driver was stopped

Implements makVrv::DtDriver.

virtual bool DtDistributedDrawDriver::onStop ( )
protectedvirtual

Called when the driver is stopped by the display engine.

Implements makVrv::DtDriver.

virtual void DtDistributedDrawDriver::slot_displayEngineAdded ( const DtDeRecord igRecord)
protectedvirtual

Called when a display engine is connected; restarts the driver.

Reimplemented from makVrv::DtDriver.

virtual bool DtDistributedDrawDriver::onTick ( )
protectedvirtual

Stub implementation since this driver doesn't have anything that needs updating.

Implements makVrv::DtDriver.

virtual void DtDistributedDrawDriver::updateSphere ( )
protectedvirtual

Utility function add a sphere at location x,y,z in the scene.

Member Data Documentation

DtExampleDrawObjectAgent* DtDistributedDrawDriver::myDrawAgent
protected

The draw agent that draws the sphere.

double DtDistributedDrawDriver::mySphereX
protected

Saved location of the sphere.

double DtDistributedDrawDriver::mySphereY
protected
double DtDistributedDrawDriver::mySphereZ
protected
bool DtDistributedDrawDriver::mySphereInScene
protected

Whether or not a sphere is displayed.


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


Copyright © 2005-2023 MAK Technologies. All Rights Reserved (www.mak.com)