VR-Forces 5.0.2 Developer's Guide
 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
vrvCoreQt

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

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

Public Member Functions

 DtHATLineVisualizer (DtBaseConnection &simulation, DtStateListener &listener, int modelSet)
 
 DtHATLineVisualizer (DtBaseConnection &simulation, DtStateListener &listener, DtSceneObjectAgent *sceneObject, int modelSet)
 
virtual ~DtHATLineVisualizer ()
 
 DtHATLineVisualizer ()=delete
 
 DtHATLineVisualizer (const DtHATLineVisualizer &)=delete
 
DtHATLineVisualizer & operator= (const DtHATLineVisualizer &)=delete
 
virtual void initialize () override
 
virtual void setVisualDefinitionEnabled (bool)
 
virtual void setSceneObjectID (DtUniqueID) override
 
virtual void setIsPinned (bool myPinned)
 
virtual void setIsAltitudeBasedScalingEnabled (bool isAltitudeBasedScalingEnabled)
 
virtual void setAltitudeBasedConfigurations (const makArchives::DtDynamicScaleConfigurationCollection &collection)
 
virtual void slot_setSelected (bool b) override
 
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 setTextFontScale (float textFontScale)
 
virtual float textFontScale () const
 
virtual void setHatLinePeriod (unsigned int frames)
 
virtual unsigned int hatLinePeriod () const
 
virtual void setUseHighestTerrainLod (bool trueOrFalse)
 
virtual bool useHighestTerrainLod () const
 
virtual void setLodOutAltitude (double lodOutAltitude)
 
virtual double lodOutAltitude () const
 
virtual void setHasMouseCursor (bool)
 
virtual bool hasMouseCursor () const
 
- Public Member Functions inherited from makVrv::DtStateVisualizer
 DtStateVisualizer (DtBaseConnection &connection, DtStateListener &listener, int modelSet)
 
 DtStateVisualizer (DtBaseConnection &connection, DtStateListener &listener, DtSceneObjectAgent *sceneObjectAgent, int modelSet)
 
virtual ~DtStateVisualizer ()
 
virtual DtObserverMode::ModelSets modelSet ()
 
virtual const TypeInfo & typeInfo () const =0
 
virtual void setParent (DtStateVisualizer *)
 
virtual void setSceneObjectAgent (DtSceneObjectAgent *sceneObject)
 
virtual const DtStateVisualizer * parent () const
 
void setModelDefinition (const std::string &definition)
 
const std::string & modelDefinition () const
 
virtual void implementVisibility (bool visible)
 
void setName (const std::string &)
 
const std::string & name () const
 
virtual void setPickable (bool)
 
virtual bool pickable () const
 
virtual DtUniqueID sceneObjectID () const
 
int visualizerType () const
 
virtual void setVisualizerDefinition (const DtVisualizerDefinition &)
 
DtStateListener & listener ()
 
const DtStateListener & listener () const
 
DtBaseConnection & simulation ()
 
void setDistribute (bool b)
 
bool distribute () const
 
virtual bool setVisualizerIsVisible (bool vis, DtVisualizerShowHideContext::VisualizerShowHideContext context)
 

Protected Member Functions

virtual DtObjectTypeStateListener & objectTypeStateListener ()
 
virtual void createModelAgents () override
 
virtual void destroyModelAgents () override
 
virtual void updateAltitudeBasedScalingProperties ()
 
virtual void updateForcedAltitudeBasedConfigurationEnabledState ()
 
virtual void updateLodOutAltitudeProperties ()
 
virtual void updateIsLodOutAltitudeEnabledState ()
 
virtual void setModelDefinitionForAgents () override
 
virtual void connectToListenerSignals () override
 
virtual void setInitialValuesFromVisualizerDefinition () override
 
- Protected Member Functions inherited from makVrv::DtStateVisualizer
virtual void makeVisible ()
 
virtual bool isVisible () const
 
template<typename T , typename C >
void connectAndUpdate (boost::signalslib::signal< void(T)> &sig, void(C::*fp)(T), T val)
 

Protected Attributes

DtObjectTypeStateListener * myObjectTypeStateListener
 
Dt3DSegmentedLineModelAgent * myHatLineAgent
 
DtSceneObjectAgent * myHatLineObjectAgent
 
DtAttachableHatUpdaterAgent * myHatLineUpdaterAgent
 
DtSceneObjectAgent * myHatTextObjectAgent
 
DtProjectedWidgetModelAgent * myHatTextModelAgent
 
DtWidgetLabelAgent * myHatTextWidgetAgent
 
DtAttachableHatTextUpdaterAgent * myHatTextUpdaterAgent
 
bool myHasMouseCursor
 
