makVrv::DtEnvironmentalPointKinStateVisualizer Class Reference

A point kin state visualizer for visualizing an object with a location and a relative offset. More...

Inheritance diagram for makVrv::DtEnvironmentalPointKinStateVisualizer:

Public Member Functions
	DtEnvironmentalPointKinStateVisualizer (DtBaseConnection &simulation, DtStateListener &listener, int modelSet)
	CTOR.
virtual	~DtEnvironmentalPointKinStateVisualizer ()
	DTOR.
virtual void	setOriginAndOffset (const DtVector &origin, const DtVector &offset)
	Call to scene object to set location. Placement is offset + origin.
const DtVector &	offset () const
	Gets the offset of the point.
const DtVector &	origin () const
	Gets the origin of the point.
virtual void	setVisualizerDefinition (const DtVisualizerDefinition &visDef)
	process the visual definition record
virtual DtTaitBryan	level ()
	Only the derived VRLink equivalent of this class can calculate this correctly for anything other than a projected database.
DtEnvironmentalStateListener &	environmentalStateListener ()
DtGroundClampingUpdaterAgent *	updaterAgent ()
virtual const DtStateVisualizer::TypeInfo &	typeInfo () const
	The instance's type info.
virtual void	setRelativeLocation (const DtVector &)
	If attached, the location offset from the origin of the entity.
virtual void	setCanBeAttached (bool)
	Set to false if this object cannot be attached to another, even if it should be via a host.
virtual void	startAttached ()
	Starts the process of attachment by creating updater for attachment.
virtual void	endAttached ()
	Ends the attachment process.
virtual void	setGroundClamp (bool)
	Whether or not point object should be ground clamped. Default is true.
virtual void	setAttached (DtUniqueID)
	Sets this object to be attached to the specified object.
Public Member Functions inherited from makVrv::DtSceneObjectVisualizer
	DtSceneObjectVisualizer (DtBaseConnection &simulation, DtStateListener &listener, int modelSet)
virtual	~DtSceneObjectVisualizer ()
virtual DtUniqueID	uniqueID () const
	Return unique id of mySceneObjectAgent, if it exists, else returns 0;.
virtual DtSceneObjectAgent *	sceneObjectAgent ()
virtual void	setParent (DtStateVisualizer *p)
	Override of base class setParent to simply set the parent without destroying/recreating model agents.
virtual void	setSceneObjectAgent (DtSceneObjectAgent *)
virtual void	setElementID (const DtElementID &elementID)
DtElementID	elementID () const
virtual bool	show (int)
	Override to show/hide scene object agent (if it exists)
virtual bool	hide (int)
	Will call destroyModelAgents(), if, when the context is added, it is the first context in the list.
Public Member Functions inherited from makVrv::DtStateVisualizer
	DtStateVisualizer (DtBaseConnection &connection, DtStateListener &listener, int modelSet)
	CTOR.
virtual	~DtStateVisualizer ()
	DTOR.
void	setModelDefinition (const std::string &definition)
	Sets the model definition and creates agent(s) based on that definition.
const std::string &	modelDefinition () const
	Gets the current model definition.
virtual bool	setVisible (bool visible, int context)
	Returns true if this context wants to show or hide the item.
virtual void	initialize ()
	Initialize the visualizer.
virtual bool	isVisible () const
	Returns true if visible.
virtual void	setSelected (bool)
	Sets selected state.
virtual bool	selected () const
void	setName (const std::string &)
	Internal name of state visualizer.
const std::string &	name () const
virtual void	setPickable (bool)
	Sets pickable state.
virtual bool	pickable () const
virtual void	setUniqueID (DtUniqueID id)
int	visualizerType () const
void	setShowHideContext (const std::vector< int > &s)
	Set show/hide context without changing visibility of item.
DtStateListener &	listener ()
DtBaseConnection &	simulation ()
	Get the connection for this visualizer.
void	setDistribute (bool b)
	Whether or not to distribute over the network.
bool	distribute () const

Static Public Member Functions
static const DtStateVisualizer::TypeInfo &	theTypeInfo ()
	This class's type info.

Protected Member Functions
virtual void	startGroundClamping ()
	Starts/stops ground clamping.
virtual void	stopGroundClamping ()
virtual void	createModelAgents ()
	Creates the model agent. If already created, makes it visible.
virtual void	destroyModelAgents ()
	Model agent is only destroyed in destructor.
virtual void	setModelDefinitionForAgents ()
	Sets model definition for all the agents that this visualizer might be using.
virtual void	resetSpatial ()
Protected Member Functions inherited from makVrv::DtSceneObjectVisualizer
virtual DtSceneObjectAgent *	createObjectAgent ()
Protected Member Functions inherited from makVrv::DtStateVisualizer
virtual void	slot_mouseDown (DtMouseState &mouseState, const std::string &displayEngineName, const std::string &windowName, const std::string &channelName)
	Called when the mouse is clicked in this visualizer.
