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::DtMilStdIconVisualizer Class Reference
vrvCore

A visualizer for displaying a Military Standard Symbology Icon. A symbology icon is made up of several different components. Included are: A frame, a color fill, and a icon.

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

Public Member Functions

 DtMilStdIconVisualizer (DtBaseConnection &connection, DtStateListener &listener, int modelSet)
 
 DtMilStdIconVisualizer (DtBaseConnection &connection, DtStateListener &listener, DtSceneObjectAgent *sceneObject, int modelSet)
 
virtual ~DtMilStdIconVisualizer ()
 
 DtMilStdIconVisualizer ()=delete
 
 DtMilStdIconVisualizer (const DtMilStdIconVisualizer &)=delete
 
DtMilStdIconVisualizer & operator= (const DtMilStdIconVisualizer &)=delete
 
virtual void initialize () override
 
virtual void setModelDefinitionForAgents ()
 
virtual void slot_setSelected (bool selected) override
 
virtual void setOutlineEnabled (bool enabled)
 
virtual bool outlineEnabled () const
 
virtual void setFillEnabled (bool enabled)
 
virtual bool fillEnabled () const
 
virtual void setDamageEnabled (bool enabled)
 
virtual bool damageEnabled () const
 
virtual void setIsPinned (bool myPinned)
 
virtual bool isPinned () const
 
virtual void setBaseAltitudeToUseWhilePinned (double baseAltitude)
 
virtual double baseAltitudeToUseWhilePinned ()
 
virtual void setFixedIconScalingEnabled (bool fixedScalingEnabled)
 
virtual void setIconScale (float scale)
 
virtual void setAltitudeSpecificConfigurations (const makArchives::DtDynamicScaleConfigurationCollection &collection)
 
virtual void setColorByAffiliationEnabled (bool enabled)
 
virtual bool colorByAffiliationEnabled () const
 
virtual void setForceId (int)
 
virtual int forceId () const
 
virtual void setDamaged (bool)
 
virtual bool damaged () const
 
virtual void setForceColor (float r, float g, float b, float a)
 
virtual void getForceColor (double &r, double &g, double &b, double &a)
 
virtual unsigned short outlineCharacterForUnitSymbolFont (unsigned short outlineBase, int force) const
 
virtual unsigned short fillCharacterForUnitSymbolFont (unsigned short outlineBase, int force) const
 
virtual DtUnicode generateSymbolString (float fillColor[4], float outlineColor[4], unsigned int fillGlyph, unsigned int outlineGlyph, bool damaged) const
 
virtual unsigned short outlineGlyph () const
 
virtual unsigned short fillGlyph () const
 
virtual unsigned short damageGlyph () const
 
virtual void setPickable (bool b)
 
virtual void rotateSymbolToHeading (double)
 
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 bool pickable () const
 
virtual void setSceneObjectID (DtUniqueID id)
 
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 const
DtObjectTypeStateListener & 		objectTypeStateListener () const
 
virtual bool fillCharacterByOutline (unsigned short outline, unsigned short lower, unsigned short upper, unsigned short start, bool equipment, unsigned short &fill) const
 
virtual unsigned short forceOffset (int force) const
 
virtual void displayChanged ()
 
virtual void createModelAgents ()
 
virtual void destroyModelAgents ()
 
virtual void update ()
 
virtual void updateLabel ()
 
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

DtProjectedWidgetModelAgent * myProjectIconPosition
 
DtWidgetLabelAgent * myLabel
 
bool myOutlineFlag
 
bool myFillEnabledFlag
 
bool myDamageEnabledFlag
 
bool myColorByAffiliationFlag
 
double myBaseAltitudeToUseWhilePinned
 
bool myPinnedFlag
 
bool myFixedScalingEnabled
 
bool myDamaged
 
bool myForceEffectsGlyphs
 
bool myHasMouseCursor
 
DtUnicodeChar myOutlineGlyph
 
DtUnicodeChar myFillGlyph
 
DtUnicodeChar myDamageGlyph
 
DtUnicode mySymbolString
 
unsigned int myHoveredGroupId
 
unsigned int mySelectedGroupId
 
unsigned int myGroupId
 
unsigned int myGlyphCenterPolicy
 
int myForceId
 
float myForceColor [4]
 
float myScale
 
makArchives::DtDynamicScaleConfigurationCollection myLabelScalesByMinimumAltitude
 
DtObjectTypeStateListener * myObjectTypeStateListener
 
- 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::DtMilStdIconVisualizer::DtMilStdIconVisualizer ( DtBaseConnection &  connection,
DtStateListener &  listener,
int  modelSet 
)

CTOR.

makVrv::DtMilStdIconVisualizer::DtMilStdIconVisualizer ( DtBaseConnection &  connection,
DtStateListener &  listener,
DtSceneObjectAgent *  sceneObject,
int  modelSet 
)

