DtExampleDriver Class Reference

Inheritance diagram for DtExampleDriver:

Public Member Functions
	DtExampleDriver (makVrv::DtAgentManager &am)
virtual	~DtExampleDriver ()
	DtExampleDriver (makVrv::DtAgentManager &am)
virtual	~DtExampleDriver ()
Public Member Functions inherited from makVrv::DtDriver
	DtDriver (DtAgentManager &agentManager, const std::string &instanceName)
virtual	~DtDriver ()
virtual void	realizeConfiguration (const DtConfiguration &configuration)
virtual DtConfiguration	createConfiguration () const
DtAgentManager &	agentManager ()
virtual DtAgentManagerInterface &	sceneInterface ()
bool	started () const
virtual const std::string &	instanceName () const
virtual bool	autoStart () const
virtual void	setAutoStart (bool autoStart)
virtual bool	isWindowDependent () const
virtual void	setIsWindowDependent (bool dep)
virtual void	setIsUserControllable (bool)
virtual bool	isUserControllable () const
virtual void	setIsPersistent (bool per)
virtual bool	isPersistent () const
virtual bool	isOnDriverSelectionList () const
virtual void	setOnDriverSelectionList (bool)
bool	objectFromAgentManager (const DtUniqueID &id) const

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
virtual const std::string &	className () const
virtual bool	onStart ()
virtual bool	onStop ()
virtual bool	onTick ()
virtual void	attachObserverToEntity (const std::string &entityName)
virtual void	slot_displayEngineAdded (const makVrv::DtDeRecord &igRecord)
virtual bool	onStart ()
virtual bool	onStop ()
virtual bool	onTick ()
virtual void	attachObserverToEntity (const std::string &entityName)
virtual void	slot_displayEngineAdded (const makVrv::DtDeRecord &igRecord)

Additional Inherited Members
Protected Member Functions inherited from makVrv::DtDriver
void	applyChangesAndDelete (DtElementChanges *changes)
void	reportElementCreated (DtElementID id, DtElementID parentId, DtElementEntry::ElementType type)
void	reportElementAttribute (DtElementID id, DtElementAttribute *attribute)
void	reportElementDestroyed (DtElementID id)
void	start ()
void	stop ()
bool	tick ()
virtual void	setInstanceName (const std::string &name)
virtual void	installAccessories ()
virtual void	uninstallAccessories ()

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.vrf5-1-branch/examples/exampleDriver/DtExampleDriver.h
• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-1-branch/examples/exampleDriverPlugin/exampleDriver.h