makVrv::DtConnection Class Reference

The base class for protocol specific VRLink Simulations. More...

Inheritance diagram for makVrv::DtConnection:

Public Member Functions
	DtConnection (DtAgentManagerInterface &aSceneInterface, const DtCoordinateSystem &coordSystem, const DtEntityAppearanceMapperFactoryCreator &appFactoryCreator, DtSharedSettingsManager &settingsManager)
	CTOR.
virtual	~DtConnection ()
	DTOR.
const DtEntityAppearanceMapper *	findAppearanceMapper (const DtEntityType &type)
	Attempt to get an appearance mapper from an entity type.
virtual void	coordinateSystemChanged (const std::string &coordinateName, const std::string &coordinateOrigin)
const DtCoordinateSystem &	coordinateSystem () const
	Get the coordinate system.
const DtDisplayUnitsConverter &	displayUnitConverter () const
	Get the display unit converter.
virtual bool	connect ()=0
	Function that creates the exercise conn and reflected lists.
virtual bool	connected () const
	Check to see if the simulation is connected.
virtual bool	disconnect ()=0
	Function that destroys the exercise conn and reflected lists.
virtual void	tick ()=0
	Function to be called repeatedly by a thread.
virtual void	setViewControlChanged (bool enabled)=0
	Set that the view controls have changed.
virtual void	setUseTopoForFlatEarthVectorConversion (bool enabled)=0
	We used to use a topo system to convert flat earth vectors.
virtual void	observerUpdated (const std::string &observerName, double x, double y, double z, double psi, double theta, double phi)=0
	handle observer position and orientation changes
virtual void	observerUpdated (const std::string &observerName, double x, double y, double z, double psi, double theta, double phi, double dx, double dy, double dz, double dpsi, double dtheta, double dphi)=0
	handle observer poistion and orientation changes including rotational and linear velocities
virtual void	stopPublishingObserver (const std::string &observerName)=0
	Start publishing an observer.
virtual void	startPublishingObserver (const std::string &observerName)=0
	Stop publishing an observer.
virtual void	attachObserverObject (const std::string &observerName, DtUniqueID id)=0
	Handle attachment of a published observer to an object.
virtual void	detachObjects (const std::string &observerName)=0
	Handle detachment of a published observer.
void	entityIndicatorMouseDown (DtMouseState &mouseState, const DtUniqueID &id, const std::string &displayEngineName, const std::string &windowName, const std::string &channelName)
	Called when an entity is selected/deselected by the sim via its indicator.
void	entityIndicatorMouseUp (DtMouseState &mouseState, const DtUniqueID &id, const std::string &displayEngineName, const std::string &windowName, const std::string &channelName)
void	entityIndicatorMouseDblClick (DtMouseState &mouseState, const DtUniqueID &id, const std::string &displayEngineName, const std::string &windowName, const std::string &channelName)
void	tacticalGraphicIndicatorMouseDown (DtMouseState &mouseState, const DtUniqueID &id, const std::string &displayEngineName, const std::string &windowName, const std::string &channelName)
	Called when an tactical graphic is selected/deselected by the sim via its indicator.
void	tacticalGraphicIndicatorMouseUp (DtMouseState &mouseState, const DtUniqueID &id, const std::string &displayEngineName, const std::string &windowName, const std::string &channelName)
void	tacticalGraphicIndicatorMouseDblClick (DtMouseState &mouseState, const DtUniqueID &id, const std::string &displayEngineName, const std::string &windowName, const std::string &channelName)
void	setAppNumber (int appNumber)
	Set the application number (for HLA connections only, DIS should use the initializer)
void	setSiteId (int siteId)
	Set the site ID (useful for HLA connections only, DIS connections should use the initializer)
Public Member Functions inherited from makVrv::DtBaseConnection
	DtBaseConnection (DtSharedSettingsManager &, DtAgentManagerInterface &)
	CTOR.
virtual	~DtBaseConnection ()
	DTOR MUST call clearInstances first.
virtual void	clearInstances ()
	Clear and delete all instances rooted in the connection MUST be called before the connection is destroyed.
DtSharedSettingsManager &	settingsManager ()
	Get the settings manager.
virtual DtAgentManagerInterface &	sceneInterface ()
	Get the scene manager interface for creating drivers.
const DtSharedSettingsManager &	settingsManager () const
	Get the settings manager.
void	reportElementCreated (DtElementID id, DtElementID parentId, unsigned int type)
	Report an element created.
void	reportElementAttribute (DtElementID id, DtElementAttribute *attribute)
void	reportElementDestroyed (DtElementID id)
	Report an element destroyed.
const DtElementChanges &	currentElementChanges () const
	Look at the current element changes.
DtElementChanges *	takeElementChanges ()
	Take the current changes and internally start a new set of changes.
DtTemporaryAgentManager &	temporaryEffects ()
	Get the temporary effects manager.
DtBlinkingObjectManager &	blinkManager ()
	Get the blinking manager.
DtRandomNumberGenerator &	randomNumberGenerator ()
	Get the simulation's random number generator.
virtual const std::string &	tag ()
	Get the tag identifying which type of connection this is.
const DtUnicode &	emptyString () const
	Allocated empty string.
virtual DtVirtualBaseClass *	findInstance (const std::string &instanceName)
	Find an instance with the given name.
bool	destroyingInstances () const
	Check to see if the simulation is destroying instances.
virtual void	registerInstance (const std::string &instanceName, DtVirtualBaseClass *instance)
	Register an object as an instance of instanceName, and transfer memory ownership of the instance to the DtConnection.

Public Attributes
boost::signal< void(DtMouseState &, const DtUniqueID &, const std::string &displayEngineName, const std::string &windowName, const std::string &channelName)>	signal_entityIndicatorMouseDown
	Emitted when an entity indicator is clicked.
boost::signal< void(DtMouseState &, const DtUniqueID &, const std::string &displayEngineName, const std::string &windowName, const std::string &channelName)>	signal_entityIndicatorMouseUp
boost::signal< void(DtMouseState &, const DtUniqueID &, const std::string &displayEngineName, const std::string &windowName, const std::string &channelName)>	signal_entityIndicatorMouseDblClick
boost::signal< void(DtMouseState &, const DtUniqueID &, const std::string &displayEngineName, const std::string &windowName, const std::string &channelName)>	signal_tacticalGraphicIndicatorMouseDown
	Emitted when an tactical graphic indicator is clicked.
boost::signal< void(DtMouseState &, const DtUniqueID &, const std::string &displayEngineName, const std::string &windowName, const std::string &channelName)>	signal_tacticalGraphicIndicatorMouseUp
boost::signal< void(DtMouseState &, const DtUniqueID &, const std::string &displayEngineName, const std::string &windowName, const std::string &channelName)>	signal_tacticalGraphicIndicatorMouseDblClick
boost::signal< void(DtViewStateProcessor::ObserverAction &)>	signal_viewChanged
	Emitted when a view control change is received.
boost::signal< void()>	signal_coordinateSystemChanged
	Emitted when the coordinate system changed.
boost::signal< void()>	signal_connected
	Emitted when the connection finished connecting.
boost::signal< void()>	signal_toBeDisconnected
	Emitted when the connection will be disconnecting.

Protected Types
typedef boost::unordered_map < std::string, DtEntityAppearanceMapper * >	AppearanceMapperMap
Protected Types inherited from makVrv::DtBaseConnection
typedef boost::unordered_map < std::string, DtVirtualBaseClass * >	InstanceMap

Protected Attributes
DtCoordinateSystem *	myCoordinateSystem
DtDisplayUnitsConverter *	myCoordinateConverter
AppearanceMapperMap	myAppearanceMapperMap
	Map of appearance mappers shared by entities of the same type.
DtEntityAppearanceMapperFactory *	myMapperFactory
	Factory responsible for creating Appearance Mappers.
int	myAppNumber
int	mySiteId
Protected Attributes inherited from makVrv::DtBaseConnection
DtSharedSettingsManager &	mySettingsManagerCache
DtRandomNumberGenerator	myRandomNumberGenerator
DtAgentManagerInterface &	mySceneInterface
DtElementChanges *	myWorkingElementChanges
DtTemporaryAgentManager *	myTemporaryEffects
DtBlinkingObjectManager *	myBlinkManager
	Manager for blinking objects.
DtUnicode	myEmptyString
InstanceMap	myInstances
bool	myDestroyingInstanceFlag

Detailed Description

The base class for protocol specific VRLink Simulations.

Member Typedef Documentation

typedef boost::unordered_map<std::string,DtEntityAppearanceMapper*> makVrv::DtConnection::AppearanceMapperMap

protected

Constructor & Destructor Documentation

makVrv::DtConnection::DtConnection	(	DtAgentManagerInterface &	aSceneInterface,
		const DtCoordinateSystem &	coordSystem,
		const DtEntityAppearanceMapperFactoryCreator &	appFactoryCreator,
		DtSharedSettingsManager &	settingsManager
	)

CTOR.

virtual makVrv::DtConnection::~DtConnection ( )

virtual

DTOR.

Member Function Documentation

const DtEntityAppearanceMapper* makVrv::DtConnection::findAppearanceMapper

(

const DtEntityType &

type

)

Attempt to get an appearance mapper from an entity type.

virtual void makVrv::DtConnection::coordinateSystemChanged ( const std::string &  coordinateName, const std::string &  coordinateOrigin  )

virtual

const DtCoordinateSystem& makVrv::DtConnection::coordinateSystem

(

)

const

Get the coordinate system.

Referenced by makVrv::DT_PROTOCOL_NAMESPACE::DtVrlinkBoxVisualizer< T >::addPoint(), makVrv::DT_PROTOCOL_NAMESPACE::DtVrlinkBoxVisualizer< T >::modifyPoint(), makVrv::DT_PROTOCOL_NAMESPACE::DtVrlinkBoxVisualizer< T >::setOrigin(), makVrv::DT_PROTOCOL_NAMESPACE::DtVrlinkBoxVisualizer< T >::setPoints(), and makVrv::DT_PROTOCOL_NAMESPACE::DtVrlinkEllipseVisualizer< T >::setPosition().

const DtDisplayUnitsConverter& makVrv::DtConnection::displayUnitConverter

(

)

const

Get the display unit converter.

virtual bool makVrv::DtConnection::connect ( )

pure virtual

Function that creates the exercise conn and reflected lists.

Returns

if connect succeeds

Return values

true	success
false	failure

Implemented in makVrv::DT_PROTOCOL_NAMESPACE::DtVrlinkConnection.

virtual bool makVrv::DtConnection::connected ( ) const

virtual

Check to see if the simulation is connected.

Base version always returns false.

Reimplemented in makVrv::DT_PROTOCOL_NAMESPACE::DtVrlinkConnection.

virtual bool makVrv::DtConnection::disconnect ( )

pure virtual

Function that destroys the exercise conn and reflected lists.

Returns

if connect succeeds

Return values

true	success
false	failure

Implemented in makVrv::DT_PROTOCOL_NAMESPACE::DtVrlinkConnection.

virtual void makVrv::DtConnection::tick ( )

pure virtual

Function to be called repeatedly by a thread.

Implemented in makVrv::DT_PROTOCOL_NAMESPACE::DtVrlinkConnection.

virtual void makVrv::DtConnection::setViewControlChanged ( bool  enabled )

pure virtual

Set that the view controls have changed.

Implemented in makVrv::DT_PROTOCOL_NAMESPACE::DtVrlinkConnection.

virtual void makVrv::DtConnection::setUseTopoForFlatEarthVectorConversion ( bool  enabled )

pure virtual

We used to use a topo system to convert flat earth vectors.

Now we find the point at the end of the vector, convert start and end points, and subtract for a more accurate result. However, when receiving data from a sim using the old method (including older versions of VR-Forces and DI-Guy) user's may want to revert to the old scheme.

Implemented in makVrv::DT_PROTOCOL_NAMESPACE::DtVrlinkConnection.

virtual void makVrv::DtConnection::observerUpdated ( const std::string &  observerName, double  x, double  y, double  z, double  psi, double  theta, double  phi  )

pure virtual

handle observer position and orientation changes

Implemented in makVrv::DT_PROTOCOL_NAMESPACE::DtVrlinkConnection.

virtual void makVrv::DtConnection::observerUpdated ( const std::string &  observerName, double  x, double  y, double  z, double  psi, double  theta, double  phi, double  dx, double  dy, double  dz, double  dpsi, double  dtheta, double  dphi  )

pure virtual

handle observer poistion and orientation changes including rotational and linear velocities

Implemented in makVrv::DT_PROTOCOL_NAMESPACE::DtVrlinkConnection.

virtual void makVrv::DtConnection::stopPublishingObserver ( const std::string &  observerName )

pure virtual

Start publishing an observer.

Implemented in makVrv::DT_PROTOCOL_NAMESPACE::DtVrlinkConnection.

virtual void makVrv::DtConnection::startPublishingObserver ( const std::string &  observerName )

pure virtual

Stop publishing an observer.

Implemented in makVrv::DT_PROTOCOL_NAMESPACE::DtVrlinkConnection.

virtual void makVrv::DtConnection::attachObserverObject ( const std::string &  observerName, DtUniqueID  id  )

pure virtual

Handle attachment of a published observer to an object.

Implemented in makVrv::DT_PROTOCOL_NAMESPACE::DtVrlinkConnection.

virtual void makVrv::DtConnection::detachObjects ( const std::string &  observerName )

pure virtual

Handle detachment of a published observer.

Implemented in makVrv::DT_PROTOCOL_NAMESPACE::DtVrlinkConnection.

void makVrv::DtConnection::entityIndicatorMouseDown	(	DtMouseState &	mouseState,
		const DtUniqueID &	id,
		const std::string &	displayEngineName,
		const std::string &	windowName,
		const std::string &	channelName
	)

Called when an entity is selected/deselected by the sim via its indicator.

void makVrv::DtConnection::entityIndicatorMouseUp	(	DtMouseState &	mouseState,
		const DtUniqueID &	id,
		const std::string &	displayEngineName,
		const std::string &	windowName,
		const std::string &	channelName
	)

void makVrv::DtConnection::entityIndicatorMouseDblClick	(	DtMouseState &	mouseState,
		const DtUniqueID &	id,
		const std::string &	displayEngineName,
		const std::string &	windowName,
		const std::string &	channelName
	)

void makVrv::DtConnection::tacticalGraphicIndicatorMouseDown	(	DtMouseState &	mouseState,
		const DtUniqueID &	id,
		const std::string &	displayEngineName,
		const std::string &	windowName,
		const std::string &	channelName
	)

Called when an tactical graphic is selected/deselected by the sim via its indicator.

void makVrv::DtConnection::tacticalGraphicIndicatorMouseUp	(	DtMouseState &	mouseState,
		const DtUniqueID &	id,
		const std::string &	displayEngineName,
		const std::string &	windowName,
		const std::string &	channelName
	)

void makVrv::DtConnection::tacticalGraphicIndicatorMouseDblClick	(	DtMouseState &	mouseState,
		const DtUniqueID &	id,
		const std::string &	displayEngineName,
		const std::string &	windowName,
		const std::string &	channelName
	)

void makVrv::DtConnection::setAppNumber

(

int

appNumber

)

Set the application number (for HLA connections only, DIS should use the initializer)

void makVrv::DtConnection::setSiteId

(

int

siteId

)

Set the site ID (useful for HLA connections only, DIS connections should use the initializer)

Member Data Documentation

boost::signal<void (DtMouseState&, const DtUniqueID&, const std::string& displayEngineName, const std::string& windowName, const std::string& channelName)> makVrv::DtConnection::signal_entityIndicatorMouseDown

Emitted when an entity indicator is clicked.

boost::signal<void (DtMouseState&, const DtUniqueID&, const std::string& displayEngineName, const std::string& windowName, const std::string& channelName)> makVrv::DtConnection::signal_entityIndicatorMouseUp

boost::signal<void (DtMouseState&, const DtUniqueID&, const std::string& displayEngineName, const std::string& windowName, const std::string& channelName)> makVrv::DtConnection::signal_entityIndicatorMouseDblClick

boost::signal<void (DtMouseState&, const DtUniqueID&, const std::string& displayEngineName, const std::string& windowName, const std::string& channelName)> makVrv::DtConnection::signal_tacticalGraphicIndicatorMouseDown

Emitted when an tactical graphic indicator is clicked.

boost::signal<void (DtMouseState&, const DtUniqueID&, const std::string& displayEngineName, const std::string& windowName, const std::string& channelName)> makVrv::DtConnection::signal_tacticalGraphicIndicatorMouseUp

boost::signal<void (DtMouseState&, const DtUniqueID&, const std::string& displayEngineName, const std::string& windowName, const std::string& channelName)> makVrv::DtConnection::signal_tacticalGraphicIndicatorMouseDblClick

boost::signal<void (DtViewStateProcessor::ObserverAction&)> makVrv::DtConnection::signal_viewChanged

Emitted when a view control change is received.

boost::signal<void ()> makVrv::DtConnection::signal_coordinateSystemChanged

Emitted when the coordinate system changed.

Referenced by makVrv::DT_PROTOCOL_NAMESPACE::DtVrlinkBoxVisualizer< T >::DtVrlinkBoxVisualizer(), and makVrv::DT_PROTOCOL_NAMESPACE::DtVrlinkEllipseVisualizer< T >::DtVrlinkEllipseVisualizer().

boost::signal<void ()> makVrv::DtConnection::signal_connected

Emitted when the connection finished connecting.

boost::signal<void ()> makVrv::DtConnection::signal_toBeDisconnected

Emitted when the connection will be disconnecting.

DtCoordinateSystem* makVrv::DtConnection::myCoordinateSystem

protected

DtDisplayUnitsConverter* makVrv::DtConnection::myCoordinateConverter

protected

AppearanceMapperMap makVrv::DtConnection::myAppearanceMapperMap

protected

Map of appearance mappers shared by entities of the same type.

DtEntityAppearanceMapperFactory* makVrv::DtConnection::myMapperFactory

protected

Factory responsible for creating Appearance Mappers.

int makVrv::DtConnection::myAppNumber

protected

int makVrv::DtConnection::mySiteId

protected

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.vrf4-3-branch/include/vrvVrl/DtConnection.h