CTOR.

virtual makVrv::DtMilStdIconVisualizer::~DtMilStdIconVisualizer ( )
virtual

DTOR.

makVrv::DtMilStdIconVisualizer::DtMilStdIconVisualizer ( )
delete

not allowed - default constructor

makVrv::DtMilStdIconVisualizer::DtMilStdIconVisualizer ( const DtMilStdIconVisualizer &  )
delete

not allowed - copy constructor

Member Function Documentation

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

not allowed = equals operator

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

Initialize the visualizer.

Reimplemented from makVrv::DtStateVisualizer.

Reimplemented in makVrf::DtVrfGui3DAggregateMilStdIconVisualizer, makVrf::DtVrfGuiEnvironmentalMilStdIconVisualizer, makVrf::DtVrfGuiEntityMilStdIconVisualizer, makVrv::DtEnvironmentalMilStdIconVisualizer, makVrv::DtAggregateMilStdIconVisualizer, makVrf::DtVrfGui2DAggregateMilStdIconVisualizer, makVrv::DtEntityMilStdIconVisualizer, and makVrv::Dt3DAggregateMilStdIconVisualizer.

virtual void makVrv::DtMilStdIconVisualizer::setModelDefinitionForAgents ( )
virtual

Sets the model definition of the agents.

Implements makVrv::DtStateVisualizer.

Reimplemented in makVrv::DtAggregateMilStdIconVisualizer, makVrv::DtEntityMilStdIconVisualizer, and makVrv::DtEnvironmentalMilStdIconVisualizer.

virtual void makVrv::DtMilStdIconVisualizer::slot_setSelected ( bool  selected)
overridevirtual

Set the visualizer to be selected. If selected, the visualizer widget's order group is changed to be the next available group number in the selectedGroupSet group set - provided by the DtOverlayGroupManager. Once no longer selected, the order group is restored to its original value. This method is invoked whenever the element this icon belongs to is selected. It is connected to the DtStateListener's signal_objectSelectionChanged signal.

See Also
DtOverlayGroupManager::initializeDefaultGroupSets()
DtOverlayGroupManager::nextGroupId(const std::string&)

Reimplemented from makVrv::DtStateVisualizer.

virtual void makVrv::DtMilStdIconVisualizer::setOutlineEnabled ( bool  enabled)
virtual

Set whether the frame component is drawn.

virtual bool makVrv::DtMilStdIconVisualizer::outlineEnabled ( ) const
virtual

Get whether the frame component is drawn.

virtual void makVrv::DtMilStdIconVisualizer::setFillEnabled ( bool  enabled)
virtual

Set whether the fill component is filled.

virtual bool makVrv::DtMilStdIconVisualizer::fillEnabled ( ) const
virtual

Get whether the fill component is filled.

virtual void makVrv::DtMilStdIconVisualizer::setDamageEnabled ( bool  enabled)
virtual

Sets whether damaged component is drawn.

virtual bool makVrv::DtMilStdIconVisualizer::damageEnabled ( ) const
virtual

Gets whether damaged component is drawn.

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

Set whether or not the MIL-STD icon managed by this visualizer is pinned or not. A pinned MIL-STD icon will not be dynamically scaled. Instead, a fixed scale is used. If fixed icon scaling is not enabled, then the fixed scale that is used is determined by the altitude-specific configuration that corresponds to the altitude set using setBaseAltitudeToUseWhilePinned.

virtual bool makVrv::DtMilStdIconVisualizer::isPinned ( ) const
virtual

Get whether or not the MIL-STD icon managed by this visualizer is pinned or not. A pinned MIL-STD icon will not be dynamically scaled. Instead, a fixed scale is used. If fixed icon scaling is not enabled, then the fixed scale that is used is determined by the altitude-specific configuration that corresponds to the altitude set using setBaseAltitudeToUseWhilePinned.

virtual void makVrv::DtMilStdIconVisualizer::setBaseAltitudeToUseWhilePinned ( double  baseAltitude)
virtual

Set the altitude used to determine which scale to use from the altitude-specific configurations while the the MIL-STD icon is pinned. This is only used if setFixedIconScalingEnabled(false). Altitude is in meters from mean sea level.

virtual double makVrv::DtMilStdIconVisualizer::baseAltitudeToUseWhilePinned ( )
virtual

Get the altitude used to determine which scale to use from the altitude-specific configurations while the the MIL-STD icon is pinned. This is only used if setFixedIconScalingEnabled(false). Altitude is in meters from mean sea level.

virtual void makVrv::DtMilStdIconVisualizer::setFixedIconScalingEnabled ( bool  fixedScalingEnabled)
virtual

