makVrv::DtSceneObjectVisualizer Class Reference

Base class for visualizing generic objects in the scene. More...

Inheritance diagram for makVrv::DtSceneObjectVisualizer:

Public Member Functions
	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	setModelDefinitionForAgents ()
	Sets model definition for all the agents that this visualizer might be using.
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.
virtual const TypeInfo &	typeInfo () const =0
	Get the type info.
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.
virtual void	setVisualizerDefinition (const DtVisualizerDefinition &)
	Set any other additional visualizer information from the visual record.
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

Protected Member Functions
virtual DtSceneObjectAgent *	createObjectAgent ()
virtual void	createModelAgents ()
	Creates the model agent. If already created, makes it visible.
virtual void	destroyModelAgents ()
	Model agent is only destroyed in destructor.
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
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

Base class for visualizing generic objects in the scene.

Constructor & Destructor Documentation

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

virtual makVrv::DtSceneObjectVisualizer::~DtSceneObjectVisualizer ( )

virtual

Member Function Documentation

virtual DtUniqueID makVrv::DtSceneObjectVisualizer::uniqueID ( ) const

virtual

Return unique id of mySceneObjectAgent, if it exists, else returns 0;.

Reimplemented from makVrv::DtStateVisualizer.

Reimplemented in makVrv::DtEnvironmentalVertexVisualizer.

virtual DtSceneObjectAgent* makVrv::DtSceneObjectVisualizer::sceneObjectAgent ( )

virtual

virtual void makVrv::DtSceneObjectVisualizer::setParent ( DtStateVisualizer *  p )

virtual

Override of base class setParent to simply set the parent without destroying/recreating model agents.

Reimplemented from makVrv::DtStateVisualizer.

virtual void makVrv::DtSceneObjectVisualizer::setModelDefinitionForAgents ( )

virtual

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

Implements makVrv::DtStateVisualizer.

Reimplemented in makVrv::DtEntityKinStateVisualizer, makVrv::DtEnvironmentalLineVisualizer, makVrv::Dt3DLineStateVisualizer, makVrv::DtEnvironmentalAreaVisualizer, makVrv::DtCylinderStateVisualizer, makVrv::Dt3DTextStateVisualizer, makVrv::DtIntervisibilityLineVisualizer, makVrv::DtAttributeGroupStateVisualizer, makVrv::DtEllipsoidStateVisualizer, makVrv::DtIntervisibilityFanVisualizer, makVrv::DtCuboidStateVisualizer, makVrv::DtEnvironmentalPointKinStateVisualizer, makVrv::DtIntervisibilityEntityFanVisualizer, makVrv::Dt3DAreaStateVisualizer, makVrv::Dt2DTextBoxVisualizer, and makVrv::DtInteractionVisualizer.

virtual void makVrv::DtSceneObjectVisualizer::setSceneObjectAgent ( DtSceneObjectAgent *  )

virtual

virtual void makVrv::DtSceneObjectVisualizer::setElementID ( const DtElementID &  elementID )

virtual

DtElementID makVrv::DtSceneObjectVisualizer::elementID

(

)

const

virtual bool makVrv::DtSceneObjectVisualizer::show ( int  )

virtual

Override to show/hide scene object agent (if it exists)

Reimplemented from makVrv::DtStateVisualizer.

virtual bool makVrv::DtSceneObjectVisualizer::hide ( int  context )

virtual

Will call destroyModelAgents(), if, when the context is added, it is the first context in the list.

Will return true if model is hidden

Reimplemented from makVrv::DtStateVisualizer.

virtual DtSceneObjectAgent* makVrv::DtSceneObjectVisualizer::createObjectAgent ( )

protectedvirtual

Reimplemented in makVrv::DtInteractionKinStateVisualizer.

virtual void makVrv::DtSceneObjectVisualizer::createModelAgents ( )

protectedvirtual

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

Implements makVrv::DtStateVisualizer.

Reimplemented in makVrv::DtEnvironmentalVertexVisualizer, makVrv::DtEntityKinStateVisualizer, makVrv::Dt3DLineStateVisualizer, makVrv::Dt3DEllipseVisualizer, makVrv::DtIntervisibilityVertexVisualizer, makVrv::Dt2DEllipseVisualizer, makVrv::DtCylinderStateVisualizer, makVrv::DtIntervisibilityFanVisualizer, makVrv::Dt3DTextStateVisualizer, makVrv::DtAttributeGroupStateVisualizer, makVrv::DtEnvironmentalPointKinStateVisualizer, makVrv::DtEllipsoidStateVisualizer, makVrv::DtIntervisibilityEntityFanVisualizer, makVrv::DtCuboidStateVisualizer, makVrv::DtIntervisibilityLineVisualizer, makVrv::DtEnvironmentalLineVisualizer, makVrv::DtEnvironmentalAreaVisualizer, makVrv::Dt3DAreaStateVisualizer, makVrv::Dt2DTextBoxVisualizer, makVrf::VRF_PROTOCOL_NAMESPACE::DtVrfVrlink2DEnvironmentalAreaVisualizer, makVrv::Dt2DIntervisibilityEntityFanVisualizer, makVrv::Dt3DIntervisibilityEntityFanVisualizer, makVrv::DT_PROTOCOL_NAMESPACE::DtVrlinkAggregateKinStateVisualizer, makVrf::DtVrfGuiEnvironmentalPointKinStateVisualizer, makVrv::Dt2DIntervisibilityFanVisualizer, makVrv::DT_PROTOCOL_NAMESPACE::DtVrlinkEntityKinStateVisualizer, and makVrv::DtFireInteractionVisualizer.

virtual void makVrv::DtSceneObjectVisualizer::destroyModelAgents ( )

protectedvirtual

Model agent is only destroyed in destructor.

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

Implements makVrv::DtStateVisualizer.

Reimplemented in makVrv::DtEnvironmentalVertexVisualizer, makVrv::DtEntityKinStateVisualizer, makVrv::DtEnvironmentalLineVisualizer, makVrv::Dt3DLineStateVisualizer, makVrv::Dt3DEllipseVisualizer, makVrv::DtIntervisibilityVertexVisualizer, makVrv::Dt2DEllipseVisualizer, makVrv::DtEnvironmentalAreaVisualizer, makVrv::DtCylinderStateVisualizer, makVrv::Dt3DTextStateVisualizer, makVrv::DtAttributeGroupStateVisualizer, makVrv::DtIntervisibilityFanVisualizer, makVrv::DtIntervisibilityLineVisualizer, makVrv::DtEllipsoidStateVisualizer, makVrv::DtEnvironmentalPointKinStateVisualizer, makVrv::DtCuboidStateVisualizer, makVrv::DtIntervisibilityEntityFanVisualizer, makVrv::Dt3DAreaStateVisualizer, makVrv::Dt2DTextBoxVisualizer, makVrf::VRF_PROTOCOL_NAMESPACE::DtVrfVrlink2DEnvironmentalAreaVisualizer, makVrv::DtInteractionVisualizer, makVrv::Dt2DIntervisibilityFanVisualizer, makVrv::Dt2DIntervisibilityEntityFanVisualizer, makVrv::Dt3DIntervisibilityEntityFanVisualizer, makVrf::VRF_PROTOCOL_NAMESPACE::DtVrfVrlinkTacticalGraphicVertexVisualizer, makVrv::Dt3DIntervisibilityFanVisualizer, makVrv::DtInteractionKinStateVisualizer, and makVrf::DtVrf2DEnvironmentalAreaVisualizer.

Member Data Documentation

DtElementID makVrv::DtSceneObjectVisualizer::myElementID

protected

---

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

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