VR-Forces 4.1 Class Documentation
List of all members | Public Member Functions | Static Public Member Functions
makVrv::DtEntityMilStdIconVisualizer Class Reference

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

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

Public Member Functions

 DtEntityMilStdIconVisualizer (DtBaseConnection &connection, DtStateListener &listener, int modelSet)
 CTOR.
virtual ~DtEntityMilStdIconVisualizer ()
 DTOR.
virtual const
DtStateVisualizer::TypeInfo
typeInfo () const
 The instance's type info.
- Public Member Functions inherited from makVrv::DtMilStdIconVisualizer
 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.
- Public Member Functions inherited from makVrv::DtStateVisualizer
 DtStateVisualizer (DtBaseConnection &connection, DtStateListener &listener, int modelSet)
 CTOR.
virtual ~DtStateVisualizer ()
 DTOR.
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

Static Public Member Functions

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

Additional Inherited Members

- Public Types inherited from makVrv::DtMilStdIconVisualizer
enum  DrawMethod { DrawMethod_Bitmap, DrawMethod_Font }
- 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
- 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 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 Attributes inherited from makVrv::DtMilStdIconVisualizer
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]

Detailed Description

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

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

Constructor & Destructor Documentation

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

CTOR.

virtual makVrv::DtEntityMilStdIconVisualizer::~DtEntityMilStdIconVisualizer ( )
virtual

DTOR.

Member Function Documentation

virtual const DtStateVisualizer::TypeInfo& makVrv::DtEntityMilStdIconVisualizer::typeInfo ( ) const
virtual

The instance's type info.

Implements makVrv::DtStateVisualizer.

static const DtStateVisualizer::TypeInfo& makVrv::DtEntityMilStdIconVisualizer::theTypeInfo ( )
static

This class's type info.


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

Document ID: Generated on Tue Jan 29 18:21:16 EST 2013 from SVN revision 123193
Copyright © 2005-2013 VT MÄK Inc. All Rights Reserved (www.mak.com)