Set whether or not fixed icon scaling will be used. If fixed icon scaling is NOT used, then icons will be dynamically scaled based on the altitude of the observer for the channel rendering the icon.

virtual void makVrv::DtMilStdIconVisualizer::setIconScale ( float  scale)
virtual

Set the icon scale to use. This is only used if setFixedIconScalingEnabled(true).

virtual void makVrv::DtMilStdIconVisualizer::setAltitudeSpecificConfigurations ( const makArchives::DtDynamicScaleConfigurationCollection &  collection)
virtual

Set the altitude-specific scale values to use for this visualizer.

virtual void makVrv::DtMilStdIconVisualizer::setColorByAffiliationEnabled ( bool  enabled)
virtual

Set whether the icon has it's color set by it's affiliation.

virtual bool makVrv::DtMilStdIconVisualizer::colorByAffiliationEnabled ( ) const
virtual

Get whether the icon has it's color set by it's affiliation.

virtual void makVrv::DtMilStdIconVisualizer::setForceId ( int  )
virtual

Sets force of item. If force is different than current force, will cause an update.

Reimplemented in makVrv::DtEnvironmentalMilStdIconVisualizer.

virtual int makVrv::DtMilStdIconVisualizer::forceId ( ) const
inlinevirtual
virtual void makVrv::DtMilStdIconVisualizer::setDamaged ( bool  )
virtual

Sets whether or not item is damaged. If damaged flag is different will cause an update.

virtual bool makVrv::DtMilStdIconVisualizer::damaged ( ) const
inlinevirtual
virtual void makVrv::DtMilStdIconVisualizer::setForceColor ( float  r,
float  g,
float  b,
float  a 
)
virtual

Sets the color of the force. Forces an update.

Reimplemented in makVrf::DtVrfGui3DAggregateMilStdIconVisualizer, makVrf::DtVrfGuiEntityMilStdIconVisualizer, and makVrf::DtVrfGui2DAggregateMilStdIconVisualizer.

virtual void makVrv::DtMilStdIconVisualizer::getForceColor ( double &  r,
double &  g,
double &  b,
double &  a 
)
virtual
virtual unsigned short makVrv::DtMilStdIconVisualizer::outlineCharacterForUnitSymbolFont ( unsigned short  outlineBase,
int  force 
) const
virtual

Routines to modify glyphs into force appropriate glyphs. Call outlineCharacterForUnitSymbolFont to get the force modified outline, then pass that result into fillCharacterForUnitSymbolFont to return the appropriate fill character.

virtual unsigned short makVrv::DtMilStdIconVisualizer::fillCharacterForUnitSymbolFont ( unsigned short  outlineBase,
int  force 
) const
virtual

Reimplemented in makVrv::DtEnvironmentalMilStdIconVisualizer, and makVrv::DtEntityMilStdIconVisualizer.

virtual DtUnicode makVrv::DtMilStdIconVisualizer::generateSymbolString ( float  fillColor[4],
float  outlineColor[4],
unsigned int  fillGlyph,
unsigned int  outlineGlyph,
bool  damaged 
) const
virtual

Generates the symbol string to use with a font based icon.

Reimplemented in makVrv::DtAggregateMilStdIconVisualizer.

virtual unsigned short makVrv::DtMilStdIconVisualizer::outlineGlyph ( ) const
virtual

Returns glyphs.

virtual unsigned short makVrv::DtMilStdIconVisualizer::fillGlyph ( ) const
virtual
virtual unsigned short makVrv::DtMilStdIconVisualizer::damageGlyph ( ) const
virtual
virtual void makVrv::DtMilStdIconVisualizer::setPickable ( bool  )
virtual

Sets pickable state.

Reimplemented from makVrv::DtStateVisualizer.

virtual void makVrv::DtMilStdIconVisualizer::rotateSymbolToHeading ( double  )
virtual

Rotates the object to the given heading as supplied in radians.

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

Sets the mouse hover state.

virtual bool makVrv::DtMilStdIconVisualizer::hasMouseCursor ( ) const
virtual
virtual DtObjectTypeStateListener& makVrv::DtMilStdIconVisualizer::objectTypeStateListener ( )
protectedvirtual
virtual const DtObjectTypeStateListener& makVrv::DtMilStdIconVisualizer::objectTypeStateListener ( ) const
protectedvirtual
virtual bool makVrv::DtMilStdIconVisualizer::fillCharacterByOutline ( unsigned short  outline,
unsigned short  lower,
unsigned short  upper,
unsigned short  start,
bool  equipment,
unsigned short &  fill 
) const
protectedvirtual
virtual unsigned short makVrv::DtMilStdIconVisualizer::forceOffset ( int  force) const
protectedvirtual
virtual void makVrv::DtMilStdIconVisualizer::displayChanged ( )
protectedvirtual

