makVrv::DtEnvironmentalAreaVisualizer Class Reference

DtEnvironmentalAreaVisualizer display a area that contains at least three points. More...

Inheritance diagram for makVrv::DtEnvironmentalAreaVisualizer:

Public Member Functions
	DtEnvironmentalAreaVisualizer (DtBaseConnection &simulation, DtStateListener &listener, int modelSet)
	Constructor.
virtual	~DtEnvironmentalAreaVisualizer ()
	Destructor.
virtual void	setColor (float r, float g, float b, float a)
	Sets the color for the area.
virtual void	useDefaultColor ()
	Sets color to default color as defined in the visualizer definition.
virtual void	getColor (float &r, float &g, float &b, float &a) const
	Returns the color.
virtual void	addPoint (int index, const DtVector &)
	Adds a point to the Area. If index is -1, appends else places at given point.
virtual void	removePoint (int index)
	Removes point at the given index.
virtual void	modifyPoint (int index, const DtVector &)
	Modifies the point at the given index.
virtual void	setPoints (const DtEnvironmentalStateListener::ControlPointsList &)
	Sets the control points to the specified list, adding, removing and changing as needed.
virtual void	setSelected (bool b)
	Selects the entire Area.
virtual void	resetSpatial ()
	Resets geometry of Area.
virtual void	createModelAgents ()
	Creates the model agents associated with the Area.
virtual void	setStipplePattern (unsigned short)
	Sets the line style of the outline of the area.
virtual unsigned short	lineStipple () const
virtual void	setScribed (bool)
	Sets whether or not to scribe the line (and edges)
virtual void	setFillStyle (vrvTacticalGraphicUtilities::FillStyle)
	Sets the fill style of the area.
virtual vrvTacticalGraphicUtilities::FillStyle	fillStyle () const
	Returns the currently set fill style.
virtual void	setPenStyle (vrvTacticalGraphicUtilities::PenStyle)
	Takes the pen style and translates it to a stipple pattern.
virtual void	setPixelLineWidth (int)
	Sets the width of the outside line.
virtual void	setOrigin (const DtVector &)
	Sets the origin of the area.
virtual void	setUseDynamicOrigin (bool)
	Set whether or not to use dynamic origin.
DtAreaFacadeBase *	areaFacade () const
	Area facade used by this visualizer.
virtual void	setAttached (DtUniqueID)
	Sets this object to be attached to the specified object.
Public Member Functions inherited from makVrv::DtSceneObjectVisualizer
	DtSceneObjectVisualizer (DtBaseConnection &simulation, DtStateListener &listener, int modelSet)
virtual	~DtSceneObjectVisualizer ()
virtual DtUniqueID	uniqueID () const
	Return unique id of mySceneObjectAgent, if it exists, else returns 0;.
virtual DtSceneObjectAgent *	sceneObjectAgent ()
virtual void	setParent (DtStateVisualizer *p)
	Override of base class setParent to simply set the parent without destroying/recreating model agents.
virtual void	setSceneObjectAgent (DtSceneObjectAgent *)
virtual void	setElementID (const DtElementID &elementID)
DtElementID	elementID () const
virtual bool	show (int)
	Override to show/hide scene object agent (if it exists)
virtual bool	hide (int)
	Will call destroyModelAgents(), if, when the context is added, it is the first context in the list.
Public Member Functions inherited from makVrv::DtStateVisualizer
	DtStateVisualizer (DtBaseConnection &connection, DtStateListener &listener, int modelSet)
	CTOR.
virtual	~DtStateVisualizer ()
	DTOR.
virtual const TypeInfo &	typeInfo () const =0
	Get the type info.
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 void	setPickable (bool)
	Sets pickable state.
virtual bool	pickable () const
virtual void	setUniqueID (DtUniqueID id)
int	visualizerType () const
void	setShowHideContext (const std::vector< int > &s)
	Set show/hide context without changing visibility of item.
DtStateListener &	listener ()
DtBaseConnection &	simulation ()
	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 void	destroyModelAgents ()
	Destroys any model agents currently created.
virtual void	setModelDefinitionForAgents ()
	Sets model definitions for agents.
virtual DtAreaFacadeBase *	createAreaFacade ()=0
	Implemented by subclasses to create the agent used to draw the area.
virtual void	setVisualizerDefinition (const DtVisualizerDefinition &visDef)
	Set any other additional visualizer information from the visual record.
virtual DtVector	offsetAtPosition (const DtVector &position) const
	Given the origin and the point offset, return an offset that is valid at the given position.
virtual void	setSolid (bool)
virtual void	setupArea (DtAreaFacadeBase *)
	Sets the newly created area up with current values.
virtual void	startAttached ()
	Starts the process of attachment by creating updater for attachment.
virtual void	endAttached ()
	Ends the attachment process.
virtual void	setRelativeLocation (const DtVector &)
virtual void	setOffsetPoints (const std::vector< DtVector > &)
	These are the relative offsets from the origin of this object that the point of this object represent.
Protected Member Functions inherited from makVrv::DtSceneObjectVisualizer
virtual DtSceneObjectAgent *	createObjectAgent ()
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	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
DtTacticalGraphicStateListener &	myAreaListener
DtAreaFacadeBase *	myAreaFacade
DtEnvironmentalStateListener::ControlPointsList	myControlPoints
double	myLineWidth
int	myDefaultLineWidth
float	myColor [4]
float	myDefaultColor [4]
DtVector	myPointOffset
bool	myUseDynamicOrigin
unsigned short	myLineStipple
vrvTacticalGraphicUtilities::FillStyle	myFillStyle
bool	myFillColorSet
float	myFillColor
bool	myScribed
bool	myAttachedFlag
DtUniqueID	myAttachedToId
DtMultiPointEmbarkationUpdaterAgent *	myAttachedUpdaterAgent
DtVector	myRelativeLocation
Protected Attributes inherited from makVrv::DtSceneObjectVisualizer
DtElementID	myElementID
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	myPickable
bool	myVisible
DtStateVisualizer *	myParent
DtSceneObjectAgent *	mySceneObjectAgent

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

DtEnvironmentalAreaVisualizer display a area that contains at least three points.

Constructor & Destructor Documentation

makVrv::DtEnvironmentalAreaVisualizer::DtEnvironmentalAreaVisualizer	(	DtBaseConnection &	simulation,
		DtStateListener &	listener,
		int	modelSet
	)

Constructor.

virtual makVrv::DtEnvironmentalAreaVisualizer::~DtEnvironmentalAreaVisualizer ( )

virtual

Destructor.

Member Function Documentation

virtual void makVrv::DtEnvironmentalAreaVisualizer::setColor ( float  r, float  g, float  b, float  a  )

virtual

Sets the color for the area.

This will apply to all segments of the area. If the default (all 0's), uses the default as defined in the visual definition

Reimplemented in makVrf::VRF_PROTOCOL_NAMESPACE::DtVrfVrlink2DEnvironmentalAreaVisualizer, makVrf::DtVrf2DEnvironmentalAreaVisualizer, makVrv::DT_PROTOCOL_NAMESPACE::DtVrlink2DEnvironmentalAreaVisualizer, and makVrv::DT_PROTOCOL_NAMESPACE::DtVrlink3DEnvironmentalAreaVisualizer.

virtual void makVrv::DtEnvironmentalAreaVisualizer::useDefaultColor ( )

virtual

Sets color to default color as defined in the visualizer definition.

Called when color set is 0, 0, 0, 0

virtual void makVrv::DtEnvironmentalAreaVisualizer::getColor ( float &  r, float &  g, float &  b, float &  a  ) const

virtual

Returns the color.

virtual void makVrv::DtEnvironmentalAreaVisualizer::addPoint ( int  index, const DtVector &    )

virtual

Adds a point to the Area. If index is -1, appends else places at given point.

Reimplemented in makVrf::VRF_PROTOCOL_NAMESPACE::DtVrfVrlink2DEnvironmentalAreaVisualizer, makVrf::DtVrf2DEnvironmentalAreaVisualizer, makVrv::DT_PROTOCOL_NAMESPACE::DtVrlink2DEnvironmentalAreaVisualizer, and makVrv::DT_PROTOCOL_NAMESPACE::DtVrlink3DEnvironmentalAreaVisualizer.

virtual void makVrv::DtEnvironmentalAreaVisualizer::removePoint ( int  index )

virtual

Removes point at the given index.

Reimplemented in makVrf::VRF_PROTOCOL_NAMESPACE::DtVrfVrlink2DEnvironmentalAreaVisualizer, and makVrf::DtVrf2DEnvironmentalAreaVisualizer.

virtual void makVrv::DtEnvironmentalAreaVisualizer::modifyPoint ( int  index, const DtVector &    )

virtual

Modifies the point at the given index.

Reimplemented in makVrf::VRF_PROTOCOL_NAMESPACE::DtVrfVrlink2DEnvironmentalAreaVisualizer, makVrf::DtVrf2DEnvironmentalAreaVisualizer, makVrv::DT_PROTOCOL_NAMESPACE::DtVrlink2DEnvironmentalAreaVisualizer, and makVrv::DT_PROTOCOL_NAMESPACE::DtVrlink3DEnvironmentalAreaVisualizer.

virtual void makVrv::DtEnvironmentalAreaVisualizer::setPoints ( const DtEnvironmentalStateListener::ControlPointsList &  )

virtual

Sets the control points to the specified list, adding, removing and changing as needed.

Reimplemented in makVrf::VRF_PROTOCOL_NAMESPACE::DtVrfVrlink2DEnvironmentalAreaVisualizer, makVrf::DtVrf2DEnvironmentalAreaVisualizer, makVrv::DT_PROTOCOL_NAMESPACE::DtVrlink2DEnvironmentalAreaVisualizer, and makVrv::DT_PROTOCOL_NAMESPACE::DtVrlink3DEnvironmentalAreaVisualizer.

virtual void makVrv::DtEnvironmentalAreaVisualizer::setSelected ( bool  b )

virtual

Selects the entire Area.

Reimplemented from makVrv::DtStateVisualizer.

Reimplemented in makVrf::VRF_PROTOCOL_NAMESPACE::DtVrfVrlink2DEnvironmentalAreaVisualizer, and makVrf::DtVrf2DEnvironmentalAreaVisualizer.

virtual void makVrv::DtEnvironmentalAreaVisualizer::resetSpatial ( )

virtual

Resets geometry of Area.

virtual void makVrv::DtEnvironmentalAreaVisualizer::createModelAgents ( )

virtual

Creates the model agents associated with the Area.

Reimplemented from makVrv::DtSceneObjectVisualizer.

Reimplemented in makVrf::VRF_PROTOCOL_NAMESPACE::DtVrfVrlink2DEnvironmentalAreaVisualizer.

virtual void makVrv::DtEnvironmentalAreaVisualizer::setStipplePattern ( unsigned  short )

virtual

Sets the line style of the outline of the area.

virtual unsigned short makVrv::DtEnvironmentalAreaVisualizer::lineStipple ( ) const

virtual

virtual void makVrv::DtEnvironmentalAreaVisualizer::setScribed ( bool  )

virtual

Sets whether or not to scribe the line (and edges)

virtual void makVrv::DtEnvironmentalAreaVisualizer::setFillStyle ( vrvTacticalGraphicUtilities::FillStyle  )

virtual

Sets the fill style of the area.

If fill is 0, will be considered an outlined area

Reimplemented in makVrf::VRF_PROTOCOL_NAMESPACE::DtVrfVrlink2DEnvironmentalAreaVisualizer, makVrf::DtVrf2DEnvironmentalAreaVisualizer, and makVrv::Dt3DEnvironmentalAreaVisualizer.

virtual vrvTacticalGraphicUtilities::FillStyle makVrv::DtEnvironmentalAreaVisualizer::fillStyle ( ) const

virtual

Returns the currently set fill style.

virtual void makVrv::DtEnvironmentalAreaVisualizer::setPenStyle ( vrvTacticalGraphicUtilities::PenStyle  )

virtual

Takes the pen style and translates it to a stipple pattern.

See vrvTacticalGraphicUtilities for styles

virtual void makVrv::DtEnvironmentalAreaVisualizer::setPixelLineWidth ( int  )

virtual

Sets the width of the outside line.

Default is 2. The pixel line width is the line in osg pixel space. This is different than physicalLineWidth which sets the width of the line in datasbe space. If value is 0 will use default line width

virtual void makVrv::DtEnvironmentalAreaVisualizer::setOrigin ( const DtVector &  )

virtual

Sets the origin of the area.

Reimplemented in makVrv::DT_PROTOCOL_NAMESPACE::DtVrlink3DEnvironmentalAreaVisualizer, and makVrv::DT_PROTOCOL_NAMESPACE::DtVrlink2DEnvironmentalAreaVisualizer.

virtual void makVrv::DtEnvironmentalAreaVisualizer::setUseDynamicOrigin ( bool  )

virtual

Set whether or not to use dynamic origin.

When enabled, the model ignores the origin set in setOrigin and dynamically generates one instead This should be enabled when you want to set the vertices to database positions instead of offsets from the origin to avoid precision issues

DtAreaFacadeBase* makVrv::DtEnvironmentalAreaVisualizer::areaFacade

(

)

const

Area facade used by this visualizer.

virtual void makVrv::DtEnvironmentalAreaVisualizer::setAttached ( DtUniqueID  )

virtual

Sets this object to be attached to the specified object.

Once attached this object will move its origin offset from the relative location

virtual void makVrv::DtEnvironmentalAreaVisualizer::destroyModelAgents ( )

protectedvirtual

Destroys any model agents currently created.

Reimplemented from makVrv::DtSceneObjectVisualizer.

Reimplemented in makVrf::VRF_PROTOCOL_NAMESPACE::DtVrfVrlink2DEnvironmentalAreaVisualizer, and makVrf::DtVrf2DEnvironmentalAreaVisualizer.

virtual void makVrv::DtEnvironmentalAreaVisualizer::setModelDefinitionForAgents ( )

protectedvirtual

Sets model definitions for agents.

Reimplemented from makVrv::DtSceneObjectVisualizer.

virtual DtAreaFacadeBase* makVrv::DtEnvironmentalAreaVisualizer::createAreaFacade ( )

protectedpure virtual

Implemented by subclasses to create the agent used to draw the area.

Implemented in makVrv::Dt3DEnvironmentalAreaVisualizer, makVrv::Dt3DBoxVisualizer, makVrv::Dt2DBoxVisualizer, and makVrv::Dt2DEnvironmentalAreaVisualizer.

virtual void makVrv::DtEnvironmentalAreaVisualizer::setVisualizerDefinition ( const DtVisualizerDefinition &  )

protectedvirtual

Set any other additional visualizer information from the visual record.

Reimplemented from makVrv::DtStateVisualizer.

Reimplemented in makVrv::Dt3DEnvironmentalAreaVisualizer.

virtual DtVector makVrv::DtEnvironmentalAreaVisualizer::offsetAtPosition ( const DtVector &  position ) const

protectedvirtual

Given the origin and the point offset, return an offset that is valid at the given position.

Default simply returns offset

Reimplemented in makVrv::DT_PROTOCOL_NAMESPACE::DtVrlink3DEnvironmentalAreaVisualizer, and makVrv::DT_PROTOCOL_NAMESPACE::DtVrlink2DEnvironmentalAreaVisualizer.

virtual void makVrv::DtEnvironmentalAreaVisualizer::setSolid ( bool  )

protectedvirtual

Reimplemented in makVrv::Dt3DEnvironmentalAreaVisualizer.

virtual void makVrv::DtEnvironmentalAreaVisualizer::setupArea ( DtAreaFacadeBase *  )

protectedvirtual

Sets the newly created area up with current values.

Reimplemented in makVrf::VRF_PROTOCOL_NAMESPACE::DtVrfVrlink2DEnvironmentalAreaVisualizer, makVrv::DT_PROTOCOL_NAMESPACE::DtVrlink3DEnvironmentalAreaVisualizer, makVrv::DT_PROTOCOL_NAMESPACE::DtVrlink2DEnvironmentalAreaVisualizer, makVrv::Dt3DEnvironmentalAreaVisualizer, and makVrv::Dt3DBoxVisualizer.

virtual void makVrv::DtEnvironmentalAreaVisualizer::setRelativeLocation ( const DtVector &  )

protectedvirtual

If attached, these will represent the offset from the origin of the entity this object is, such that when the host entity moves this object's origin will move relative to that entity by the offset amount

virtual void makVrv::DtEnvironmentalAreaVisualizer::setOffsetPoints ( const std::vector< DtVector > &  )

protectedvirtual

These are the relative offsets from the origin of this object that the point of this object represent.

This means that when the object moves because the host object moves, all the points on this object will be reset from the new origin of this entity by the offset points

virtual void makVrv::DtEnvironmentalAreaVisualizer::startAttached ( )

protectedvirtual

Starts the process of attachment by creating updater for attachment.

Reimplemented in makVrv::DT_PROTOCOL_NAMESPACE::DtVrlink3DEnvironmentalAreaVisualizer, makVrv::DT_PROTOCOL_NAMESPACE::DtVrlink2DEnvironmentalAreaVisualizer, and makVrv::Dt2DEnvironmentalAreaVisualizer.

virtual void makVrv::DtEnvironmentalAreaVisualizer::endAttached ( )

protectedvirtual

Ends the attachment process.

Member Data Documentation

DtTacticalGraphicStateListener& makVrv::DtEnvironmentalAreaVisualizer::myAreaListener

protected

DtAreaFacadeBase* makVrv::DtEnvironmentalAreaVisualizer::myAreaFacade

protected

DtEnvironmentalStateListener::ControlPointsList makVrv::DtEnvironmentalAreaVisualizer::myControlPoints

protected

double makVrv::DtEnvironmentalAreaVisualizer::myLineWidth

protected

int makVrv::DtEnvironmentalAreaVisualizer::myDefaultLineWidth

protected

float makVrv::DtEnvironmentalAreaVisualizer::myColor[4]

protected

float makVrv::DtEnvironmentalAreaVisualizer::myDefaultColor[4]

protected

DtVector makVrv::DtEnvironmentalAreaVisualizer::myPointOffset

protected

bool makVrv::DtEnvironmentalAreaVisualizer::myUseDynamicOrigin

protected

unsigned short makVrv::DtEnvironmentalAreaVisualizer::myLineStipple

protected

vrvTacticalGraphicUtilities::FillStyle makVrv::DtEnvironmentalAreaVisualizer::myFillStyle

protected

bool makVrv::DtEnvironmentalAreaVisualizer::myFillColorSet

protected

float makVrv::DtEnvironmentalAreaVisualizer::myFillColor

protected

bool makVrv::DtEnvironmentalAreaVisualizer::myScribed

protected

bool makVrv::DtEnvironmentalAreaVisualizer::myAttachedFlag

protected

DtUniqueID makVrv::DtEnvironmentalAreaVisualizer::myAttachedToId

protected

DtMultiPointEmbarkationUpdaterAgent* makVrv::DtEnvironmentalAreaVisualizer::myAttachedUpdaterAgent

protected

DtVector makVrv::DtEnvironmentalAreaVisualizer::myRelativeLocation

protected

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrvCore/DtEnvironmentalAreaVisualizer.h