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 | Static Public Member Functions | Protected Attributes
makVrv::DtAggregateMilStdIconVisualizer Class Reference

A visualizer for displaying a Military Standard Symbology Icon for an aggregate. More...

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

Public Member Functions

 DtAggregateMilStdIconVisualizer (DtBaseConnection &connection, DtStateListener &listener, int modelSet)
 CTOR. More...
 
virtual ~DtAggregateMilStdIconVisualizer ()
 DTOR. More...
 
void setEchelonEnabled (bool enabled)
 Set whether the echelon component is shown. More...
 
bool echelonEnabled () const
 Get whether the echelon component is shown. More...
 
virtual void setVisualizerDefinition (const DtVisualizerDefinition &visDef)
 Sets the visual definition of the visualizer. More...
 
virtual unsigned short echelonCharacterForUnitSymbolFont (int force) const
 Routines to modify glyphs into force appropriate glyphs. More...
 
virtual DtUnicode generateSymbolString (float fillColor[4], float outlineColor[4], unsigned int fillGlyph, unsigned int outlineGlyph, unsigned int echelonGlyph, bool damaged) const
 Generates the symbol string to use with a font based icon. More...
 
virtual DtUnicode generateSymbolString (float fillColor[4], float outlineColor[4], unsigned int fillGlyph, unsigned int outlineGlyph, bool damaged) const
 Generates the symbol string to use with a font based icon. More...
 
virtual unsigned short echelonGlyph () const
 Returns glyphs. More...
 
virtual void setShowMainIcon (bool)
 Hides this icon, however, uses DtAggregateIconContext to hide/show it. More...
 
virtual const
DtStateVisualizer::TypeInfo
typeInfo () const
 The instance's type info. More...
 
- Public Member Functions inherited from makVrv::DtMilStdIconVisualizer
 DtMilStdIconVisualizer (DtBaseConnection &connection, DtStateListener &listener, int modelSet)
 CTOR. More...
 
virtual ~DtMilStdIconVisualizer ()
 DTOR. More...
 
virtual void setModelDefinitionForAgents ()
 Sets the model definition of the agents. More...
 
virtual void setSelected (bool selected)
 Set the visualizer to be selected. More...
 
virtual void setHasMouseCursor (bool hasMouse)
 Sets whether or not the mouse cursor is hovering over the scene object this visualizer belongs to. More...
 
void setDrawMethod (DrawMethod dt)
 Set how the symbol is to be drawn. More...
 
DrawMethod drawMethod () const
 
void setOutlineEnabled (bool enabled)
 Set whether the frame component is drawn. More...
 
bool outlineEnabled () const
 Get whether the frame component is drawn. More...
 
void setFillEnabled (bool enabled)
 Set whether the fill component is filled. More...
 
bool fillEnabled () const
 Get whether the fill component is filled. More...
 
void setDamageEnabled (bool enabled)
 Sets whether damaged component is drawn. More...
 
bool damageEnabled () const
 Gets whether damaged component is drawn. More...
 
void setIconEnabled (bool enabled)
 Set whether the icon component is drawn. More...
 
bool iconEnabled () const
 Get whether the icon component of the symbol. More...
 
void setIconScale (float scale)
 
void setColorByAffiliationEnabled (bool enabled)
 Set whether the icon has it's color set by it's affiliation. More...
 
bool colorByAffiliationEnabled () const
 Get whether the icon has it's color set by it's affiliation. More...
 
virtual void setForceId (int)
 Sets force of item. More...
 
int forceId () const
 
virtual void setDamaged (bool)
 Sets whether or not item is damaged. More...
 
bool damaged () const
 
virtual void setForceColor (float r, float g, float b, float a)
 Sets the color of the force. Forces an update. More...
 
void getForceColor (double &r, double &g, double &b, double &a)
 
virtual unsigned short outlineCharacterForUnitSymbolFont (unsigned short outlineBase, int force) const
 Routines to modify glyphs into force appropriate glyphs. More...
 
virtual unsigned short fillCharacterForUnitSymbolFont (unsigned short outlineBase, int force) const
 
unsigned short outlineGlyph () const
 Returns glyphs. More...
 
unsigned short fillGlyph () const
 
unsigned short damageGlyph () const
 
virtual void setPickable (bool b)
 Sets pickable state. More...
 
virtual void rotateSymbolToHeading (double)
 Rotates the object to the given heading as supplied in radians. 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 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 bool hasMouseCursor () const
 
virtual bool selected () const
 
void setName (const std::string &)
 Internal name of state visualizer. More...
 
const std::string & name () const
 
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
 

Static Public Member Functions

static const
DtStateVisualizer::TypeInfo
theTypeInfo ()
 This class's type info. More...
 

Protected Attributes