Virtual function called after any symbol state changes Virtual function called after any symbol state changes (draw method, frame enabled, fill enabled, icon enabled, color by affiliation);.

virtual void makVrv::DtMilStdIconVisualizer::createModelAgents ( )
protectedvirtual

Override to create model agents that will be used to display data from the listener.

Implements makVrv::DtStateVisualizer.

Reimplemented in makVrv::DtAggregateMilStdIconVisualizer, makVrv::DtEntityMilStdIconVisualizer, and makVrv::DtEnvironmentalMilStdIconVisualizer.

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

Destroys all currently created definitions.

Implements makVrv::DtStateVisualizer.

Reimplemented in makVrv::DtEnvironmentalMilStdIconVisualizer.

virtual void makVrv::DtMilStdIconVisualizer::update ( )
protectedvirtual

Update the MIL STD Icon. This function invokes either updateLabel() or updateIcon() based on the set DrawMethod.

virtual void makVrv::DtMilStdIconVisualizer::updateLabel ( )
protectedvirtual

Update the label used for the MIL STD Icon. This method is used if the DrawMethod is DrawMethod_Font.

Reimplemented in makVrv::DtAggregateMilStdIconVisualizer, makVrv::DtEnvironmentalMilStdIconVisualizer, and makVrv::DtEntityMilStdIconVisualizer.

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

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

Reimplemented from makVrv::DtStateVisualizer.

Reimplemented in makVrf::DtVrfGui3DAggregateMilStdIconVisualizer, makVrv::DtAggregateMilStdIconVisualizer, makVrf::DtVrfGuiEnvironmentalMilStdIconVisualizer, makVrv::DtEnvironmentalMilStdIconVisualizer, makVrv::DtEntityMilStdIconVisualizer, makVrf::DtVrfGuiEntityMilStdIconVisualizer, and makVrf::DtVrfGui2DAggregateMilStdIconVisualizer.

virtual void makVrv::DtMilStdIconVisualizer::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.

Reimplemented in makVrv::DtAggregateMilStdIconVisualizer, makVrv::DtEnvironmentalMilStdIconVisualizer, and makVrv::DtEntityMilStdIconVisualizer.

Member Data Documentation

DtProjectedWidgetModelAgent* makVrv::DtMilStdIconVisualizer::myProjectIconPosition
protected
DtWidgetLabelAgent* makVrv::DtMilStdIconVisualizer::myLabel
protected
bool makVrv::DtMilStdIconVisualizer::myOutlineFlag
protected

True

bool makVrv::DtMilStdIconVisualizer::myFillEnabledFlag
protected

True

bool makVrv::DtMilStdIconVisualizer::myDamageEnabledFlag
protected

False

bool makVrv::DtMilStdIconVisualizer::myColorByAffiliationFlag
protected

True

double makVrv::DtMilStdIconVisualizer::myBaseAltitudeToUseWhilePinned
protected

The base altitude to use when determining the scale to use while pinned std::numeric_limits<double>::min()

bool makVrv::DtMilStdIconVisualizer::myPinnedFlag
protected

whether or not the widget this visualizer controls is pinned

bool makVrv::DtMilStdIconVisualizer::myFixedScalingEnabled
protected
bool makVrv::DtMilStdIconVisualizer::myDamaged
protected
bool makVrv::DtMilStdIconVisualizer::myForceEffectsGlyphs
protected
bool makVrv::DtMilStdIconVisualizer::myHasMouseCursor
protected
DtUnicodeChar makVrv::DtMilStdIconVisualizer::myOutlineGlyph
protected
DtUnicodeChar makVrv::DtMilStdIconVisualizer::myFillGlyph
protected
DtUnicodeChar makVrv::DtMilStdIconVisualizer::myDamageGlyph
protected
DtUnicode makVrv::DtMilStdIconVisualizer::mySymbolString
protected
unsigned int makVrv::DtMilStdIconVisualizer::myHoveredGroupId
protected
See Also
DtOverlayGroupManager::initializeDefaultGroupSets
unsigned int makVrv::DtMilStdIconVisualizer::mySelectedGroupId
protected
unsigned int makVrv::DtMilStdIconVisualizer::myGroupId
protected
unsigned int makVrv::DtMilStdIconVisualizer::myGlyphCenterPolicy
protected
int makVrv::DtMilStdIconVisualizer::myForceId
protected
float makVrv::DtMilStdIconVisualizer::myForceColor[4]
protected
float makVrv::DtMilStdIconVisualizer::myScale
protected
makArchives::DtDynamicScaleConfigurationCollection makVrv::DtMilStdIconVisualizer::myLabelScalesByMinimumAltitude
protected
DtObjectTypeStateListener* makVrv::DtMilStdIconVisualizer::myObjectTypeStateListener
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)