DtGimbalDriver looks for the plane element created by DtExampleDriver (or DtDriverExamplePlugin) and implements a gimbal attached to that plane at a specified offset. More...

Inheritance diagram for DtGimbalDriver:

[legend]

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

virtual	~DtGimbalDriver ()
	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 Member Functions
virtual bool	initialize ()
	initialize() looks for the plane created by DtExampleDriver (or DtExampleDriverPlugin). More...

virtual void	slot_coordinateSystemChanged ()
	We use this to set up our target location. 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
makVrv::DtGeoReference *	myPlaneGeoRef

makVrv::DtGeoReference *	myGimbalGeoRef

makVrv::DtSceneObjectAgent *	myGimbalSceneObjectAgent

makVrv::DtSceneObject *	myPlaneSceneObject

makVrv::DtElementID	myGimbalId

makVrv::DtSignalConnectionManager	mySignalConnections

DtGeodeticCoord *	myTargetLocation

Protected Attributes inherited from makVrv::DtDriver
DtAgentManager &	myAgentManager

bool	myStartedFlag

std::string	myName

DtConfiguration	myConfiguration

bool	myPersistentFlag

bool	myUserControllableFlag

bool	myRequestStateDiffPendingFlag

DtElementChanges	myChanges

Private Member Functions
	DtGimbalDriver ()
	Unimplemented CTOR to prevent auto-creation. More...

Methods Inherited from makVrv::DtDriver
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...

Detailed Description

DtGimbalDriver looks for the plane element created by DtExampleDriver (or DtDriverExamplePlugin) and implements a gimbal attached to that plane at a specified offset.

It shows how to use the DtGeoReference class to position and orient the gimbal using the plane's position and orientation; and how to find azimuth and elevation angles to a target in the gimbal's local coordinate system. It attaches the observer named "Observer 1" to the gimbal, and uses the azimuth and elevation angles determined to lock the observer onto the target location.

Constructor & Destructor Documentation

DtGimbalDriver::DtGimbalDriver ( makVrv::DtAgentManager & am )

CTOR.

virtual DtGimbalDriver::~DtGimbalDriver ( )

virtual

Virtual DTOR.

DtGimbalDriver::DtGimbalDriver ( )

private

Unimplemented CTOR to prevent auto-creation.

Member Function Documentation

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

virtual

Returns the driver's class name.

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

Implements makVrv::DtDriver.

virtual bool DtGimbalDriver::onStart ( )

protectedvirtual

Performs startup logic for the driver.

In this case, this method is a no-op (but must be implemented since it's pure virtual). Initialization is delayed until onTick() so that the plane we need to attach exists.

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

Implements makVrv::DtDriver.

virtual bool DtGimbalDriver::onStop ( )

protectedvirtual

Performs shutdown logic for the driver.

Deletes the Gimbal Element and GeoReference objects

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

Implements makVrv::DtDriver.

virtual bool DtGimbalDriver::onTick ( )

protectedvirtual

Performs update logic for the driver.

If myGimbalSceneObjectAgent hasn't been initialized yet, onTick() calls initialize(). Once initialized, each tick this method:

Updates the DtGeoReference for the plane with the plane's current position and orientation.
Finds the position and orientation of the gimbal in the plane's coordinate system and updates the gimbal's DtGeoReference
Finds the position of the target in the gimbal's coordinate system.
Calculates azimuth and elevation angles from the gimbal to the target
Sets the observer's attached rotation with the azimuth and elevation angles
See Also
makVrv::DtDriver::tick()

Implements makVrv::DtDriver.

virtual void DtGimbalDriver::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 DtGimbalDriver::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 bool DtGimbalDriver::initialize ( )

protectedvirtual

initialize() looks for the plane created by DtExampleDriver (or DtExampleDriverPlugin).

When found, it creates a Gimbal element that can be (logically) attached to the plane. It also creates the DtGeoReferences to use for topocentric operations to correctly place the Gimbal element and put the target into Gimbal coordinates.

virtual void DtGimbalDriver::slot_coordinateSystemChanged ( )

protectedvirtual

We use this to set up our target location.

This is mostly for future use when we support alternate datums, since the target location (being geodetic) needs to be reset if the datum changes.

Member Data Documentation

makVrv::DtGeoReference* DtGimbalDriver::myPlaneGeoRef

protected

makVrv::DtGeoReference* DtGimbalDriver::myGimbalGeoRef

protected

makVrv::DtSceneObjectAgent* DtGimbalDriver::myGimbalSceneObjectAgent

protected

makVrv::DtSceneObject* DtGimbalDriver::myPlaneSceneObject

protected

makVrv::DtElementID DtGimbalDriver::myGimbalId

protected

makVrv::DtSignalConnectionManager DtGimbalDriver::mySignalConnections

protected

DtGeodeticCoord* DtGimbalDriver::myTargetLocation

protected

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

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf4-10-branch/examples/exampleGimbalPlugin/DtGimbalDriver.h

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Methods Inherited from makVrv::DtDriver

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation