VR-Forces 4.10 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::DtLaserDesignatorVisualizer Class Referenceabstract

DtLaserDesignatorVisualizer is the base class shared by Dt2DLaserDesignatorVisualizer and Dt3DLaserDesignatorVisualizer. More...

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

Public Member Functions

 DtLaserDesignatorVisualizer (DtBaseConnection &simulation, DtStateListener &listener, int modelSet)
 CTOR; expects DtStateListener to be a DtLaserDesignatorStateListener. More...
 
virtual ~DtLaserDesignatorVisualizer ()
 
virtual void setParent (DtStateVisualizer *)
 No-op. More...
 
virtual void createModelAgents ()
 Create the agents for the spot and designator text. More...
 
virtual void destroyModelAgents ()
 Destroy the agents. More...
 
virtual void setVisualizerDefinition (const DtVisualizerDefinition &)
 Set the designator's visual definition. More...
 
virtual void setModelDefinitionForAgents ()
 No-op. More...
 
virtual void setDesignatorId (DtUniqueID id)
 Set/get the id of the designating entity. More...
 
virtual DtUniqueID designatorId () const
 
virtual void setDesignatorLocation (const DtVector &loc)
 Set/get the intended location of the designator spot. More...
 
virtual const DtVectordesignatorLocation () const
 
virtual void setDesignatorCode (int code)
 Set/get the designator code (displayed as text) More...
 
virtual int designatorCode () const
 
virtual void setPower (DtFloat32 power)
 Set/get the designator power; designator is not shown if power == 0. More...
 
virtual float power () const
 
virtual void setDesignatedObject (DtUniqueID designee)
 Set/get the designated object; if (DtUniqueID)0, designatorLocation is used. More...
 
virtual DtUniqueID designatedObject () const
 
virtual void setFont (const std::string &font)
 Set/get the font of designator code text. More...
 
virtual const std::string & font () const
 
virtual void setFontSize (float fontSize)
 Set/get the font size of designator code text. More...
 
virtual float fontSize () const
 
virtual void setFontColor (float r, float g, float b, float a)
 Set/get the color of designator code text; values from 0. to 1. More...
 
virtual void getFontColor (float &r, float &g, float &b, float &a) const
 
- 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;. More...
 
virtual DtSceneObjectAgent * sceneObjectAgent ()
 
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 DtObserverMode::ModelSets modelSet ()
 Return the visualizer's model set enum. More...
 
virtual const TypeInfotypeInfo () const =0
 Get the type info. More...
 
virtual const DtStateVisualizerparent () const
 Get a const pointer to the parent visualizer of this visualizer. 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 setHasMouseCursor (bool)
 Sets the mouse hover state. More...
 
virtual bool hasMouseCursor () const
 
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...
 
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 void createDesignatorSpot ()=0
 Work function for designator spot creation. More...
 
virtual void createDesignatorText ()
 Work function for designator text creation. More...
 
virtual void createUpdater ()
 Work function for designator updater creation. More...
 
- 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. 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::signalslib::signal< void(T)> &sig, void(C::*fp)(T), T val)
 Connect a signal and update the entity. More...
 

Protected Attributes

DtUniqueID myDesignatorId
 
int myDesignatorCode
 
DtVector myDesignatorSpotLocation
 
float myPower
 
DtUniqueID myDesignatedObject
 
std::string myFont
 
float myFontSize
 
float myFontColor [4]
 
DtProjectedWidgetModelAgent * myTextModelAgent
 
DtWidgetLabelAgent * myTextAgent
 
DtLaserDesignatorUpdaterAgent * myUpdater
 
- Protected Attributes inherited from makVrv::DtSceneObjectVisualizer
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 myHasMouseCursor
 
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::signalslib::signal
< void(DtStateVisualizer
*, DtStateVisualizer
*, DtStateVisualizer *)> 
signal_reparented
 Signaled when the parent of this item changes, called before destroying any model agents. More...
 
boost::signalslib::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::signalslib::signal
< void(DtMouseState &, const
DtUniqueID &, const
std::string &, const
std::string &, const
std::string
&, DtStateVisualizer *)> 
signal_mouseUp
 
boost::signalslib::signal
< void(DtMouseState &, const
DtUniqueID &, const
std::string &, const
std::string &, const
std::string
&, DtStateVisualizer *)> 
signal_mouseDblClick
 

Detailed Description

DtLaserDesignatorVisualizer is the base class shared by Dt2DLaserDesignatorVisualizer and Dt3DLaserDesignatorVisualizer.

It creates the designator code text object and manages all signals. Dt2DLaserDesignatorVisualizer and Dt3DLaserDesignatorVisualizer are responsible for implementing createDesignatorSpot(), as either a 2D or 3D object

Constructor & Destructor Documentation

makVrv::DtLaserDesignatorVisualizer::DtLaserDesignatorVisualizer ( DtBaseConnection simulation,
DtStateListener listener,
int  modelSet 
)
virtual makVrv::DtLaserDesignatorVisualizer::~DtLaserDesignatorVisualizer ( )
virtual

Member Function Documentation

