makVrv::DtGlStudioDriver Class Reference

Driver for GLStudio cockpits. More...

Inheritance diagram for makVrv::DtGlStudioDriver:

Public Member Functions
	DtGlStudioDriver (DtAgentManager &agentManager, const std::string &instanceName)
	constructor
virtual	~DtGlStudioDriver ()
	destructor
virtual const std::string &	className () const
	Get this Driver's class name.
virtual void	hideEntity (DtObserver *obs)
virtual void	unHideEntity (DtObserver *obs)
virtual void	setAttachmentHas3DCockpit (DtObserver *obs, bool cockpit)
	The GL Studio driver uses this to tell the observer that it's going to render a 3D cockpit so the observer can take that into account when determining znear.
virtual void	realizeCockpit (DtObserver *obs, const std::string &modelDefinition="")
	Creates a cockpit for the given observer's attached entity.
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.
DtAgentManager &	agentManager ()
	Get the master scene for this host.
virtual DtAgentManagerInterface &	sceneInterface ()
	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 std::map< DtObserver *, DtUniqueID >	DtObserverAttachmentMap

Protected Member Functions
virtual bool	onStart ()
	Start the host output.
virtual bool	onStop ()
	Stop the host output.
virtual bool	onTick ()
	Tick.
virtual void	handleAttachChange (DtObserver *obs)
	checks when attachment changes if a new cockpit needs to be
virtual void	handleObserverDestroyed (DtObserver *observer)
	checks when observers are destroyed if cockipts need to be removed
virtual void	handleObserverCreated (DtObserver *observer)
	checks when observer is created if cockpits need to be addeed
virtual void	handleEnableStateChanged (bool enabled)
	checks when HUDs are enabled, realizes cockpit for any entities Attached to that don't have a HUD yet.
virtual void	unrealizeCockpit (DtObserver *obs)
	cleans up any cockpits that may have been created
virtual DtUniqueID	findAttachedSimObject (DtObserver *obs)
	finds the sim object ID of the attached object
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
DtObserverAttachmentMap	myAttachedObserverMap
std::string	myClassName
DtAttachManager *	myAttachManager
DtDe *	myDe
Protected Attributes inherited from makVrv::DtDriver
DtAgentManager &	myAgentManager
bool	myStartedFlag
std::string	myName
DtConfiguration	myConfiguration
bool	myPersistentFlag
bool	myUserControllableFlag
bool	myRequestStateDiffPendingFlag
DtElementChanges	myChanges

Detailed Description

Driver for GLStudio cockpits.

Member Typedef Documentation

typedef std::map<DtObserver*, DtUniqueID> makVrv::DtGlStudioDriver::DtObserverAttachmentMap

protected

Constructor & Destructor Documentation

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

constructor

virtual makVrv::DtGlStudioDriver::~DtGlStudioDriver ( )

virtual

destructor

Member Function Documentation

virtual const std::string& makVrv::DtGlStudioDriver::className ( ) const

virtual

Get this Driver's class name.

Implements makVrv::DtDriver.

virtual void makVrv::DtGlStudioDriver::hideEntity ( DtObserver *  obs )

virtual

virtual void makVrv::DtGlStudioDriver::unHideEntity ( DtObserver *  obs )

virtual

virtual void makVrv::DtGlStudioDriver::setAttachmentHas3DCockpit ( DtObserver *  obs, bool  cockpit  )

virtual

The GL Studio driver uses this to tell the observer that it's going to render a 3D cockpit so the observer can take that into account when determining znear.

virtual void makVrv::DtGlStudioDriver::realizeCockpit ( DtObserver *  obs, const std::string &  modelDefinition = ""  )

virtual

Creates a cockpit for the given observer's attached entity.

If a model definition is given it will be created otherwise the default cockpit mappings will be used.

virtual bool makVrv::DtGlStudioDriver::onStart ( )

protectedvirtual

Start the host output.

Create all object for an existing host connection.

Implements makVrv::DtDriver.

virtual bool makVrv::DtGlStudioDriver::onStop ( )

protectedvirtual

Stop the host output.

All scene object created by the host should be destroyed.

Implements makVrv::DtDriver.

virtual bool makVrv::DtGlStudioDriver::onTick ( )

protectedvirtual

Tick.

Implements makVrv::DtDriver.

virtual void makVrv::DtGlStudioDriver::handleAttachChange ( DtObserver *  obs )

protectedvirtual

checks when attachment changes if a new cockpit needs to be

virtual void makVrv::DtGlStudioDriver::handleObserverDestroyed ( DtObserver *  observer )

protectedvirtual

checks when observers are destroyed if cockipts need to be removed

virtual void makVrv::DtGlStudioDriver::handleObserverCreated ( DtObserver *  observer )

protectedvirtual

checks when observer is created if cockpits need to be addeed

virtual void makVrv::DtGlStudioDriver::handleEnableStateChanged ( bool  enabled )

protectedvirtual

checks when HUDs are enabled, realizes cockpit for any entities Attached to that don't have a HUD yet.

virtual void makVrv::DtGlStudioDriver::unrealizeCockpit ( DtObserver *  obs )

protectedvirtual

cleans up any cockpits that may have been created

virtual DtUniqueID makVrv::DtGlStudioDriver::findAttachedSimObject ( DtObserver *  obs )

protectedvirtual

finds the sim object ID of the attached object

Member Data Documentation

DtObserverAttachmentMap makVrv::DtGlStudioDriver::myAttachedObserverMap

protected

std::string makVrv::DtGlStudioDriver::myClassName

protected

DtAttachManager* makVrv::DtGlStudioDriver::myAttachManager

protected

DtDe* makVrv::DtGlStudioDriver::myDe

protected

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrvGlStudioShared/DtGlStudioDriver.h