Dt3DEnvironmentalLineVisualizer display a line drawn as a 3D line object. More...

Inheritance diagram for makVrv::Dt3DEnvironmentalLineVisualizer:

Public Member Functions
	Dt3DEnvironmentalLineVisualizer (DtBaseConnection &simulation, DtStateListener &listener, int modelSet)
	Constructor.
virtual	~Dt3DEnvironmentalLineVisualizer ()
	Destructor.
virtual const DtStateVisualizer::TypeInfo &	typeInfo () const
	The instance's type info.
virtual void	setPhysicalLineWidth (float)
	Width of the line in database space.
virtual void	setPhysicalLineHeight (double)
	Height of line. See comment for line width as to description;.
virtual void	setDimensions (double w, double h)
	Sets the dimensions (width/height) of the line.
virtual void	setScribeColor (float r, float g, float b, float a)
	Sets the color of the scribe line.
Public Member Functions inherited from makVrv::DtEnvironmentalLineVisualizer
	DtEnvironmentalLineVisualizer (DtBaseConnection &simulation, DtStateListener &listener, int modelSet)
	Constructor.
virtual	~DtEnvironmentalLineVisualizer ()
	Destructor.
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	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 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	setStipplePattern (unsigned short)
	Sets the stipple pattern style.
virtual unsigned short	lineStipple () const
	Returns the currently set stipple pattern.
virtual void	setPenStyle (vrvTacticalGraphicUtilities::PenStyle)
	Takes the pen style and translates it to a stipple pattern.
virtual void	setLineStyle (vrvTacticalGraphicUtilities::LineStyle)
	Sets the style of the line. See DtLineFacadeBase.h for styles.
virtual void	setPixelLineWidth (int)
	Sets the width of the outside line.
virtual void	setOrigin (const DtVector &)
	Sets the origin of the line.
virtual const DtVector &	origin () const
	Get the origin of the line.
virtual void	setArrowHeadPlacement (vrvTacticalGraphicUtilities::ArrowHeadPlacement)
	Sets how often the arrows should be displayed.
virtual vrvTacticalGraphicUtilities::ArrowHeadPlacement	arrowHeadPlacement () const
	Returns the current arrow head placement strategy.
virtual void	setArrowStyle (vrvTacticalGraphicUtilities::ArrowStyle)
	Sets the style of arrows for the line.
virtual vrvTacticalGraphicUtilities::ArrowStyle	arrowStyle () const
	Returns the arrow style.
virtual void	setArrowSize (double)
	Sets the size of the arrow. In 3D this is meters, in 2D this is pixels.
virtual double	arrowSize () const
	Returns the size of the awwow.
virtual void	setFixedWidthSizing (bool)
	For those lines that support it, whether or not the lines sizes when zooming to pixel space (fixed width) or to the database (non-fixed width).
virtual bool	fixedWidthSizing () const
	Returns whether or not this line will be sized with fixed width sizing.
virtual void	setScribed (bool)
	Sets whether or not the line is scribed.
virtual void	startAttached ()
	Starts the process of attachment by creating updater for attachment.
virtual void	endAttached ()
	Ends the attachment process.
DtLineFacadeBase *	lineFacade () const
	Line facade used by this class.
virtual void	setAttached (DtUniqueID)
	Sets this object to be attached to the specified object.
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.
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

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

Protected Member Functions
virtual void	setVisualizerDefinition (const DtVisualizerDefinition &visDef)
	Sets up some 3D specific items (line height, for example)
virtual DtLineFacadeBase *	createLineFacade ()
	Create the line facade that will render this line.
virtual void	setupLine ()
	Set up line information.
Protected Member Functions inherited from makVrv::DtEnvironmentalLineVisualizer
virtual void	destroyModelAgents ()
	Destroys any model agents currently created.
