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

Inheritance diagram for makVrv::DtMilStdIconVisualizer:

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. More...

virtual	~DtMilStdIconVisualizer ()
	DTOR. More...

virtual void	setVisualizerDefinition (const DtVisualizerDefinition &visDef)
	Sets the visual definition of the visualizer. 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

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...

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 const TypeInfo &	typeInfo () const =0
	Get the type info. More...

virtual void	setParent (DtStateVisualizer *)
	Override to set the parent of this visualizer. More...

virtual const DtStateVisualizer *	parent () 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...

DtStateListener &	listener ()

DtBaseConnection &	simulation ()
	Get the connection for this visualizer. More...

void	setDistribute (bool b)
	Whether or not to distribute over the network. More...

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	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...

Protected Attributes
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

DtWidgetInstanceSignaler *	myIconSignaler

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
DtBaseConnection &	mySimulation

DtStateListener &	myListener

bool	myDistributeFlag

DtUniqueID	myUniqueID

std::string	myName

std::string	myModelDefinition

DtSignalConnectionManager	myConnections

int	myModelSet

int	myVisualizerType

std::vector< int >	myShowHideContexts

bool	mySelected

bool	myHasMouseCursor

bool	myPickable

bool	myVisible

DtStateVisualizer *	myParent

DtSceneObjectAgent *	mySceneObjectAgent

Additional Inherited Members
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

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

enum makVrv::DtMilStdIconVisualizer::DrawMethod

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

Sets the model definition of the agents.

Implements makVrv::DtStateVisualizer.

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

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

virtual

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.

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

Reimplemented from makVrv::DtStateVisualizer.

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

virtual

Sets whether or not the mouse cursor is hovering over the scene object this visualizer belongs to.

If true, the visualizer widget's order group is changed to be the next available group number in the hoverGroupSet group set - provided by the DtOverlayGroupManager. If false, the order group is restored to its original value. This method is invoked whenever a pick-enabled widget associated with the element that this visualizer is associated with has its "has mouse cursor" state changed.

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

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.

Reimplemented in makVrf::DtVrfVrlink2DAggregateStateVisualizer, and makVrf::DtVrfVrlink2DEntityStateVisualizer.

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

Reimplemented in makVrv::DT_PROTOCOL_NAMESPACE::DtVrlinkEntityMilStdIconVisualizer, and makVrv::DT_PROTOCOL_NAMESPACE::DtVrlinkTacticalGraphicMilStdIconVisualizer.

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::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

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

Implements makVrv::DtStateVisualizer.

Reimplemented in makVrv::DT_PROTOCOL_NAMESPACE::DtVrlinkEntityMilStdIconVisualizer, makVrv::DT_PROTOCOL_NAMESPACE::DtVrlink3DAggregateMilStdIconVisualizer, makVrv::DT_PROTOCOL_NAMESPACE::DtVrlink2DAggregateMilStdIconVisualizer, 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

virtual void makVrv::DtMilStdIconVisualizer::updateSymbol ( )

protectedvirtual

Reimplemented in makVrf::DtVrfVrlink2DAggregateStateVisualizer, makVrf::DtVrfVrlink2DEntityStateVisualizer, makVrv::DT_PROTOCOL_NAMESPACE::DtVrlink3DAggregateMilStdIconVisualizer, makVrv::DT_PROTOCOL_NAMESPACE::DtVrlink2DAggregateMilStdIconVisualizer, makVrv::DT_PROTOCOL_NAMESPACE::DtVrlinkEntityMilStdIconVisualizer, and makVrv::DT_PROTOCOL_NAMESPACE::DtVrlinkTacticalGraphicMilStdIconVisualizer.

virtual void makVrv::DtMilStdIconVisualizer::updateSelectedOrHoveredIcon ( )

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

DtUnicode makVrv::DtMilStdIconVisualizer::mySymbolString

protected

float makVrv::DtMilStdIconVisualizer::myScale

protected

unsigned int makVrv::DtMilStdIconVisualizer::myHoveredGroupId

protected

See Also: DtOverlayGroupManager::initializeDefaultGroupSets

unsigned int makVrv::DtMilStdIconVisualizer::mySelectedGroupId

protected

unsigned int makVrv::DtMilStdIconVisualizer::myGroupId

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:

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf4-10-branch/include/vrvCore/DtMilStdIconVisualizer.h

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation