Inheritance diagram for DtExampleDriver:

Public Member Functions
	DtExampleDriver (makVrv::DtAgentManager &am)
	CTOR. More...

virtual	~DtExampleDriver ()
	Virtual DTOR. More...

	DtExampleDriver (makVrv::DtAgentManager &am)
	CTOR. More...

virtual	~DtExampleDriver ()
	Virtual DTOR. 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...

DtAgentManager &	agentManager ()
	Get the master scene for this host. More...

virtual DtAgentManagerInterface &	sceneInterface ()
	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 Attributes
DtExampleSimEngine *	myExampleSimEngine

Protected Attributes inherited from makVrv::DtDriver
DtAgentManager &	myAgentManager

bool	myStartedFlag

std::string	myName

DtConfiguration	myConfiguration

bool	myPersistentFlag

bool	myUserControllableFlag

bool	myRequestStateDiffPendingFlag

DtElementChanges	myChanges

Methods Inherited from makVrv::DtDriver
virtual const std::string &	className () const
	Returns the driver's class name. More...

virtual const std::string &	className () const
	Returns the driver's class name. More...

virtual bool	onStart ()
	Performs startup logic for the driver. More...

virtual bool	onStop ()
	Performs shutdown logic for the driver. More...

virtual bool	onTick ()
	Performs update logic for the driver. More...

virtual void	attachObserverToEntity (const std::string &entityName)
	Tells the current observer to attach to the named entity. More...

virtual void	slot_displayEngineAdded (const makVrv::DtDeRecord &igRecord)
	Ensures the driver is properly restarted when a de is connected (such as a remote display engine). More...

virtual bool	onStart ()
	Performs startup logic for the driver. More...

virtual bool	onStop ()
	Performs shutdown logic for the driver. More...

virtual bool	onTick ()
	Performs update logic for the driver. More...

virtual void	attachObserverToEntity (const std::string &entityName)
	Tells the current observer to attach to the named entity. More...

virtual void	slot_displayEngineAdded (const makVrv::DtDeRecord &igRecord)
	Ensures the driver is properly restarted when a de is connected (such as a remote display engine). More...

Additional Inherited Members
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...

Constructor & Destructor Documentation

DtExampleDriver::DtExampleDriver ( makVrv::DtAgentManager & am )

CTOR.

virtual DtExampleDriver::~DtExampleDriver ( )

virtual

Virtual DTOR.

DtExampleDriver::DtExampleDriver ( makVrv::DtAgentManager & am )

CTOR.

virtual DtExampleDriver::~DtExampleDriver ( )

virtual

Virtual DTOR.

Member Function Documentation

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

virtual

Returns the driver's class name.

See Also: makVrv::DtDriver::className() const

Implements makVrv::DtDriver.

virtual bool DtExampleDriver::onStart ( )

protectedvirtual

Performs startup logic for the driver.

See Also: makVrv::DtDriver::start()

Implements makVrv::DtDriver.

virtual bool DtExampleDriver::onStop ( )

protectedvirtual

Performs shutdown logic for the driver.

See Also: makVrv::DtDriver::stop()

Implements makVrv::DtDriver.

virtual bool DtExampleDriver::onTick ( )

protectedvirtual

Performs update logic for the driver.

See Also: makVrv::DtDriver::tick()

Implements makVrv::DtDriver.

virtual void DtExampleDriver::attachObserverToEntity ( const std::string & entityName )

protectedvirtual

Tells the current observer to attach to the named entity.

This method uses an observer state record, and calls DtObserver::setFromRecord. When setFromRecord is used, the observer will listen for the existence of the named entity and actually do the attachment when the entity is created

virtual void DtExampleDriver::slot_displayEngineAdded ( const makVrv::DtDeRecord & igRecord )

protectedvirtual

Ensures the driver is properly restarted when a de is connected (such as a remote display engine).

See Also: makVrv::DtDriver::slot_displayEngineAdded( const makVrv::DtDeRecord& )

Reimplemented from makVrv::DtDriver.

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

virtual

Returns the driver's class name.

See Also: makVrv::DtDriver::className() const

Implements makVrv::DtDriver.

virtual bool DtExampleDriver::onStart ( )

protectedvirtual

Performs startup logic for the driver.

See Also: makVrv::DtDriver::start()

Implements makVrv::DtDriver.

virtual bool DtExampleDriver::onStop ( )

protectedvirtual

Performs shutdown logic for the driver.

See Also: makVrv::DtDriver::stop()

Implements makVrv::DtDriver.

virtual bool DtExampleDriver::onTick ( )

protectedvirtual

Performs update logic for the driver.

See Also: makVrv::DtDriver::tick()

Implements makVrv::DtDriver.

virtual void DtExampleDriver::attachObserverToEntity ( const std::string & entityName )

protectedvirtual

Tells the current observer to attach to the named entity.

This method uses an observer state record, and calls DtObserver::setFromRecord. When setFromRecord is used, the observer will listen for the existence of the named entity and actually do the attachment when the entity is created

virtual void DtExampleDriver::slot_displayEngineAdded ( const makVrv::DtDeRecord & igRecord )

protectedvirtual

Ensures the driver is properly restarted when a de is connected (such as a remote display engine).

See Also: makVrv::DtDriver::slot_displayEngineAdded( const makVrv::DtDeRecord& )

Reimplemented from makVrv::DtDriver.

Member Data Documentation

DtExampleSimEngine * DtExampleDriver::myExampleSimEngine

protected

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

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf4-10-branch/examples/exampleDriver/DtExampleDriver.h
/data/exports/nrhent7-1/nightly/docs/vrForces.vrf4-10-branch/examples/exampleDriverPlugin/exampleDriver.h

Public Member Functions

Protected Attributes

Methods Inherited from makVrv::DtDriver

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation