VR-Forces 4.6 Class Documentation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | Public Types | Public Member Functions | Protected Member Functions | Protected Attributes
makVrv::DtMilStdIconVisualizer Class Reference

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

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

Public Types

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 Member Functions

 DtMilStdIconVisualizer (DtBaseConnection &connection, DtStateListener &listener, int modelSet)
 CTOR.
virtual ~DtMilStdIconVisualizer ()
 DTOR.
virtual void setVisualizerDefinition (const DtVisualizerDefinition &visDef)
 Sets the visual definition of the visualizer.
virtual void setModelDefinitionForAgents ()
 Sets the model definition of the agents.
virtual void setSelected (bool selected)
 Set the visualizer to be selected.
void setDrawMethod (DrawMethod dt)
 Set how the symbol is to be drawn.
DrawMethod drawMethod () const
void setOutlineEnabled (bool enabled)
 Set whether the frame component is drawn.
bool outlineEnabled () const
 Get whether the frame component is drawn.
void setFillEnabled (bool enabled)
 Set whether the fill component is filled.
bool fillEnabled () const
 Get whether the fill component is filled.
void setDamageEnabled (bool enabled)
 Sets whether damaged component is drawn.
bool damageEnabled () const
 Gets whether damaged component is drawn.
void setIconEnabled (bool enabled)
 Set whether the icon component is drawn.
bool iconEnabled () const
 Get whether the icon component of the symbol.
void setIconScale (float scale)
void setColorByAffiliationEnabled (bool enabled)
 Set whether the icon has it's color set by it's affiliation.
bool colorByAffiliationEnabled () const
 Get whether the icon has it's color set by it's affiliation.
virtual void setForceId (int)
 Sets force of item.
int forceId () const
virtual void setDamaged (bool)
 Sets whether or not item is damaged.
bool damaged () const
virtual void setForceColor (float r, float g, float b, float a)
 Sets the color of the force. Forces an update.
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.
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
 Generates the symbol string to use with a font based icon.
unsigned short outlineGlyph () const
 Returns glyphs.
unsigned short fillGlyph () const
unsigned short damageGlyph () const
virtual void setPickable (bool b)
 Sets pickable state.
virtual void rotateSymbolToHeading (double)
 Rotates the object to the given heading as supplied in radians.
- Public Member Functions inherited from makVrv::DtStateVisualizer
 DtStateVisualizer (DtBaseConnection &connection, DtStateListener &listener, int modelSet)
 CTOR.
virtual ~DtStateVisualizer ()
 DTOR.
virtual const TypeInfotypeInfo () const =0
 Get the type info.
virtual void setParent (DtStateVisualizer *)
 Override to set the parent of this visualizer.
void setModelDefinition (const std::string &definition)
 Sets the model definition and creates agent(s) based on that definition.
const std::string & modelDefinition () const
 Gets the current model definition.
virtual bool setVisible (bool visible, int context)
 Returns true if this context wants to show or hide the item.
virtual void initialize ()
 Initialize the visualizer.
virtual bool isVisible () const
 Returns true if visible.
virtual bool selected () const
void setName (const std::string &)
 Internal name of state visualizer.
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.
DtStateListenerlistener ()
DtBaseConnectionsimulation ()
 Get the connection for this visualizer.
void setDistribute (bool b)
 Whether or not to distribute over the network.
bool distribute () const

Protected Member Functions

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 setHasMouse (bool hasMouse)
virtual void stateChanged ()
 Virtual function called after any symbol state changes (battle dimension, or affiliation).
virtual void displayChanged ()
 Virtual function called after any symbol state changes (draw method, frame enabled, fill enabled, icon enabled, color by affiliation);.
virtual void createModelAgents ()
 Override to create model agents that will be used to display data from the listener.
virtual void destroyModelAgents ()
 Destroys all currently created definitions.
virtual void update ()
virtual void updateSymbol ()
virtual void updateSelectedIcon ()
- 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.
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.
virtual bool show (int context)
 Will call createModelAgents(), if, when context is removed from myShowHideContexts, the list size is zero.
virtual bool supportsShowHideContext (int) const
 Default returns true.
template<typename T , typename C >
void connectAndUpdate (boost::signal< void(T)> &sig, void(C::*fp)(T), T val)
 Connect a signal and update the entity.

Protected Attributes

DrawMethod myDrawMethod
 Bitmap
bool myOutlineFlag
 True
DtUnicodeChar myOutlineGlyph
bool myFillEnabledFlag
 True
DtUnicodeChar myFillGlyph
bool myDamageEnabledFlag
 False
DtUnicodeChar myDamageGlyph
bool myIconEnabledFlag
 True
bool myColorByAffiliationFlag
 True
DtProjectedWidgetModelAgent * myProjectIconPosition
DtWidgetAgent * myIcon
DtWidgetLabelAgent * myLabel
DtWidgetInstanceSignalermyIconSignaler
DtWidgetAgent * mySelectedIcon
bool myHasMouse
DtUnicode mySymbolString
float myScale
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 myPickable
bool myVisible
DtStateVisualizermyParent
DtSceneObjectAgent * mySceneObjectAgent

Additional Inherited Members

- Public Attributes inherited from makVrv::DtStateVisualizer
boost::signal< void(DtStateVisualizer
*, DtStateVisualizer
*, DtStateVisualizer *)> 
signal_reparented
 Signaled when the parent of this item changes, called before destroying any model agents.
boost::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.
boost::signal< void(DtMouseState
&, const DtUniqueID &, const
std::string &, const
std::string &, const
std::string
&, DtStateVisualizer *)> 
signal_mouseUp
boost::signal< void(DtMouseState
&, const DtUniqueID &, const
std::string &, const
std::string &, const
std::string
&, DtStateVisualizer *)> 
signal_mouseDblClick

Detailed Description

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.

Member Enumeration Documentation

Enumerator:
DrawMethod_Bitmap 
DrawMethod_Font 

Constructor & Destructor Documentation

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

CTOR.

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

DTOR.

Member Function Documentation

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

Sets the visual definition of the visualizer.

Reimplemented from makVrv::DtStateVisualizer.

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

virtual void makVrv::DtMilStdIconVisualizer::setModelDefinitionForAgents ( )
virtual
virtual void makVrv::DtMilStdIconVisualizer::setSelected ( bool  selected)
virtual

Set the visualizer to be selected.

Reimplemented from makVrv::DtStateVisualizer.

void makVrv::DtMilStdIconVisualizer::setDrawMethod ( DrawMethod  dt)

Set how the symbol is to be drawn.

DrawMethod makVrv::DtMilStdIconVisualizer::drawMethod ( ) const
void makVrv::DtMilStdIconVisualizer::setOutlineEnabled ( bool  enabled)

Set whether the frame component is drawn.

bool makVrv::DtMilStdIconVisualizer::outlineEnabled ( ) const

Get whether the frame component is drawn.

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

Set whether the fill component is filled.

bool makVrv::DtMilStdIconVisualizer::fillEnabled ( ) const

Get whether the fill component is filled.

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

Sets whether damaged component is drawn.

bool makVrv::DtMilStdIconVisualizer::damageEnabled ( ) const

Gets whether damaged component is drawn.

void makVrv::DtMilStdIconVisualizer::setIconEnabled ( bool  enabled)

Set whether the icon component is drawn.

bool makVrv::DtMilStdIconVisualizer::iconEnabled ( ) const

Get whether the icon component of the symbol.

void makVrv::DtMilStdIconVisualizer::setIconScale ( float  scale)
void makVrv::DtMilStdIconVisualizer::setColorByAffiliationEnabled ( bool  enabled)

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

bool makVrv::DtMilStdIconVisualizer::colorByAffiliationEnabled ( ) const

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

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

Sets whether or not item is damaged.

If damaged flag is different will cause an update

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

Sets the color of the force. Forces an update.

void makVrv::DtMilStdIconVisualizer::getForceColor ( double r,
double g,
double b,
double a 
)
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
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.

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

Returns glyphs.

unsigned short makVrv::DtMilStdIconVisualizer::fillGlyph ( ) const
unsigned short makVrv::DtMilStdIconVisualizer::damageGlyph ( ) const
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 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::setHasMouse ( bool  hasMouse)
protectedvirtual
virtual void makVrv::DtMilStdIconVisualizer::stateChanged ( )
protectedvirtual

Virtual function called after any symbol state changes (battle dimension, or affiliation).

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

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
virtual void makVrv::DtMilStdIconVisualizer::destroyModelAgents ( )
protectedvirtual

Destroys all currently created definitions.

Implements makVrv::DtStateVisualizer.

Reimplemented in makVrv::DtEnvironmentalMilStdIconVisualizer.

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

Member Data Documentation

DrawMethod makVrv::DtMilStdIconVisualizer::myDrawMethod
protected

Bitmap

bool makVrv::DtMilStdIconVisualizer::myOutlineFlag
protected

True

DtUnicodeChar makVrv::DtMilStdIconVisualizer::myOutlineGlyph
protected
bool makVrv::DtMilStdIconVisualizer::myFillEnabledFlag
protected

True

DtUnicodeChar makVrv::DtMilStdIconVisualizer::myFillGlyph
protected
bool makVrv::DtMilStdIconVisualizer::myDamageEnabledFlag
protected

False

DtUnicodeChar makVrv::DtMilStdIconVisualizer::myDamageGlyph
protected
bool makVrv::DtMilStdIconVisualizer::myIconEnabledFlag
protected

True

bool makVrv::DtMilStdIconVisualizer::myColorByAffiliationFlag
protected

True

DtProjectedWidgetModelAgent* makVrv::DtMilStdIconVisualizer::myProjectIconPosition
protected
DtWidgetAgent* makVrv::DtMilStdIconVisualizer::myIcon
protected
DtWidgetLabelAgent* makVrv::DtMilStdIconVisualizer::myLabel
protected
DtWidgetInstanceSignaler* makVrv::DtMilStdIconVisualizer::myIconSignaler
protected
DtWidgetAgent* makVrv::DtMilStdIconVisualizer::mySelectedIcon
protected
bool makVrv::DtMilStdIconVisualizer::myHasMouse
protected
DtUnicode makVrv::DtMilStdIconVisualizer::mySymbolString
protected
float makVrv::DtMilStdIconVisualizer::myScale
protected
int makVrv::DtMilStdIconVisualizer::myForceId
protected
bool makVrv::DtMilStdIconVisualizer::myDamaged
protected
bool makVrv::DtMilStdIconVisualizer::myForceEffectsGlyphs
protected
unsigned int makVrv::DtMilStdIconVisualizer::myGlyphCenterPolicy
protected
float makVrv::DtMilStdIconVisualizer::myForceColor[4]
protected

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

Document ID: Generated on Thu Apr 12 03:15:37 EDT 2018 from SVN revision 187986
Copyright © 2005-2018 VT MÄK. All Rights Reserved (www.mak.com)