makVrv::Dt3DLineStateVisualizer Class Reference

Dt3DLineStateVisualizer objects are responsible for displaying 3D line objects. More...

Inheritance diagram for makVrv::Dt3DLineStateVisualizer:

Public Member Functions
	Dt3DLineStateVisualizer (DtBaseConnection &simulation, DtStateListener &listener, int modelSet)
	Constructor.
virtual	~Dt3DLineStateVisualizer ()
	Destructor.
virtual void	setStartLocation (const DtVector &pos)
	Sets the start location (in database coordinates).
virtual void	setEndLocation (const DtVector &endpoint)
	Sets the end location (in database coordinates).
virtual void	setFlashing (bool flashing)
	Sets whether the line is flashing.
virtual void	setStyleSegments (const std::vector< double > &segmentPercentages)
	Sets the percentages of line segments.
virtual void	setSegmentColor (unsigned int segmentIndex, float r, float g, float b, float a)
	Sets the color of a particular segment.
virtual void	setSegmentLightningStyle (unsigned int segmentIndex, bool enableLightningStyle)
	Sets the lightning style of a particular segment.
virtual void	setSegmentStartArrow (unsigned int segmentIndex, bool enableArrow)
	Sets whether a particular segment has a start arrowhead.
virtual void	setSegmentEndArrow (unsigned int segmentIndex, bool enableArrow)
	Sets whether a particular segment has an end arrowhead.
virtual void	setSegmentStipplePattern (unsigned int segmentIndex, unsigned int stipplePattern)
	Sets the stipple pattern of a particular segment.
virtual void	setSegmentWidth (unsigned int segmentIndex, double width)
	Set the line width of a segment.
virtual void	setStopOnTerrainIntersection (bool enabled)
	Set whether or not to stop drawing the line at the first terrain intersection.
virtual void	setAttached (DtUniqueID id, int vtx, double percentage)
	Attaches the cuboid to the unique ID specified.
virtual void	setHostId (const std::string &id, int vtx, double percentage)
	Sets the host ID attached to. Overridden by child classes.
virtual void	setOffset (const DtVector &offset)
	Sets the offset (in body coordinates) of an attached line.
virtual void	setProjected (bool projected)
	Sets whether the line is projected above the terrain.
virtual const DtStateVisualizer::TypeInfo &	typeInfo () const
	The instance's type info.
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.
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 void	setSelected (bool)
	Sets selected state.
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.
virtual void	setVisualizerDefinition (const DtVisualizerDefinition &)
	Set any other additional visualizer information from the visual record.
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
Public Member Functions inherited from makVrv::DtRemoteGraphicVisualizerAttributes
	DtRemoteGraphicVisualizerAttributes ()
	CTOR.
virtual	~DtRemoteGraphicVisualizerAttributes ()
	DTOR.
virtual void	setActive (bool active)
	Set the graphic active or inactive.
virtual void	setLayerName (const std::string &layerName)
	Sets the layer that the graphic is in.

Static Public Member Functions
static const DtStateVisualizer::TypeInfo &	theTypeInfo ()
	This class's type info.

Protected Member Functions
virtual void	setVisible (bool yesNo)
	Set the visuals visible or invisible.
virtual void	createModelAgents ()
	Create the visual models, or do nothing if they already exist.
virtual void	destroyModelAgents ()
	Destroy the visual models.
virtual void	setModelDefinitionForAgents ()
	Not implemented.
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
Dt3DSegmentedLineModelAgent *	myLineModelAgent
DtAttachableUpdaterAgent *	myUpdaterAgent
DtVisibilityAdapter < Dt3DSegmentedLineModelAgent > *	myVisibilityAdapter
bool	myVertex0Attached
bool	myVertex1Attached
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
Protected Attributes inherited from makVrv::DtRemoteGraphicVisualizerAttributes
bool	myActive
bool	myFlashing
std::vector< std::string >	myLayers
std::string	myLayerName
bool	myEnabled

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

Dt3DLineStateVisualizer objects are responsible for displaying 3D line objects.

Constructor & Destructor Documentation

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

Constructor.

virtual makVrv::Dt3DLineStateVisualizer::~Dt3DLineStateVisualizer ( )

virtual

Destructor.

Member Function Documentation

virtual void makVrv::Dt3DLineStateVisualizer::setStartLocation ( const DtVector &  pos )

virtual

Sets the start location (in database coordinates).

virtual void makVrv::Dt3DLineStateVisualizer::setEndLocation ( const DtVector &  endpoint )

virtual

Sets the end location (in database coordinates).

virtual void makVrv::Dt3DLineStateVisualizer::setFlashing ( bool  flashing )

virtual

Sets whether the line is flashing.

Implements makVrv::DtRemoteGraphicVisualizerAttributes.

virtual void makVrv::Dt3DLineStateVisualizer::setStyleSegments ( const std::vector< double > &  segmentPercentages )

virtual

Sets the percentages of line segments.

virtual void makVrv::Dt3DLineStateVisualizer::setSegmentColor ( unsigned int  segmentIndex, float  r, float  g, float  b, float  a  )

virtual

Sets the color of a particular segment.

virtual void makVrv::Dt3DLineStateVisualizer::setSegmentLightningStyle ( unsigned int  segmentIndex, bool  enableLightningStyle  )

virtual

Sets the lightning style of a particular segment.

virtual void makVrv::Dt3DLineStateVisualizer::setSegmentStartArrow ( unsigned int  segmentIndex, bool  enableArrow  )

virtual

Sets whether a particular segment has a start arrowhead.

virtual void makVrv::Dt3DLineStateVisualizer::setSegmentEndArrow ( unsigned int  segmentIndex, bool  enableArrow  )

virtual

Sets whether a particular segment has an end arrowhead.

virtual void makVrv::Dt3DLineStateVisualizer::setSegmentStipplePattern ( unsigned int  segmentIndex, unsigned int  stipplePattern  )

virtual

Sets the stipple pattern of a particular segment.

virtual void makVrv::Dt3DLineStateVisualizer::setSegmentWidth ( unsigned int  segmentIndex, double  width  )

virtual

Set the line width of a segment.

virtual void makVrv::Dt3DLineStateVisualizer::setStopOnTerrainIntersection ( bool  enabled )

virtual

Set whether or not to stop drawing the line at the first terrain intersection.

virtual void makVrv::Dt3DLineStateVisualizer::setAttached ( DtUniqueID  id, int  vtx, double  percentage  )

virtual

Attaches the cuboid to the unique ID specified.

Parameters

id	Unique ID of the object attached to, if 0, detaches
vtx	Vertex of the line (0 or 1) to attach
percentage	Specifies the percentage between 2 vertices if attached to a line or cylinder

virtual void makVrv::Dt3DLineStateVisualizer::setHostId ( const std::string &  id, int  vtx, double  percentage  )

virtual

Sets the host ID attached to. Overridden by child classes.

virtual void makVrv::Dt3DLineStateVisualizer::setOffset ( const DtVector &  offset )

virtual

Sets the offset (in body coordinates) of an attached line.

virtual void makVrv::Dt3DLineStateVisualizer::setProjected ( bool  projected )

virtual

Sets whether the line is projected above the terrain.

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

virtual

The instance's type info.

Implements makVrv::DtStateVisualizer.

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

static

This class's type info.

virtual void makVrv::Dt3DLineStateVisualizer::setVisible ( bool  yesNo )

protectedvirtual

Set the visuals visible or invisible.

This maintains the state of the visual objects, and calling setVisible(false) should not be expected to provide any performance benefit.

Implements makVrv::DtRemoteGraphicVisualizerAttributes.

virtual void makVrv::Dt3DLineStateVisualizer::createModelAgents ( )

protectedvirtual

Create the visual models, or do nothing if they already exist.

Reimplemented from makVrv::DtSceneObjectVisualizer.

virtual void makVrv::Dt3DLineStateVisualizer::destroyModelAgents ( )

protectedvirtual

Destroy the visual models.

This does not maintain their state; for example, calling setFlashing(true); destroyModelAgents(); createModelAgents(); will result in models with the default value of flashing, which is false.

Destroying models generally provides some performance benefit, as compared to calling setVisible(false).

Reimplemented from makVrv::DtSceneObjectVisualizer.

virtual void makVrv::Dt3DLineStateVisualizer::setModelDefinitionForAgents ( )

protectedvirtual

Not implemented.

Reimplemented from makVrv::DtSceneObjectVisualizer.

Member Data Documentation

Dt3DSegmentedLineModelAgent* makVrv::Dt3DLineStateVisualizer::myLineModelAgent

protected

DtAttachableUpdaterAgent* makVrv::Dt3DLineStateVisualizer::myUpdaterAgent

protected

DtVisibilityAdapter<Dt3DSegmentedLineModelAgent>* makVrv::Dt3DLineStateVisualizer::myVisibilityAdapter

protected

bool makVrv::Dt3DLineStateVisualizer::myVertex0Attached

protected

bool makVrv::Dt3DLineStateVisualizer::myVertex1Attached

protected

---

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

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