makVrv::DtEnvironmentalVolumetricLineVisualizer Class Reference

DtEnvironmentalVolumetricLineVisualizer display a line that contains at least two points. More...

Inheritance diagram for makVrv::DtEnvironmentalVolumetricLineVisualizer:

Public Member Functions
	DtEnvironmentalVolumetricLineVisualizer (DtBaseConnection &simulation, DtStateListener &listener, int modelSet)
	Constructor.
virtual	~DtEnvironmentalVolumetricLineVisualizer ()
	Destructor.
virtual void	addPoint (int index, const DtVector &)
	Adds a point to the line.
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 line.
virtual void	resetSpatial ()
	Resets geometry of line.
virtual void	createModelAgents ()
	Creates the model agents associated with the line.
virtual void	setPixelLineWidth (int)
	Sets the width of the outside line.
virtual void	setPhysicalLineWidth (float)
	Sets the width of the line in database space.
virtual void	setOrigin (const DtVector &)
	Sets the origin of the line.
virtual const DtVector &	origin () const
	Get the origin of the line.
virtual void	setScribed (bool)
	Sets whether or not the line is scribed.
virtual void	setAttached (DtUniqueID)
	Sets this object to be attached to the specified object.
virtual void	startAttached ()
	Starts the process of attachment by creating updater for attachment.
virtual void	endAttached ()
	Ends the attachment process.
DtVolumetricLineFacadeBase *	volumetricLineFacade () const
	Returns facade used by this class.
virtual void	setColor (float r, float g, float b, float a)
	Sets the color for the line.
virtual void	useDefaultColor ()
	Sets color to default color as defined in the visualizer definition.
virtual void	setInsideColor (float r, float g, float b, float a)
	Sets the inside color of the line.
virtual void	setOutsideColor (float r, float g, float b, float a)
	Sets the outside color of the line.
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.
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 DtVolumetricLineFacadeBase *	createLineFacade ()=0
	Used by subclasses to create the line agent used to display the line.
virtual void	setVisualizerDefinition (const DtVisualizerDefinition &visDef)
	Set the visualizer definition that defines the parameters of this visualizer.
virtual DtVector	offsetAtPosition (const DtVector &origin) const
	Given the origin and the point offset, return an offset that is valid at the given position.
virtual void	setSolid (bool)
	Set whether the object created by this visualizer can be ground- clamped to.
virtual void	setupLine ()
	Sets the line facade up with default data.
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 &	myLineListener
DtVolumetricLineFacadeBase *	myVolumetricLineFacade
DtEnvironmentalStateListener::ControlPointsList	myControlPoints
int	myPixelLineWidth
DtVector	myPointOffset
bool	myOriginSet
DtVector	myOrigin
int	myDefaultLineWidth
float	myPhysicalLineWidth
float	myDefaultColor [4]
float	myColor [4]
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

DtEnvironmentalVolumetricLineVisualizer display a line that contains at least two points.

Use this class if you want to create a line that has a physical line width and a physical line height. This differs from the DtEnvironmentalLineVisualizer class in that it supports both items being set at the same time for a more consistant and correct visualization in 2D and 3D modes. This class does not support the drawing of arrows with volumetric lines. This class will also create a volumetric facade interface (rather than a line facade interface) which will create polygonal models rather than line models for the use in displaying these visuals

Constructor & Destructor Documentation

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

Constructor.

virtual makVrv::DtEnvironmentalVolumetricLineVisualizer::~DtEnvironmentalVolumetricLineVisualizer ( )

virtual

Destructor.

Member Function Documentation

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

virtual

Sets the color for the line.

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

Reimplemented in makVrv::DT_PROTOCOL_NAMESPACE::DtVrlink2DEnvironmentalVolumetricLineVisualizer, and makVrv::DT_PROTOCOL_NAMESPACE::DtVrlink3DEnvironmentalVolumetricLineVisualizer.

virtual void makVrv::DtEnvironmentalVolumetricLineVisualizer::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::DtEnvironmentalVolumetricLineVisualizer::setInsideColor ( float  r, float  g, float  b, float  a  )

virtual

Sets the inside color of the line.

virtual void makVrv::DtEnvironmentalVolumetricLineVisualizer::setOutsideColor ( float  r, float  g, float  b, float  a  )

virtual

Sets the outside color of the line.

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

virtual

Adds a point to the line.

If index is -1, appends else places at given point

Reimplemented in makVrv::DT_PROTOCOL_NAMESPACE::DtVrlink2DEnvironmentalVolumetricLineVisualizer, and makVrv::DT_PROTOCOL_NAMESPACE::DtVrlink3DEnvironmentalVolumetricLineVisualizer.

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

virtual

Removes point at the given index.

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

virtual

Modifies the point at the given index.

Reimplemented in makVrv::DT_PROTOCOL_NAMESPACE::DtVrlink2DEnvironmentalVolumetricLineVisualizer, and makVrv::DT_PROTOCOL_NAMESPACE::DtVrlink3DEnvironmentalVolumetricLineVisualizer.

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

virtual

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

Reimplemented in makVrv::DT_PROTOCOL_NAMESPACE::DtVrlink2DEnvironmentalVolumetricLineVisualizer, and makVrv::DT_PROTOCOL_NAMESPACE::DtVrlink3DEnvironmentalVolumetricLineVisualizer.

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

virtual

Selects the entire line.

Reimplemented from makVrv::DtStateVisualizer.

virtual void makVrv::DtEnvironmentalVolumetricLineVisualizer::resetSpatial ( )

virtual

Resets geometry of line.

virtual void makVrv::DtEnvironmentalVolumetricLineVisualizer::createModelAgents ( )

virtual

Creates the model agents associated with the line.

Reimplemented from makVrv::DtSceneObjectVisualizer.

virtual void makVrv::DtEnvironmentalVolumetricLineVisualizer::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 pixel line width

virtual void makVrv::DtEnvironmentalVolumetricLineVisualizer::setPhysicalLineWidth ( float  )

virtual

Sets the width of the line in database space.

Reimplemented in makVrv::Dt3DEnvironmentalVolumetricLineVisualizer.

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

virtual

Sets the origin of the line.

Reimplemented in makVrv::DT_PROTOCOL_NAMESPACE::DtVrlink2DEnvironmentalVolumetricLineVisualizer, and makVrv::DT_PROTOCOL_NAMESPACE::DtVrlink3DEnvironmentalVolumetricLineVisualizer.

virtual const DtVector& makVrv::DtEnvironmentalVolumetricLineVisualizer::origin ( ) const

virtual

Get the origin of the line.

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

virtual

Sets whether or not the line is scribed.

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

virtual

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::DtEnvironmentalVolumetricLineVisualizer::setOffsetPoints ( const std::vector< DtVector > &  )

virtual

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::DtEnvironmentalVolumetricLineVisualizer::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::DtEnvironmentalVolumetricLineVisualizer::startAttached ( )

virtual

Starts the process of attachment by creating updater for attachment.

Reimplemented in makVrv::DT_PROTOCOL_NAMESPACE::DtVrlink2DEnvironmentalVolumetricLineVisualizer, and makVrv::DT_PROTOCOL_NAMESPACE::DtVrlink3DEnvironmentalVolumetricLineVisualizer.

virtual void makVrv::DtEnvironmentalVolumetricLineVisualizer::endAttached ( )

virtual

Ends the attachment process.

DtVolumetricLineFacadeBase* makVrv::DtEnvironmentalVolumetricLineVisualizer::volumetricLineFacade

(

)

const

Returns facade used by this class.

virtual void makVrv::DtEnvironmentalVolumetricLineVisualizer::destroyModelAgents ( )

protectedvirtual

Destroys any model agents currently created.

Reimplemented from makVrv::DtSceneObjectVisualizer.

Reimplemented in makVrv::Dt3DEnvironmentalVolumetricLineVisualizer.

virtual void makVrv::DtEnvironmentalVolumetricLineVisualizer::setModelDefinitionForAgents ( )

protectedvirtual

Sets model definitions for agents.

Reimplemented from makVrv::DtSceneObjectVisualizer.

virtual DtVolumetricLineFacadeBase* makVrv::DtEnvironmentalVolumetricLineVisualizer::createLineFacade ( )

protectedpure virtual

Used by subclasses to create the line agent used to display the line.

Implemented in makVrv::Dt3DEnvironmentalVolumetricLineVisualizer, and makVrv::Dt2DEnvironmentalVolumetricLineVisualizer.

virtual void makVrv::DtEnvironmentalVolumetricLineVisualizer::setVisualizerDefinition ( const DtVisualizerDefinition &  visDef )

protectedvirtual

Set the visualizer definition that defines the parameters of this visualizer.

Reimplemented from makVrv::DtStateVisualizer.

Reimplemented in makVrv::Dt3DEnvironmentalVolumetricLineVisualizer.

virtual DtVector makVrv::DtEnvironmentalVolumetricLineVisualizer::offsetAtPosition ( const DtVector &  origin ) 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::DtVrlink2DEnvironmentalVolumetricLineVisualizer, and makVrv::DT_PROTOCOL_NAMESPACE::DtVrlink3DEnvironmentalVolumetricLineVisualizer.

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

protectedvirtual

Set whether the object created by this visualizer can be ground- clamped to.

virtual void makVrv::DtEnvironmentalVolumetricLineVisualizer::setupLine ( )

protectedvirtual

Sets the line facade up with default data.

Reimplemented in makVrv::Dt3DEnvironmentalVolumetricLineVisualizer, makVrv::DT_PROTOCOL_NAMESPACE::DtVrlink2DEnvironmentalVolumetricLineVisualizer, makVrv::DT_PROTOCOL_NAMESPACE::DtVrlink3DEnvironmentalVolumetricLineVisualizer, and makVrv::Dt2DEnvironmentalVolumetricLineVisualizer.

Member Data Documentation

DtTacticalGraphicStateListener& makVrv::DtEnvironmentalVolumetricLineVisualizer::myLineListener

protected

DtVolumetricLineFacadeBase* makVrv::DtEnvironmentalVolumetricLineVisualizer::myVolumetricLineFacade

protected

DtEnvironmentalStateListener::ControlPointsList makVrv::DtEnvironmentalVolumetricLineVisualizer::myControlPoints

protected

int makVrv::DtEnvironmentalVolumetricLineVisualizer::myPixelLineWidth

protected

DtVector makVrv::DtEnvironmentalVolumetricLineVisualizer::myPointOffset

protected

bool makVrv::DtEnvironmentalVolumetricLineVisualizer::myOriginSet

protected

DtVector makVrv::DtEnvironmentalVolumetricLineVisualizer::myOrigin

protected

int makVrv::DtEnvironmentalVolumetricLineVisualizer::myDefaultLineWidth

protected

float makVrv::DtEnvironmentalVolumetricLineVisualizer::myPhysicalLineWidth

protected

float makVrv::DtEnvironmentalVolumetricLineVisualizer::myDefaultColor[4]

protected

float makVrv::DtEnvironmentalVolumetricLineVisualizer::myColor[4]

protected

bool makVrv::DtEnvironmentalVolumetricLineVisualizer::myScribed

protected

bool makVrv::DtEnvironmentalVolumetricLineVisualizer::myAttachedFlag

protected

DtUniqueID makVrv::DtEnvironmentalVolumetricLineVisualizer::myAttachedToId

protected

DtMultiPointEmbarkationUpdaterAgent* makVrv::DtEnvironmentalVolumetricLineVisualizer::myAttachedUpdaterAgent

protected

DtVector makVrv::DtEnvironmentalVolumetricLineVisualizer::myRelativeLocation

protected

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.vrf4-6-branch/include/vrvCore/DtEnvironmentalVolumetricLineVisualizer.h