VR-Forces 4.8 Class Documentation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | Public Member Functions | Protected Member Functions | Protected Attributes
makVrv::DtSceneObjectVisualizer Class Reference

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

Inheritance diagram for makVrv::DtSceneObjectVisualizer:
Inheritance graph
[legend]

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;. More...
 
virtual DtSceneObjectAgent * sceneObjectAgent ()
 
virtual void setParent (DtStateVisualizer *p)
 Override of base class setParent to simply set the parent without destroying/recreating model agents. More...
 
virtual void setModelDefinitionForAgents ()
 Sets model definition for all the agents that this visualizer might be using. More...
 
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) More...
 
virtual bool hide (int)
 Will call destroyModelAgents(), if, when the context is added, it is the first context in the list. More...
 
- Public Member Functions inherited from makVrv::DtStateVisualizer
 DtStateVisualizer (DtBaseConnection &connection, DtStateListener &listener, int modelSet)
 CTOR. More...
 
virtual ~DtStateVisualizer ()
 DTOR. More...
 
virtual const TypeInfotypeInfo () const =0
 Get the type info. More...
 
void setModelDefinition (const std::string &definition)
 Sets the model definition and creates agent(s) based on that definition. More...
 
const std::string & modelDefinition () const
 Gets the current model definition. More...
 
virtual void implementVisibility (bool visible)
 Wrap some of the show/hide functionality so that it can be overloaded (ex. More...
 
virtual bool setVisible (bool visible, int context)
 Returns true if this context wants to show or hide the item. More...
 
virtual void initialize ()
 Initialize the visualizer. More...
 
virtual bool isVisible () const
 Returns true if visible. More...
 
virtual void setSelected (bool)
 Sets selected state. More...
 
virtual bool selected () const
 
void setName (const std::string &)
 Internal name of state visualizer. More...
 
const std::string & name () const
 
virtual void setPickable (bool)
 Sets pickable state. More...
 
virtual bool pickable () const
 
virtual void setUniqueID (DtUniqueID id)
 
DtUniqueID uniqueID () const
 
int visualizerType () const
 
void setShowHideContext (const std::vector< int > &s)
 Set show/hide context without changing visibility of item. More...
 
virtual void setVisualizerDefinition (const DtVisualizerDefinition &)
 Set any other additional visualizer information from the visual record. More...
 
DtStateListenerlistener ()
 
DtBaseConnectionsimulation ()
 Get the connection for this visualizer. More...
 
void setDistribute (bool b)
 Whether or not to distribute over the network. More...
 
bool distribute () const
 

Protected Member Functions

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

Protected Attributes

DtElementID myElementID
 
- Protected Attributes inherited from makVrv::DtStateVisualizer
DtBaseConnectionmySimulation
 
DtStateListenermyListener
 
bool myDistributeFlag
 
DtUniqueID myUniqueID
 
std::string myName
 
std::string myModelDefinition
 
DtSignalConnectionManager myConnections
 
int myModelSet
 
int myVisualizerType
 
std::vector< intmyShowHideContexts
 
bool mySelected
 
bool myPickable
 
bool myVisible
 
DtStateVisualizermyParent
 
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. More...
 
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. More...
 
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 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.

Reimplemented in makVrv::DtLaserDesignatorVisualizer.

virtual void makVrv::DtSceneObjectVisualizer::setModelDefinitionForAgents ( )
virtual
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
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, makVrf::DtVrfEnvironmentalVertexVisualizer, makVrv::DtWedgeVisualizer, makVrv::DtSpiderWebVisualizer, makVrv::DtArcVisualizer, makVrv::DtEllipseVisualizer, makVrv::Dt3DLineStateVisualizer, makVrv::DtEnvironmentalPointKinStateVisualizer, makVrv::DtIntervisibilityVertexVisualizer, makVrv::DtCylinderStateVisualizer, makVrv::DtEnvironmentalVolumetricLineVisualizer, makVrv::DtIntervisibilityFanVisualizer, makVrv::Dt3DTextStateVisualizer, makVrv::DtAttributeGroupStateVisualizer, makVrv::DtEllipsoidStateVisualizer, makVrv::DtIntervisibilityEntityFanVisualizer, makVrv::DtIntervisibilityLineVisualizer, makVrv::DtCuboidStateVisualizer, makVrv::DtEnvironmentalLineVisualizer, makVrv::DtEnvironmentalAreaVisualizer, makVrv::Dt3DAreaStateVisualizer, makVrv::Dt2DTextBoxVisualizer, makVrf::VRF_PROTOCOL_NAMESPACE::DtVrfVrlinkTacticalGraphicVertexVisualizer, makVrf::VRF_PROTOCOL_NAMESPACE::DtVrfVrlink2DEnvironmentalAreaVisualizer, makVrf::Dt2DIntervisibilitySensorFanVisualizer, makVrv::Dt2DIntervisibilityEntityFanVisualizer, makVrv::Dt3DIntervisibilityEntityFanVisualizer, makVrv::DT_PROTOCOL_NAMESPACE::DtVrlinkAggregateKinStateVisualizer, makVrv::DT_PROTOCOL_NAMESPACE::DtVrlinkEntityKinStateVisualizer, makVrv::DtLaserDesignatorVisualizer, makVrf::Dt3DIntervisibilitySensorFanVisualizer, makVrf::DtRangeLineVertexVisualizer, makVrv::Dt2DIntervisibilityFanVisualizer, makVrf::DtVrfGuiEnvironmentalPointKinStateVisualizer, makVrf::Dt2DRangeLineVisualizer, makVrv::DtFireInteractionVisualizer, and makVrf::DtIntervisibilitySensorFanVisualizer.

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::DtWedgeVisualizer, makVrv::DtEnvironmentalVolumetricLineVisualizer, makVrv::DtSpiderWebVisualizer, makVrv::DtArcVisualizer, makVrv::Dt3DLineStateVisualizer, makVrv::DtEllipseVisualizer, makVrv::DtEnvironmentalAreaVisualizer, makVrv::DtEnvironmentalPointKinStateVisualizer, makVrv::DtIntervisibilityVertexVisualizer, makVrv::DtCylinderStateVisualizer, makVrv::Dt3DTextStateVisualizer, makVrv::DtAttributeGroupStateVisualizer, makVrv::DtIntervisibilityFanVisualizer, makVrv::DtIntervisibilityLineVisualizer, makVrv::DtEllipsoidStateVisualizer, makVrv::DtIntervisibilityEntityFanVisualizer, makVrv::DtCuboidStateVisualizer, makVrv::Dt3DAreaStateVisualizer, makVrf::Dt2DIntervisibilitySensorFanVisualizer, makVrv::Dt2DTextBoxVisualizer, makVrf::Dt3DIntervisibilitySensorFanVisualizer, makVrf::VRF_PROTOCOL_NAMESPACE::DtVrfVrlink2DEnvironmentalAreaVisualizer, makVrv::Dt3DEnvironmentalVolumetricLineVisualizer, makVrv::DtInteractionVisualizer, makVrf::VRF_PROTOCOL_NAMESPACE::DtVrfVrlinkTacticalGraphicVertexVisualizer, makVrv::Dt2DIntervisibilityFanVisualizer, makVrv::Dt2DIntervisibilityEntityFanVisualizer, makVrv::Dt3DIntervisibilityEntityFanVisualizer, makVrv::Dt3DIntervisibilityFanVisualizer, makVrv::DtLaserDesignatorVisualizer, makVrv::DtInteractionKinStateVisualizer, makVrf::DtVrf2DEllipseVisualizer, makVrf::DtVrf2DEnvironmentalAreaVisualizer, makVrv::Dt2DLaserDesignatorVisualizer, and makVrv::Dt3DLaserDesignatorVisualizer.

Member Data Documentation

DtElementID makVrv::DtSceneObjectVisualizer::myElementID
protected

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

Document ID: Generated on Thu Aug 27 10:56:05 EDT 2020 from SVN revision 217100
Copyright © 2005-2020 MAK Technologies. All Rights Reserved (www.mak.com)