MyViewControl::MyAttachObserverCommand Class Reference

MyAttachObserverCommand is a custom VR-Vantage class that processes view control messages with the command type MyControlToolkit::AttachObserverToSensor. Note that instances of this class are created and its methods called in the VR-Link connection thread, except for execute(), which is called in the Main (render) thread.

Inheritance diagram for MyViewControl::MyAttachObserverCommand:

Public Member Functions
	MyAttachObserverCommand ()
virtual	~MyAttachObserverCommand ()
virtual const DtUniqueID &	entityId ()
virtual void	setEntityId (const DtUniqueID &entityId)
virtual const std::string &	sensorName ()
virtual void	setSensorName (const std::string &sensorName)
virtual const std::string &	observerName ()
virtual void	setObserverName (const std::string &observerName)
virtual bool	createOverlay () const
virtual void	setCreateOverlay (bool)
virtual void	execute (DtDe &de)
Public Member Functions inherited from makVrv::DtVrvCommand
	DtVrvCommand ()
virtual	~DtVrvCommand ()
virtual vrvControlToolkit::DtVrvControlTypeEnum	commandType ()

Protected Attributes
DtUniqueID	myEntityId
std::string	mySensorName
std::string	myObserverName
bool	myCreateOverlay
Protected Attributes inherited from makVrv::DtVrvCommand
vrvControlToolkit::DtVrvControlTypeEnum	myCommandType

Constructor & Destructor Documentation

MyViewControl::MyAttachObserverCommand::MyAttachObserverCommand

(

)

CTOR.

virtual MyViewControl::MyAttachObserverCommand::~MyAttachObserverCommand ( )

virtual

Virtual DTOR.

Member Function Documentation

virtual const DtUniqueID& MyViewControl::MyAttachObserverCommand::entityId ( )

virtual

The Global ID of the entity that hosts the sensor.

virtual void MyViewControl::MyAttachObserverCommand::setEntityId ( const DtUniqueID &  entityId )

virtual

virtual const std::string& MyViewControl::MyAttachObserverCommand::sensorName ( )

virtual

The name of the sensor gimbal to attach to.

virtual void MyViewControl::MyAttachObserverCommand::setSensorName ( const std::string &  sensorName )

virtual

virtual const std::string& MyViewControl::MyAttachObserverCommand::observerName ( )

virtual

The name of the observer.

virtual void MyViewControl::MyAttachObserverCommand::setObserverName ( const std::string &  observerName )

virtual

virtual bool MyViewControl::MyAttachObserverCommand::createOverlay ( ) const

virtual

set and get whether to create or delete the sensor view

virtual void MyViewControl::MyAttachObserverCommand::setCreateOverlay ( bool  )

virtual

virtual void MyViewControl::MyAttachObserverCommand::execute ( DtDe &  de )

virtual

Execute makes the call(s) to the VR-Vantage API to actually make the changes requested in the message. Since it is passed a de (Display Engine) reference, it has access to most of the VR-Vantage API.

Implements makVrv::DtVrvCommand.

Member Data Documentation

DtUniqueID MyViewControl::MyAttachObserverCommand::myEntityId

protected

std::string MyViewControl::MyAttachObserverCommand::mySensorName

protected

std::string MyViewControl::MyAttachObserverCommand::myObserverName

protected

bool MyViewControl::MyAttachObserverCommand::myCreateOverlay

protected

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-2-branch/examples/exampleViewControl/MyAttachObserverCommand.h