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::DtHATLineVisualizer Class Reference

Base class for height above terrain line visualizers to show height above terrain line and label. More...

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

Public Member Functions

 DtHATLineVisualizer (DtBaseConnection &simulation, DtStateListener &listener, int modelSet)
 CTOR. More...
 
virtual ~DtHATLineVisualizer ()
 DTOR. More...
 
virtual void setHatLineVisible (bool)
 Set the hat line visible or invisible. More...
 
virtual void setVisualDefinitionEnabled (bool)
 
virtual void setUniqueID (DtUniqueID)
 Set the scene object id of the line object visualizing this hat line. More...
 
virtual void setTextColor (float r, float g, float b, float a)
 
virtual void getTextColor (float &r, float &g, float &b, float &a) const
 
virtual void setTextBoxSize (unsigned int textWidth, unsigned int textHeight)
 
virtual void getTextBoxSize (unsigned int &textWidth, unsigned int &textHeight) const
 
virtual void setOriginOffset (int offsetX, int offsetY)
 
virtual void getOriginOffset (int &offsetX, int &offsetY) const
 
virtual void setHorizontalAlignment (unsigned int horizontalAlignment)
 
virtual unsigned int horizontalAlignment () const
 
virtual void setTextFont (const std::string &textFont)
 
virtual std::string textFont () const
 
virtual void setTextFontSize (unsigned int textFontSize)
 
virtual unsigned int textFontSize () const
 
virtual void setHatLinePeriod (unsigned int frames)
 Set / Get the period at which the hat line is updated. More...
 
virtual unsigned int hatLinePeriod () const
 
virtual void setUseHighestTerrainLod (bool trueOrFalse)
 Set / Get whether to use the height map when calculating elevations on streamed terrains (slower) More...
 
virtual bool useHighestTerrainLod () const
 
- 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 void setParent (DtStateVisualizer *)
 Override to set the parent of this visualizer. 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
 
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 createModelAgents ()
 Create the model agents for the line and text. More...
 
virtual void destroyModelAgents ()
 Destroy the model agents for the line and text. More...
 
virtual void setModelDefinitionForAgents ()
 Pass any model definition specified in the visual definition to the visualizer. More...
 
virtual void setVisualizerDefinition (const DtVisualizerDefinition &visDef)
 Set the visualizer definition which provides the parameters for this visualizer. 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 hide (int context)
 Will call destroyModelAgents(), if, when the context is added, it is the first context in the list. More...
 
virtual bool show (int context)
 Will call createModelAgents(), if, when context is removed from myShowHideContexts, the list size is zero. More...
 
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

Dt3DSegmentedLineModelAgent * myHatLineAgent
 
DtSceneObjectAgent * myHatLineObjectAgent
 
DtAttachableHatUpdaterAgent * myHatLineUpdaterAgent
 
DtSceneObjectAgent * myHatTextObjectAgent
 
DtProjectedWidgetModelAgent * myHatTextModelAgent
 
DtWidgetLabelAgent * myHatTextWidgetAgent
 
DtAttachableHatTextUpdaterAgent * myHatTextUpdaterAgent
 
bool myHatLineEnabled
 
bool myVisualDefinitionEnabled
 
bool myUseHighestTerrainLod
 
double myTextPosition
 
unsigned int myTextBoxSize [2]
 
unsigned int myTextHorizontalAlignment
 
std::string myTextFont
 
unsigned int myTextFontSize
 
float myTextColor [4]
 
int myOriginOffset [2]
 
unsigned int myHatLinePeriod
 
- 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

Base class for height above terrain line visualizers to show height above terrain line and label.

Constructor & Destructor Documentation

makVrv::DtHATLineVisualizer::DtHATLineVisualizer ( DtBaseConnection simulation,
DtStateListener listener,
int  modelSet 
)

CTOR.

virtual makVrv::DtHATLineVisualizer::~DtHATLineVisualizer ( )
virtual

DTOR.

Member Function Documentation

virtual void makVrv::DtHATLineVisualizer::setHatLineVisible ( bool  )
virtual

Set the hat line visible or invisible.

Reimplemented in makVrv::DT_PROTOCOL_NAMESPACE::DtVrlinkEntityHATLineVisualizer.

virtual void makVrv::DtHATLineVisualizer::setVisualDefinitionEnabled ( bool  )
virtual
virtual void makVrv::DtHATLineVisualizer::setUniqueID ( DtUniqueID  )
virtual

Set the scene object id of the line object visualizing this hat line.

Reimplemented from makVrv::DtStateVisualizer.

virtual void makVrv::DtHATLineVisualizer::setTextColor ( float  r,
float  g,
float  b,
float  a 
)
virtual
virtual void makVrv::DtHATLineVisualizer::getTextColor ( float &  r,
float &  g,
float &  b,
float &  a 
) const
virtual
virtual void makVrv::DtHATLineVisualizer::setTextBoxSize ( unsigned int  textWidth,
unsigned int  textHeight 
)
virtual
virtual void makVrv::DtHATLineVisualizer::getTextBoxSize ( unsigned int textWidth,
unsigned int textHeight 
) const
virtual
virtual void makVrv::DtHATLineVisualizer::setOriginOffset ( int  offsetX,
int  offsetY 
)
virtual
virtual void makVrv::DtHATLineVisualizer::getOriginOffset ( int offsetX,
int offsetY 
) const
virtual
virtual void makVrv::DtHATLineVisualizer::setHorizontalAlignment ( unsigned int  horizontalAlignment)
virtual
virtual unsigned int makVrv::DtHATLineVisualizer::horizontalAlignment ( ) const
virtual
virtual void makVrv::DtHATLineVisualizer::setTextFont ( const std::string &  textFont)
virtual
virtual std::string makVrv::DtHATLineVisualizer::textFont ( ) const
virtual
virtual void makVrv::DtHATLineVisualizer::setTextFontSize ( unsigned int  textFontSize)
virtual
virtual unsigned int makVrv::DtHATLineVisualizer::textFontSize ( ) const
virtual
virtual void makVrv::DtHATLineVisualizer::setHatLinePeriod ( unsigned int  frames)
virtual

Set / Get the period at which the hat line is updated.

virtual unsigned int makVrv::DtHATLineVisualizer::hatLinePeriod ( ) const
virtual
virtual void makVrv::DtHATLineVisualizer::setUseHighestTerrainLod ( bool  trueOrFalse)
virtual

Set / Get whether to use the height map when calculating elevations on streamed terrains (slower)

virtual bool makVrv::DtHATLineVisualizer::useHighestTerrainLod ( ) const
virtual
virtual void makVrv::DtHATLineVisualizer::createModelAgents ( )
protectedvirtual

Create the model agents for the line and text.

Implements makVrv::DtStateVisualizer.

Reimplemented in makVrv::DtEnvironmentalHATLineVisualizer.

virtual void makVrv::DtHATLineVisualizer::destroyModelAgents ( )
protectedvirtual

Destroy the model agents for the line and text.

Implements makVrv::DtStateVisualizer.

virtual void makVrv::DtHATLineVisualizer::setModelDefinitionForAgents ( )
protectedvirtual

Pass any model definition specified in the visual definition to the visualizer.

Implements makVrv::DtStateVisualizer.

virtual void makVrv::DtHATLineVisualizer::setVisualizerDefinition ( const DtVisualizerDefinition visDef)
protectedvirtual

Set the visualizer definition which provides the parameters for this visualizer.

Reimplemented from makVrv::DtStateVisualizer.

Member Data Documentation

Dt3DSegmentedLineModelAgent* makVrv::DtHATLineVisualizer::myHatLineAgent
protected
DtSceneObjectAgent* makVrv::DtHATLineVisualizer::myHatLineObjectAgent
protected
DtAttachableHatUpdaterAgent* makVrv::DtHATLineVisualizer::myHatLineUpdaterAgent
protected
DtSceneObjectAgent* makVrv::DtHATLineVisualizer::myHatTextObjectAgent
protected
DtProjectedWidgetModelAgent* makVrv::DtHATLineVisualizer::myHatTextModelAgent
protected
DtWidgetLabelAgent* makVrv::DtHATLineVisualizer::myHatTextWidgetAgent
protected
DtAttachableHatTextUpdaterAgent* makVrv::DtHATLineVisualizer::myHatTextUpdaterAgent
protected
bool makVrv::DtHATLineVisualizer::myHatLineEnabled
protected
bool makVrv::DtHATLineVisualizer::myVisualDefinitionEnabled
protected
bool makVrv::DtHATLineVisualizer::myUseHighestTerrainLod
protected
double makVrv::DtHATLineVisualizer::myTextPosition
protected
unsigned int makVrv::DtHATLineVisualizer::myTextBoxSize[2]
protected
unsigned int makVrv::DtHATLineVisualizer::myTextHorizontalAlignment
protected
std::string makVrv::DtHATLineVisualizer::myTextFont
protected
unsigned int makVrv::DtHATLineVisualizer::myTextFontSize
protected
float makVrv::DtHATLineVisualizer::myTextColor[4]
protected
int makVrv::DtHATLineVisualizer::myOriginOffset[2]
protected
unsigned int makVrv::DtHATLineVisualizer::myHatLinePeriod
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)