bool myEchelonFlag
 True More...
 
DtUnicodeChar myEchelonGlyph
 
- Protected Attributes inherited from makVrv::DtMilStdIconVisualizer
DrawMethod myDrawMethod
 Bitmap More...
 
bool myOutlineFlag
 True More...
 
DtUnicodeChar myOutlineGlyph
 
bool myFillEnabledFlag
 True More...
 
DtUnicodeChar myFillGlyph
 
bool myDamageEnabledFlag
 False More...
 
DtUnicodeChar myDamageGlyph
 
bool myIconEnabledFlag
 True More...
 
bool myColorByAffiliationFlag
 True More...
 
DtProjectedWidgetModelAgent * myProjectIconPosition
 
DtWidgetAgent * myIcon
 
DtWidgetLabelAgent * myLabel
 
DtWidgetInstanceSignalermyIconSignaler
 
DtWidgetAgent * mySelectedIcon
 
DtUnicode mySymbolString
 
float myScale
 
unsigned int myHoveredGroupId
 
unsigned int mySelectedGroupId
 
unsigned int myGroupId
 
int myForceId
 
bool myDamaged
 
bool myForceEffectsGlyphs
 
unsigned int myGlyphCenterPolicy
 
float myForceColor [4]
 
- 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::DtMilStdIconVisualizer
enum  DrawMethod { DrawMethod_Bitmap, DrawMethod_Font }
 
- 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
 
- Protected Member Functions inherited from makVrv::DtMilStdIconVisualizer
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 stateChanged ()
 Virtual function called after any symbol state changes (battle dimension, or affiliation). More...
 
virtual void displayChanged ()
 Virtual function called after any symbol state changes (draw method, frame enabled, fill enabled, icon enabled, color by affiliation);. More...
 
virtual void createModelAgents ()
 Override to create model agents that will be used to display data from the listener. More...
 
virtual void destroyModelAgents ()
 Destroys all currently created definitions. More...
 
virtual void update ()
 
virtual void updateSymbol ()
 
virtual void updateSelectedOrHoveredIcon ()
 
- 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...
 

Detailed Description

A visualizer for displaying a Military Standard Symbology Icon for an aggregate.

A symbology icon is made up of several different components. Included are: A frame, a color fill, an echelon level and an icon.

Constructor & Destructor Documentation

makVrv::DtAggregateMilStdIconVisualizer::DtAggregateMilStdIconVisualizer ( DtBaseConnection connection,
DtStateListener listener,
int  modelSet 
)

CTOR.

virtual makVrv::DtAggregateMilStdIconVisualizer::~DtAggregateMilStdIconVisualizer ( )
virtual

DTOR.

Member Function Documentation

void makVrv::DtAggregateMilStdIconVisualizer::setEchelonEnabled ( bool  enabled)

Set whether the echelon component is shown.

bool makVrv::DtAggregateMilStdIconVisualizer::echelonEnabled ( ) const

Get whether the echelon component is shown.

virtual void makVrv::DtAggregateMilStdIconVisualizer::setVisualizerDefinition ( const DtVisualizerDefinition visDef)
virtual

Sets the visual definition of the visualizer.

Reimplemented from makVrv::DtMilStdIconVisualizer.

virtual unsigned short makVrv::DtAggregateMilStdIconVisualizer::echelonCharacterForUnitSymbolFont ( 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

Reimplemented in makVrf::DtVrfGui3DAggregateMilStdIconVisualizer, makVrv::DT_PROTOCOL_NAMESPACE::DtVrlink3DAggregateMilStdIconVisualizer, makVrv::DT_PROTOCOL_NAMESPACE::DtVrlink2DAggregateMilStdIconVisualizer, and makVrf::DtVrfGui2DAggregateMilStdIconVisualizer.

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

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

virtual DtUnicode makVrv::DtAggregateMilStdIconVisualizer::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 from makVrv::DtMilStdIconVisualizer.

virtual unsigned short makVrv::DtAggregateMilStdIconVisualizer::echelonGlyph ( ) const
virtual

Returns glyphs.

virtual void makVrv::DtAggregateMilStdIconVisualizer::setShowMainIcon ( bool  )
virtual

Hides this icon, however, uses DtAggregateIconContext to hide/show it.

virtual const DtStateVisualizer::TypeInfo& makVrv::DtAggregateMilStdIconVisualizer::typeInfo ( ) const
virtual
static const DtStateVisualizer::TypeInfo& makVrv::DtAggregateMilStdIconVisualizer::theTypeInfo ( )
static

This class's type info.

Member Data Documentation

bool makVrv::DtAggregateMilStdIconVisualizer::myEchelonFlag
protected

True

DtUnicodeChar makVrv::DtAggregateMilStdIconVisualizer::myEchelonGlyph
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)