bool myPinnedFlag
 
bool myLODOutAltitudeEnabled
 
double myLodOutAltitude
 
bool myLodOutAltitudeOverridden
 
bool myIsAltitudeBasedScalingEnabled
 
float myTextFontScale
 
makArchives::DtDynamicScaleConfigurationCollection myTextFontScalesByMinimumAltitude
 
bool myVisualDefinitionEnabled
 
bool myUseHighestTerrainLod
 
double myTextPosition
 
unsigned int myTextBoxSize [2]
 
unsigned int myTextHorizontalAlignment
 
std::string myTextFont
 
std::string myDisplayUnitCollectionName
 
unsigned int myTextFontSize
 
float myTextColor [4]
 
int myOriginOffset [2]
 
unsigned int myHatLinePeriod
 
- Protected Attributes inherited from makVrv::DtStateVisualizer
DtBaseConnection & mySimulation
 
DtStateListener & myListener
 
bool myDistributeFlag
 
DtUniqueID mySceneObjectID
 
std::string myName
 
std::string myModelDefinition
 
DtSignalConnectionManager myConnections
 
int myModelSet
 
int myVisualizerType
 
bool myPickable
 
bool myVisible
 
const DtVisualizerDefinition * myVisualizerDefinition
 
DtStateVisualizer * myParent
 
DtSceneObjectAgent * mySceneObjectAgent
 
bool myInitialInitializeDone
 
ShowHideContextVector myVisualizerShowHideContexts
 

Additional Inherited Members

- Public Types inherited from makVrv::DtStateVisualizer
enum  Type {
  AllVisualizerTypes = 0, EntityVisualizerType = 1, EnvironmentalVisualizerType, InteractionVisualizerType,
  AggregateVisualizerType, IntervisibilityVisualizerType, TacticalSmokeVisualizerType, UserType = 10000
}
 
- Public Attributes inherited from makVrv::DtStateVisualizer
boost::signalslib::signal
< void(DtStateVisualizer
*, DtStateVisualizer
*, DtStateVisualizer *)> 		signal_reparented
 
- Protected Types inherited from makVrv::DtStateVisualizer
typedef std::vector
< DtVisualizerShowHideContext::VisualizerShowHideContext > 		ShowHideContextVector
 

Constructor & Destructor Documentation

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

CTOR.

makVrv::DtHATLineVisualizer::DtHATLineVisualizer ( DtBaseConnection &  simulation,
DtStateListener &  listener,
DtSceneObjectAgent *  sceneObject,
int  modelSet 
)

CTOR.

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

DTOR.

makVrv::DtHATLineVisualizer::DtHATLineVisualizer ( )
delete

not allowed - default constructor

makVrv::DtHATLineVisualizer::DtHATLineVisualizer ( const DtHATLineVisualizer &  )
delete

not allowed - copy constructor

Member Function Documentation

DtHATLineVisualizer& makVrv::DtHATLineVisualizer::operator= ( const DtHATLineVisualizer &  )
delete

not allowed - equals operator

virtual void makVrv::DtHATLineVisualizer::initialize ( )
overridevirtual

called soon after construction to initialize the signals/state from the listener

Reimplemented from makVrv::DtStateVisualizer.

Reimplemented in makVrv::DtEnvironmentalHATLineVisualizer, and makVrv::DtEntityHATLineVisualizer.

virtual void makVrv::DtHATLineVisualizer::setVisualDefinitionEnabled ( bool  )
virtual
virtual void makVrv::DtHATLineVisualizer::setSceneObjectID ( DtUniqueID  )
overridevirtual

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::setTextFontScale ( float  textFontScale)
virtual
virtual float makVrv::DtHATLineVisualizer::textFontScale ( ) 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

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

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

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

virtual void makVrv::DtHATLineVisualizer::setLodOutAltitude ( double  lodOutAltitude)
virtual

Set / Get the minimum altitude, in meters, at which all HAT informational text will no longer appear. Default is 500000 meters. This functionality is not used by default and can be enabled by setting lodoutaltitudeenabled to true in the visual definition that this visualizer was created from. This functionality is designed to be used in the 2D projection.

virtual double makVrv::DtHATLineVisualizer::lodOutAltitude ( ) const
virtual

Set / Get the minimum altitude, in meters, at which all HAT informational text will no longer appear. Default is 500000 meters. This functionality is not used by default and can be enabled by setting lodoutaltitudeenabled to true in the visual definition that this visualizer was created from. This functionality is designed to be used in the 2D projection.

virtual void makVrv::DtHATLineVisualizer::setIsPinned ( bool  myPinned)
virtual

Set whether or not all symbol decorations managed by this visualizer are pinned or not. A pinned symbol decoration will always appear regardless of LOD Out Altitude.