virtual void	slot_mouseUp (DtMouseState &mouseState, const std::string &displayEngineName, const std::string &windowName, const std::string &channelName)
virtual void	slot_mouseDblClick (DtMouseState &mouseState, const std::string &displayEngineName, const std::string &windowName, const std::string &channelName)
virtual bool	supportsShowHideContext (int) const
	Default returns true.
template<typename T , typename C >
void	connectAndUpdate (boost::signal< void(T)> &sig, void(C::*fp)(T), T val)
	Connect a signal and update the entity.

Protected Attributes
DtModelAgent *	myModelAgent
DtGroundClampingUpdaterAgent *	myUpdater
DtVector	myOrigin
DtVector	myOffset
bool	myAffectsBounds
DtEnvironmentalStateListener *	myEnvironmentalListener
bool	myAttachedFlag
DtUniqueID	myAttachedToId
DtEmbarkationUpdaterAgent *	myAttachedUpdaterAgent
bool	myCanBeAttached
bool	myGroundClamp
Protected Attributes inherited from makVrv::DtSceneObjectVisualizer
DtElementID	myElementID
Protected Attributes inherited from makVrv::DtStateVisualizer
DtBaseConnection &	mySimulation
DtStateListener &	myListener
bool	myDistributeFlag
DtUniqueID	myUniqueID
std::string	myName
std::string	myModelDefinition
DtSignalConnectionManager	myConnections
int	myModelSet
int	myVisualizerType
std::vector< int >	myShowHideContexts
bool	mySelected
bool	myPickable
bool	myVisible
DtStateVisualizer *	myParent
DtSceneObjectAgent *	mySceneObjectAgent

Additional Inherited Members
Public Types inherited from makVrv::DtStateVisualizer
enum	Type {   AllVisualizerTypes = 0, EntityVisualizerType = 1, EnvironmentalVisualizerType, InteractionVisualizerType,   AggregateVisualizerType, IntervisibilityVisualizerType, TacticalSmokeVisualizerType, UserType = 10000 }
	Visualizer class types that are supportable via visualizers. More...
Public Attributes inherited from makVrv::DtStateVisualizer
boost::signal< void(DtStateVisualizer *, DtStateVisualizer *, DtStateVisualizer *)>	signal_reparented
	Signaled when the parent of this item changes, called before destroying any model agents.
boost::signal< void(DtMouseState &, const DtUniqueID &, const std::string &, const std::string &, const std::string &, DtStateVisualizer *)>	signal_mouseDown
	Emitted when the entity's indicator is clicked.
boost::signal< void(DtMouseState &, const DtUniqueID &, const std::string &, const std::string &, const std::string &, DtStateVisualizer *)>	signal_mouseUp
boost::signal< void(DtMouseState &, const DtUniqueID &, const std::string &, const std::string &, const std::string &, DtStateVisualizer *)>	signal_mouseDblClick

Detailed Description

A point kin state visualizer for visualizing an object with a location and a relative offset.

Constructor & Destructor Documentation

makVrv::DtEnvironmentalPointKinStateVisualizer::DtEnvironmentalPointKinStateVisualizer	(	DtBaseConnection &	simulation,
		DtStateListener &	listener,
		int	modelSet
	)

CTOR.

virtual makVrv::DtEnvironmentalPointKinStateVisualizer::~DtEnvironmentalPointKinStateVisualizer ( )

virtual

DTOR.

Member Function Documentation

virtual void makVrv::DtEnvironmentalPointKinStateVisualizer::setOriginAndOffset ( const DtVector &  origin, const DtVector &  offset  )

virtual

Call to scene object to set location. Placement is offset + origin.

const DtVector& makVrv::DtEnvironmentalPointKinStateVisualizer::offset

(

)

const

Gets the offset of the point.

The origin + offset is the actual location

const DtVector& makVrv::DtEnvironmentalPointKinStateVisualizer::origin

(

)

const

Gets the origin of the point.

virtual void makVrv::DtEnvironmentalPointKinStateVisualizer::setVisualizerDefinition ( const DtVisualizerDefinition &  visDef )

virtual

process the visual definition record

Reimplemented from makVrv::DtStateVisualizer.

Reimplemented in makVrv::Dt2DTextBoxVisualizer.

virtual DtTaitBryan makVrv::DtEnvironmentalPointKinStateVisualizer::level ( )

virtual

Only the derived VRLink equivalent of this class can calculate this correctly for anything other than a projected database.

Reimplemented in makVrv::DT_PROTOCOL_NAMESPACE::DtVrlinkEnvironmentalPointKinStateVisualizer, and makVrf::DtVrfGuiEnvironmentalPointKinStateVisualizer.

DtEnvironmentalStateListener& makVrv::DtEnvironmentalPointKinStateVisualizer::environmentalStateListener ( )

inline

DtGroundClampingUpdaterAgent* makVrv::DtEnvironmentalPointKinStateVisualizer::updaterAgent ( )

inline

