makVrv::Dt3DLineFacade Class Reference

Contains Dt3DLineFacade class. More...

Inheritance diagram for makVrv::Dt3DLineFacade:

Public Member Functions
	Dt3DLineFacade (DtAgentManagerInterface &, DtSceneObjectAgent *agent, DtElementID id, int modelSet)
	Constructor that will take an existing scene object agent.
	Dt3DLineFacade (DtAgentManagerInterface &, int modelSet, DtElementID id, bool distribute=true)
	Will create a new scene object agent for the given model set and element id.
virtual	~Dt3DLineFacade ()
	DTOR.
virtual void	setSolid (bool)
	Sets the line solid (true) or outlined (false). Default is true.
virtual void	setModelDefinition (const std::string &)
	Sets the model definition for the model.
virtual void	setColor (float r, float g, float b, float a)
	Sets the color for the line.
virtual void	setLineWidth (int)
	Sets the width of the outside line. Default is 2.
virtual void	setStipplePattern (unsigned int)
	Sets the pattern for the line portion of the line.
virtual void	setOcclusionEnabled (bool)
	Sets whether or not line is occluded. Default is true.
virtual void	setVisible (bool)
	Sets the object visible.
virtual void	setPickable (bool)
	Sets pickable or not.
virtual void	setSegmentEndArrow (int seg, bool flag)
	Sets arrow at end of segment.
virtual void	setSegmentStartArrow (int seg, bool flag)
	Sets arrow at end of segment.
virtual void	setArrowSize (double)
	Sets the size of the arrow (in pixels)
virtual void	setArrowStyle (vrvTacticalGraphicUtilities::ArrowStyle)
	Sets the style of arrow to use. Applies to all segments.
virtual void	setLineStyle (vrvTacticalGraphicUtilities::LineStyle s)
	Sets the style of th line via the agent.
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 void	setScribed (bool)
	Sets whether or not line is scribed.
virtual void	setScribeColor (float r, float g, float b, float a)
	Sets the color of the scribe. By default it is based on outside color at 0% alpha.
virtual void	setScribeWidth (float width)
	Sets the width of the scribe line in pixel space.
DtExtrudedLineModelAgent *	extrudedLineModelAgent () const
	Line model agent used by this class.
virtual void	setUpExtent (float)
virtual float	upExtent () const
virtual void	setDownExtent (float)
virtual float	downExtent () const
virtual void	setLeftExtent (float)
virtual float	leftExtent () const
virtual void	setRightExtent (float)
virtual float	rightExtent () const
virtual void	setDimensions (float w, float h)
Public Member Functions inherited from makVrv::DtLineFacadeBase
	DtLineFacadeBase (DtAgentManagerInterface &, DtSceneObjectAgent *agent, DtElementID id, int modelSet)
	Constructor that will take an existing scene object agent.
	DtLineFacadeBase (DtAgentManagerInterface &, int modelSet, DtElementID id, bool distribute=true)
	Will create a new scene object agent for the given model set and element id.
virtual	~DtLineFacadeBase ()
	DTOR.
virtual void	setPoints (const std::vector< DtVector > &, const DtVector &withOffset=DtVector::zero())
	Sets the points for the area.
virtual void	addPoint (int index, const DtVector &)
	Adds a point to the line. Returns the index of the newly added point.
virtual void	removePoint (int)
	Removes a point from the line.
virtual void	setOrigin (const DtVector &)
	Sets the origin of the line.
virtual const DtVector &	origin () const
virtual void	setPoint (int iIndex, const DtVector &)
	Sets position in the line.
virtual const std::vector < DtVector > &	points () const
	Returns the points of the facade.
virtual bool	pickable () const
	Returns whether or not item is pickable.
virtual vrvTacticalGraphicUtilities::LineStyle	lineStyle () const
	Returns the current line style.
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 vrvTacticalGraphicUtilities::ArrowStyle	arrowStyle () const
	Returns the arrow style.
virtual double	arrowSize () const
	Returns the size of the arrow.
virtual bool	fixedWidthSizing () const
	Returns whether or not line is using fixed width sizing.
virtual makVrv::DtUniqueID	uniqueId () const
	Returns the unique id of the scene object agent.
virtual makVrv::DtElementID	elementId () const
	Returns the element id of the scene object agent.
virtual int	modelSet () const
	Returns the model set.
DtSceneObjectAgent *	sceneObjectAgent () const
	Returns the scene object agent associated with this facade.

Protected Member Functions
void	createLineAgent ()
	Creates the line agent. Called from constructor.
Protected Member Functions inherited from makVrv::DtLineFacadeBase
virtual void	updateArrowFrequencyForSegment (int)
	Updates the arrow segments given the current arrow segment frequency for the given segment.

Protected Attributes
DtExtrudedLineModelAgent *	myLine
float	myUpExtent
float	myDownExtent
float	myRightExtent
float	myLeftExtent
bool	myScribeColorSet
float	myScribeWidth
Protected Attributes inherited from makVrv::DtLineFacadeBase
DtAgentManagerInterface &	myAgentManagerInterface
DtSceneObjectAgent *	mySceneObjectAgent
bool	myOwnsSceneObjectAgent
float	myColor [4]
int	myLineWidth
int	myModelSet
bool	mySelected
bool	myFixedWidthSizing
DtVector	myOrigin
std::vector< DtVector >	myControlPoints
vrvTacticalGraphicUtilities::ArrowStyle	myArrowStyle
vrvTacticalGraphicUtilities::ArrowHeadPlacement	myArrowHeadPlacement
vrvTacticalGraphicUtilities::LineStyle	myLineStyle
double	myArrowSize
bool	myPickable
bool	myVisible
makVrv::DtElementID	myElementId
bool	myScribed

Detailed Description

Contains Dt3DLineFacade class.

Facade interface for constructing 3D line objects

Constructor & Destructor Documentation

makVrv::Dt3DLineFacade::Dt3DLineFacade	(	DtAgentManagerInterface &	,
		DtSceneObjectAgent *	agent,
		DtElementID	id,
		int	modelSet
	)

Constructor that will take an existing scene object agent.

makVrv::Dt3DLineFacade::Dt3DLineFacade	(	DtAgentManagerInterface &	,
		int	modelSet,
		DtElementID	id,
		bool	distribute = true
	)

Will create a new scene object agent for the given model set and element id.

virtual makVrv::Dt3DLineFacade::~Dt3DLineFacade ( )

virtual

DTOR.

Member Function Documentation

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

virtual

Sets the line solid (true) or outlined (false). Default is true.

Implements makVrv::DtLineFacadeBase.

Reimplemented in makVrv::Dt3DAirCorridorLineFacade.

virtual void makVrv::Dt3DLineFacade::setModelDefinition ( const std::string &  )

virtual

Sets the model definition for the model.

Implements makVrv::DtLineFacadeBase.

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

virtual

Sets the color for the line.

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 from makVrv::DtLineFacadeBase.

Reimplemented in makVrv::Dt3DAirCorridorLineFacade.

virtual void makVrv::Dt3DLineFacade::setLineWidth ( int  )

virtual

Sets the width of the outside line. Default is 2.

Implements makVrv::DtLineFacadeBase.

Reimplemented in makVrv::Dt3DAirCorridorLineFacade.

virtual void makVrv::Dt3DLineFacade::setStipplePattern ( unsigned  int )

virtual

Sets the pattern for the line portion of the line.

Implements makVrv::DtLineFacadeBase.

Reimplemented in makVrv::Dt3DAirCorridorLineFacade.

virtual void makVrv::Dt3DLineFacade::setOcclusionEnabled ( bool  )

virtual

Sets whether or not line is occluded. Default is true.

Reimplemented in makVrv::Dt3DAirCorridorLineFacade.

virtual void makVrv::Dt3DLineFacade::setVisible ( bool  )

virtual

Sets the object visible.

Reimplemented from makVrv::DtLineFacadeBase.

Reimplemented in makVrv::Dt3DAirCorridorLineFacade.

virtual void makVrv::Dt3DLineFacade::setPickable ( bool  )

virtual

Sets pickable or not.

Reimplemented from makVrv::DtLineFacadeBase.

Reimplemented in makVrv::Dt3DAirCorridorLineFacade.

virtual void makVrv::Dt3DLineFacade::setSegmentEndArrow ( int  seg, bool  flag  )

virtual

Sets arrow at end of segment.

Implements makVrv::DtLineFacadeBase.

Reimplemented in makVrv::Dt3DAirCorridorLineFacade.

virtual void makVrv::Dt3DLineFacade::setSegmentStartArrow ( int  seg, bool  flag  )

virtual

Sets arrow at end of segment.

Implements makVrv::DtLineFacadeBase.

Reimplemented in makVrv::Dt3DAirCorridorLineFacade.

virtual void makVrv::Dt3DLineFacade::setArrowSize ( double  )

virtual

Sets the size of the arrow (in pixels)

Reimplemented from makVrv::DtLineFacadeBase.

Reimplemented in makVrv::Dt3DAirCorridorLineFacade.

virtual void makVrv::Dt3DLineFacade::setArrowStyle ( vrvTacticalGraphicUtilities::ArrowStyle  )

virtual

Sets the style of arrow to use. Applies to all segments.

Reimplemented from makVrv::DtLineFacadeBase.

Reimplemented in makVrv::Dt3DAirCorridorLineFacade.

virtual void makVrv::Dt3DLineFacade::setLineStyle ( vrvTacticalGraphicUtilities::LineStyle  s )

virtual

Sets the style of th line via the agent.

Reimplemented from makVrv::DtLineFacadeBase.

Reimplemented in makVrv::Dt3DAirCorridorLineFacade.

virtual void makVrv::Dt3DLineFacade::setFixedWidthSizing ( bool  )

virtual

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

Default is fixed width. If changing modes, be sure to change the arrow size

Reimplemented from makVrv::DtLineFacadeBase.

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

virtual

Sets whether or not line is scribed.

You will need to scribe a line if you want the edges of the line to appear separate from the body of the object. If you do not scribe the object the edges will be difficult to differentiate from the rest of the model

Reimplemented from makVrv::DtLineFacadeBase.

virtual void makVrv::Dt3DLineFacade::setUpExtent ( float  )

virtual

Sets the values of the extents of the line. Extents of the line are different than the width or height in that in setting the width or height those are centered around the points. The extents work from the point and move in the direction of the extent in topographic space. For example, if you imagine a straight line, the up extent moves straight up from that line, the down extent straight down, left to the left and right to the right. As the line rotates and orients the extents orient and rotate with that line

virtual float makVrv::Dt3DLineFacade::upExtent ( ) const

virtual

virtual void makVrv::Dt3DLineFacade::setDownExtent ( float  )

virtual

virtual float makVrv::Dt3DLineFacade::downExtent ( ) const

virtual

virtual void makVrv::Dt3DLineFacade::setLeftExtent ( float  )

virtual

virtual float makVrv::Dt3DLineFacade::leftExtent ( ) const

virtual

virtual void makVrv::Dt3DLineFacade::setRightExtent ( float  )

virtual

virtual float makVrv::Dt3DLineFacade::rightExtent ( ) const

virtual

virtual void makVrv::Dt3DLineFacade::setDimensions ( float  w, float  h  )

virtual

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

virtual

Sets the color of the scribe. By default it is based on outside color at 0% alpha.

virtual void makVrv::Dt3DLineFacade::setScribeWidth ( float  width )

virtual

Sets the width of the scribe line in pixel space.

This will set a flag such that when the line width is changed this width is not, so, once set, you will need to continue to set to keep pace with line width.

DtExtrudedLineModelAgent* makVrv::Dt3DLineFacade::extrudedLineModelAgent

(

)

const

Line model agent used by this class.

void makVrv::Dt3DLineFacade::createLineAgent ( )

protected

Creates the line agent. Called from constructor.

Member Data Documentation

DtExtrudedLineModelAgent* makVrv::Dt3DLineFacade::myLine

protected

float makVrv::Dt3DLineFacade::myUpExtent

protected

float makVrv::Dt3DLineFacade::myDownExtent

protected

float makVrv::Dt3DLineFacade::myRightExtent

protected

float makVrv::Dt3DLineFacade::myLeftExtent

protected

bool makVrv::Dt3DLineFacade::myScribeColorSet

protected

float makVrv::Dt3DLineFacade::myScribeWidth

protected

---

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

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