virtual void makVrv::DtLaserDesignatorVisualizer::setParent ( DtStateVisualizer )
virtual

No-op.

Reimplemented from makVrv::DtSceneObjectVisualizer.

virtual void makVrv::DtLaserDesignatorVisualizer::createModelAgents ( )
virtual

Create the agents for the spot and designator text.

Reimplemented from makVrv::DtSceneObjectVisualizer.

virtual void makVrv::DtLaserDesignatorVisualizer::destroyModelAgents ( )
virtual
virtual void makVrv::DtLaserDesignatorVisualizer::setVisualizerDefinition ( const DtVisualizerDefinition )
virtual

Set the designator's visual definition.

Reimplemented from makVrv::DtStateVisualizer.

Reimplemented in makVrv::Dt2DLaserDesignatorVisualizer, and makVrv::Dt3DLaserDesignatorVisualizer.

virtual void makVrv::DtLaserDesignatorVisualizer::setModelDefinitionForAgents ( )
virtual

No-op.

Reimplemented from makVrv::DtSceneObjectVisualizer.

virtual void makVrv::DtLaserDesignatorVisualizer::setDesignatorId ( DtUniqueID  id)
virtual

Set/get the id of the designating entity.

virtual DtUniqueID makVrv::DtLaserDesignatorVisualizer::designatorId ( ) const
virtual
virtual void makVrv::DtLaserDesignatorVisualizer::setDesignatorLocation ( const DtVector loc)
virtual

Set/get the intended location of the designator spot.

virtual const DtVector& makVrv::DtLaserDesignatorVisualizer::designatorLocation ( ) const
virtual
virtual void makVrv::DtLaserDesignatorVisualizer::setDesignatorCode ( int  code)
virtual

Set/get the designator code (displayed as text)

virtual int makVrv::DtLaserDesignatorVisualizer::designatorCode ( ) const
virtual
virtual void makVrv::DtLaserDesignatorVisualizer::setPower ( DtFloat32  power)
virtual

Set/get the designator power; designator is not shown if power == 0.

virtual float makVrv::DtLaserDesignatorVisualizer::power ( ) const
virtual
virtual void makVrv::DtLaserDesignatorVisualizer::setDesignatedObject ( DtUniqueID  designee)
virtual

Set/get the designated object; if (DtUniqueID)0, designatorLocation is used.

virtual DtUniqueID makVrv::DtLaserDesignatorVisualizer::designatedObject ( ) const
virtual
virtual void makVrv::DtLaserDesignatorVisualizer::setFont ( const std::string &  font)
virtual

Set/get the font of designator code text.

virtual const std::string& makVrv::DtLaserDesignatorVisualizer::font ( ) const
virtual
virtual void makVrv::DtLaserDesignatorVisualizer::setFontSize ( float  fontSize)
virtual

Set/get the font size of designator code text.

virtual float makVrv::DtLaserDesignatorVisualizer::fontSize ( ) const
virtual
virtual void makVrv::DtLaserDesignatorVisualizer::setFontColor ( float  r,
float  g,
float  b,
float  a 
)
virtual

Set/get the color of designator code text; values from 0. to 1.

virtual void makVrv::DtLaserDesignatorVisualizer::getFontColor ( float &  r,
float &  g,
float &  b,
float &  a 
) const
virtual
virtual void makVrv::DtLaserDesignatorVisualizer::createDesignatorSpot ( )
protectedpure virtual

Work function for designator spot creation.

Implemented in makVrv::Dt2DLaserDesignatorVisualizer, and makVrv::Dt3DLaserDesignatorVisualizer.

virtual void makVrv::DtLaserDesignatorVisualizer::createDesignatorText ( )
protectedvirtual

Work function for designator text creation.

virtual void makVrv::DtLaserDesignatorVisualizer::createUpdater ( )
protectedvirtual

Work function for designator updater creation.

Member Data Documentation

DtUniqueID makVrv::DtLaserDesignatorVisualizer::myDesignatorId
protected
int makVrv::DtLaserDesignatorVisualizer::myDesignatorCode
protected
DtVector makVrv::DtLaserDesignatorVisualizer::myDesignatorSpotLocation
protected
float makVrv::DtLaserDesignatorVisualizer::myPower
protected
DtUniqueID makVrv::DtLaserDesignatorVisualizer::myDesignatedObject
protected
std::string makVrv::DtLaserDesignatorVisualizer::myFont
protected
float makVrv::DtLaserDesignatorVisualizer::myFontSize
protected
float makVrv::DtLaserDesignatorVisualizer::myFontColor[4]
protected
DtProjectedWidgetModelAgent* makVrv::DtLaserDesignatorVisualizer::myTextModelAgent
protected
DtWidgetLabelAgent* makVrv::DtLaserDesignatorVisualizer::myTextAgent
protected
DtLaserDesignatorUpdaterAgent* makVrv::DtLaserDesignatorVisualizer::myUpdater
protected

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

Document ID: Generated on Tue Sep 21 17:42:52 EDT 2021 from SVN revision 234861
Copyright © 2005-2021 MAK Technologies. All Rights Reserved (www.mak.com)