virtual const DtStateVisualizer::TypeInfo& makVrv::DtEnvironmentalPointKinStateVisualizer::typeInfo ( ) const

virtual

The instance's type info.

Implements makVrv::DtStateVisualizer.

Reimplemented in makVrv::Dt2DTextBoxVisualizer.

static const DtStateVisualizer::TypeInfo& makVrv::DtEnvironmentalPointKinStateVisualizer::theTypeInfo ( )

static

This class's type info.

Reimplemented in makVrv::Dt2DTextBoxVisualizer.

virtual void makVrv::DtEnvironmentalPointKinStateVisualizer::setRelativeLocation ( const DtVector &  )

virtual

If attached, the location offset from the origin of the entity.

virtual void makVrv::DtEnvironmentalPointKinStateVisualizer::setCanBeAttached ( bool  )

virtual

Set to false if this object cannot be attached to another, even if it should be via a host.

virtual void makVrv::DtEnvironmentalPointKinStateVisualizer::startAttached ( )

virtual

Starts the process of attachment by creating updater for attachment.

Reimplemented in makVrv::DT_PROTOCOL_NAMESPACE::DtVrlinkEnvironmentalPointKinStateVisualizer.

virtual void makVrv::DtEnvironmentalPointKinStateVisualizer::endAttached ( )

virtual

Ends the attachment process.

virtual void makVrv::DtEnvironmentalPointKinStateVisualizer::setGroundClamp ( bool  )

virtual

Whether or not point object should be ground clamped. Default is true.

virtual void makVrv::DtEnvironmentalPointKinStateVisualizer::setAttached ( DtUniqueID  )

virtual

Sets this object to be attached to the specified object.

Once attached this object will move its origin offset from the relative location

virtual void makVrv::DtEnvironmentalPointKinStateVisualizer::startGroundClamping ( )

protectedvirtual

Starts/stops ground clamping.

Reimplemented in makVrf::DtVrfGuiEnvironmentalPointKinStateVisualizer.

virtual void makVrv::DtEnvironmentalPointKinStateVisualizer::stopGroundClamping ( )

protectedvirtual

virtual void makVrv::DtEnvironmentalPointKinStateVisualizer::createModelAgents ( )

protectedvirtual

Creates the model agent. If already created, makes it visible.

Reimplemented from makVrv::DtSceneObjectVisualizer.

Reimplemented in makVrv::Dt2DTextBoxVisualizer, and makVrf::DtVrfGuiEnvironmentalPointKinStateVisualizer.

virtual void makVrv::DtEnvironmentalPointKinStateVisualizer::destroyModelAgents ( )

protectedvirtual

Model agent is only destroyed in destructor.

Here, it will be hidden (if it has been created)

Reimplemented from makVrv::DtSceneObjectVisualizer.

Reimplemented in makVrv::Dt2DTextBoxVisualizer.

virtual void makVrv::DtEnvironmentalPointKinStateVisualizer::setModelDefinitionForAgents ( )

protectedvirtual

Sets model definition for all the agents that this visualizer might be using.

If model agents are not created, should create them. Should not call this directly, but rather call setModelDefinition

Reimplemented from makVrv::DtSceneObjectVisualizer.

Reimplemented in makVrv::Dt2DTextBoxVisualizer.

virtual void makVrv::DtEnvironmentalPointKinStateVisualizer::resetSpatial ( )

protectedvirtual

Reimplemented in makVrv::DT_PROTOCOL_NAMESPACE::DtVrlinkEnvironmentalPointKinStateVisualizer, makVrf::DtVrfGuiEnvironmentalPointKinStateVisualizer, and makVrv::DT_PROTOCOL_NAMESPACE::DtVrlink2DTextBoxVisualizer.

Member Data Documentation

DtModelAgent* makVrv::DtEnvironmentalPointKinStateVisualizer::myModelAgent

protected

DtGroundClampingUpdaterAgent* makVrv::DtEnvironmentalPointKinStateVisualizer::myUpdater

protected

DtVector makVrv::DtEnvironmentalPointKinStateVisualizer::myOrigin

protected

DtVector makVrv::DtEnvironmentalPointKinStateVisualizer::myOffset

protected

bool makVrv::DtEnvironmentalPointKinStateVisualizer::myAffectsBounds

protected

DtEnvironmentalStateListener* makVrv::DtEnvironmentalPointKinStateVisualizer::myEnvironmentalListener

protected

bool makVrv::DtEnvironmentalPointKinStateVisualizer::myAttachedFlag

protected

DtUniqueID makVrv::DtEnvironmentalPointKinStateVisualizer::myAttachedToId

protected

DtEmbarkationUpdaterAgent* makVrv::DtEnvironmentalPointKinStateVisualizer::myAttachedUpdaterAgent

protected

bool makVrv::DtEnvironmentalPointKinStateVisualizer::myCanBeAttached

protected

bool makVrv::DtEnvironmentalPointKinStateVisualizer::myGroundClamp

protected

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrvCore/DtEnvironmentalPointKinStateVisualizer.h