See Also
setLodOutAltitude
virtual void makVrv::DtHATLineVisualizer::setIsAltitudeBasedScalingEnabled ( bool  isAltitudeBasedScalingEnabled)
virtual

Set whether or not altitude-based scaling will be used. If altitude-based scaling is used, then the HAT informational text will be visualized with varying font sizes based on the altitude of the camera rendering the text. This functionality is not used by default and can be enabled by setting dynamicscalingenabled to true in the visual definition that this visualizer was created from. This functionality is designed to be used in the 2D projection.

virtual void makVrv::DtHATLineVisualizer::setAltitudeBasedConfigurations ( const makArchives::DtDynamicScaleConfigurationCollection &  collection)
virtual

Set the altitude-based scale values to use for this visualizer. Altitude-based scale values are used to scale HAT informational text based on the altitude of the camera rendering the text.

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

Set / Get the mouse hover state.

virtual bool makVrv::DtHATLineVisualizer::hasMouseCursor ( ) const
virtual

Set / Get the mouse hover state.

virtual void makVrv::DtHATLineVisualizer::slot_setSelected ( bool  b)
overridevirtual

Sets whether this visualizer's entity is selected or not. Connected to DtStateListener's signal_objectSelectionChanged signal.

Reimplemented from makVrv::DtStateVisualizer.

Reimplemented in makVrv::DtEntityHATLineVisualizer, and makVrv::DtEnvironmentalHATLineVisualizer.

virtual DtObjectTypeStateListener& makVrv::DtHATLineVisualizer::objectTypeStateListener ( )
protectedvirtual
virtual void makVrv::DtHATLineVisualizer::createModelAgents ( )
overrideprotectedvirtual

Create the model agents for the line and text.

Implements makVrv::DtStateVisualizer.

Reimplemented in makVrv::DtEnvironmentalHATLineVisualizer, and makVrv::DtEntityHATLineVisualizer.

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

Destroy the model agents for the line and text.

Implements makVrv::DtStateVisualizer.

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

Set/Clear the altitude-based configurations of the heading line indicator based on the whether fixed scaling is enabled.

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

Force a particular altitude-based configuration for the heading line indicator based on mouse hover and selection state.

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

Updates the LOD Out Altitude property of all symbol decorations.

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

Updates the LOD Out Altitude property of all symbol decorations.

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

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

Implements makVrv::DtStateVisualizer.

virtual void makVrv::DtHATLineVisualizer::connectToListenerSignals ( )
overrideprotectedvirtual

Connect the visualizer to the listeners signals Called by DtStateVisualizer::initialize()

Reimplemented from makVrv::DtStateVisualizer.

Reimplemented in makVrv::DtEnvironmentalHATLineVisualizer, and makVrv::DtEntityHATLineVisualizer.

virtual void makVrv::DtHATLineVisualizer::setInitialValuesFromVisualizerDefinition ( )
overrideprotectedvirtual

Sets member variables from the visualizer definition if they exist Should not call this directly. Called by DtStateVisualizer::initialize.

Reimplemented from makVrv::DtStateVisualizer.

Member Data Documentation

DtObjectTypeStateListener* makVrv::DtHATLineVisualizer::myObjectTypeStateListener
protected
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::myHasMouseCursor
protected
bool makVrv::DtHATLineVisualizer::myPinnedFlag
protected

whether or not the widget this visualizer controls is pinned

bool makVrv::DtHATLineVisualizer::myLODOutAltitudeEnabled
protected

Whether or not this visualizer will lod out based on altitude.

double makVrv::DtHATLineVisualizer::myLodOutAltitude
protected

The altitude at which all HAT information will no longer appear The default value is 100000 meters. Only used if myLODAltitudeEnabled is true.

bool makVrv::DtHATLineVisualizer::myLodOutAltitudeOverridden
protected

Whether or not the lod out altitude is overridden. If overridden, the lod out altitude from the visualizer's state listener is ignored. Only used if myLODAltitudeEnabled is true.

bool makVrv::DtHATLineVisualizer::myIsAltitudeBasedScalingEnabled
protected

Whether or not to use altitude-based scaling is used.

float makVrv::DtHATLineVisualizer::myTextFontScale
protected
makArchives::DtDynamicScaleConfigurationCollection makVrv::DtHATLineVisualizer::myTextFontScalesByMinimumAltitude
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
std::string makVrv::DtHATLineVisualizer::myDisplayUnitCollectionName
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 Sun Dec 4 20:22:03 EST 2022 from SVN revision 249613
Copyright © 2005-2021 MAK Technologies. All Rights Reserved (www.mak.com)