virtual void	setModelDefinitionForAgents ()
	Sets model definitions for agents.
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.
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
double	myPhysicalLineHeight
float	myPhysicalLineWidth
float	myScribeColor [4]
float	myScribedWidth
bool	myScribeColorSet
Protected Attributes inherited from makVrv::DtEnvironmentalLineVisualizer
DtTacticalGraphicStateListener &	myLineListener
DtLineFacadeBase *	myLineFacade
DtEnvironmentalStateListener::ControlPointsList	myControlPoints
int	myPixelLineWidth
DtVector	myPointOffset
bool	myOriginSet
DtVector	myOrigin
int	myDefaultLineWidth
float	myDefaultColor [4]
float	myColor [4]
vrvTacticalGraphicUtilities::ArrowStyle	myArrowStyle
vrvTacticalGraphicUtilities::ArrowHeadPlacement	myArrowHeadPlacement
vrvTacticalGraphicUtilities::LineStyle	myLineStyle
double	myArrowSize
unsigned short	myLineStipple
bool	myFixedWidthSizing
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

Dt3DEnvironmentalLineVisualizer display a line drawn as a 3D line object.

Use this if you want the line to be visible in 3D space. Do NOT use this class if your intent is to create a volumetric line (a line that has both volumetric width and height). If you wish to create a line that has both, use the Dt3DEnvironmentalVolumetricLine visualizer. If you use this class for a volumetric line the display will have volumes around each line segment rather than a smooth corridor for a line

Constructor & Destructor Documentation

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

Constructor.

virtual makVrv::Dt3DEnvironmentalLineVisualizer::~Dt3DEnvironmentalLineVisualizer ( )

virtual

Destructor.

Member Function Documentation

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

virtual

The instance's type info.

Implements makVrv::DtStateVisualizer.

Reimplemented in makVrv::Dt3DAirCorridorLineVisualizer.

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

static

This class's type info.

Reimplemented in makVrv::Dt3DAirCorridorLineVisualizer.

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

virtual

Width of the line in database space.

virtual void makVrv::Dt3DEnvironmentalLineVisualizer::setPhysicalLineHeight ( double )

virtual

Height of line. See comment for line width as to description;.

virtual void makVrv::Dt3DEnvironmentalLineVisualizer::setDimensions	(	double	w,
		double	h
	)

virtual

Sets the dimensions (width/height) of the line.

virtual void makVrv::Dt3DEnvironmentalLineVisualizer::setScribeColor	(	float	r,
		float	g,
		float	b,
		float	a
	)

virtual

Sets the color of the scribe line.

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

protectedvirtual

Sets up some 3D specific items (line height, for example)

Reimplemented from makVrv::DtEnvironmentalLineVisualizer.

Reimplemented in makVrv::Dt3DAirCorridorLineVisualizer.

virtual DtLineFacadeBase* makVrv::Dt3DEnvironmentalLineVisualizer::createLineFacade ( )

protectedvirtual

Create the line facade that will render this line.

Implements makVrv::DtEnvironmentalLineVisualizer.

Reimplemented in makVrv::Dt3DAirCorridorLineVisualizer.

virtual void makVrv::Dt3DEnvironmentalLineVisualizer::setupLine ( )

protectedvirtual

Set up line information.

Reimplemented from makVrv::DtEnvironmentalLineVisualizer.

Reimplemented in makVrv::DT_PROTOCOL_NAMESPACE::DtVrlink3DEnvironmentalLineVisualizer, and makVrv::Dt3DAirCorridorLineVisualizer.

Member Data Documentation

double makVrv::Dt3DEnvironmentalLineVisualizer::myPhysicalLineHeight

protected

float makVrv::Dt3DEnvironmentalLineVisualizer::myPhysicalLineWidth

protected

float makVrv::Dt3DEnvironmentalLineVisualizer::myScribeColor[4]

protected

float makVrv::Dt3DEnvironmentalLineVisualizer::myScribedWidth

protected

bool makVrv::Dt3DEnvironmentalLineVisualizer::myScribeColorSet

protected

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

/exports/nfedora7-1/nightly/docs/vrforcesDevelopment.vrf4-4-branch/include/vrvCore/Dt3DEnvironmentalLineVisualizer.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation