makVrf::Dt3DLineFacade Class Reference

Contains Dt3DLineFacade class. Facade interface for constructing 3D line objects.

Inheritance diagram for makVrf::Dt3DLineFacade:

Public Member Functions
	Dt3DLineFacade (makVrv::DtAgentManagerInterface &, makVrv::DtSceneObjectAgent *agent, makVrv::DtElementID id, int modelSet)
	Dt3DLineFacade (makVrv::DtAgentManagerInterface &, int modelSet, makVrv::DtElementID id, bool distribute=false)
virtual	~Dt3DLineFacade ()
virtual void	setSolid (bool)
virtual void	setModelDefinition (const std::string &)
virtual void	setLineWidth (int)
virtual void	setStipplePattern (unsigned int)
virtual void	setOcclusionEnabled (bool)
virtual void	setVisible (bool)
virtual void	setPickable (bool)
virtual void	setSegmentEndArrow (int seg, bool flag)
virtual void	setSegmentStartArrow (int seg, bool flag)
virtual void	setArrowSize (double)
virtual void	setArrowStyle (makVrv::vrvTacticalGraphicUtilities::ArrowStyle)
virtual void	setLineStyle (makVrv::vrvTacticalGraphicUtilities::LineStyle s)
virtual void	setFixedWidthSizing (bool)
virtual void	setScribed (bool)
virtual void	setColor (float r, float g, float b, float a)
virtual void	setSelectedColor (float r, float g, float b, float a)
virtual void	setScribeColor (float r, float g, float b, float a)
virtual void	setSelectedScribeColor (float r, float g, float b, float a)
virtual void	updateColors ()
virtual void	setScribeWidth (float width)
makVrv::DtExtrudedLineModelAgent *	extrudedLineModelAgent () const
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 makVrf::DtLineFacadeBase
	DtLineFacadeBase (makVrv::DtAgentManagerInterface &, makVrv::DtSceneObjectAgent *agent, makVrv::DtElementID id, int modelSet)
	DtLineFacadeBase (makVrv::DtAgentManagerInterface &, int modelSet, makVrv::DtElementID id, bool distribute=false)
virtual	~DtLineFacadeBase ()
virtual bool	selected ()
virtual void	setPoints (const std::vector< DtVector > &, const DtVector &withOffset=DtVector::zero())
virtual void	addPoint (int index, const DtVector &)
virtual void	removePoint (int)
virtual void	setOrigin (const DtVector &)
virtual const DtVector &	origin () const
virtual void	setPoint (int iIndex, const DtVector &)
virtual const std::vector < DtVector > &	points () const
virtual bool	pickable () const
virtual makVrv::vrvTacticalGraphicUtilities::LineStyle	lineStyle () const
virtual void	setArrowHeadPlacement (makVrv::vrvTacticalGraphicUtilities::ArrowHeadPlacement)
virtual makVrv::vrvTacticalGraphicUtilities::ArrowHeadPlacement	arrowHeadPlacement () const
virtual makVrv::vrvTacticalGraphicUtilities::ArrowStyle	arrowStyle () const
virtual double	arrowSize () const
virtual bool	fixedWidthSizing () const
virtual makVrv::DtUniqueID	uniqueId () const
virtual makVrv::DtElementID	elementId () const
virtual int	modelSet () const
virtual void	setSelected (bool selected)
makVrv::DtSceneObjectAgent *	sceneObjectAgent () const

Protected Member Functions
void	createLineAgent ()
Protected Member Functions inherited from makVrf::DtLineFacadeBase
virtual void	updateArrowFrequencyForSegment (int)

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

Constructor & Destructor Documentation

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

Constructor that will take an existing scene object agent.

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

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

virtual makVrf::Dt3DLineFacade::~Dt3DLineFacade ( )

virtual

DTOR.

Member Function Documentation

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

virtual

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

Implements makVrf::DtLineFacadeBase.

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

virtual

Sets the model definition for the model.

Implements makVrf::DtLineFacadeBase.

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

virtual

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

Implements makVrf::DtLineFacadeBase.

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

virtual

Sets the pattern for the line portion of the line.

Implements makVrf::DtLineFacadeBase.

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

virtual

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

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

virtual

Sets the object visible.

Reimplemented from makVrf::DtLineFacadeBase.

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

virtual

Sets pickable or not.

Reimplemented from makVrf::DtLineFacadeBase.

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

virtual

Sets arrow at end of segment.

Implements makVrf::DtLineFacadeBase.

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

virtual

Sets arrow at end of segment.

Implements makVrf::DtLineFacadeBase.

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

virtual

Sets the size of the arrow (in pixels)

Reimplemented from makVrf::DtLineFacadeBase.

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

virtual

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

Reimplemented from makVrf::DtLineFacadeBase.

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

virtual

Sets the style of th line via the agent.

Reimplemented from makVrf::DtLineFacadeBase.

virtual void makVrf::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 makVrf::DtLineFacadeBase.

virtual void makVrf::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 makVrf::DtLineFacadeBase.

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

virtual

Sets the current color of the line. Calls updateColors to pass down the new color to the model.

Reimplemented from makVrf::DtLineFacadeBase.

virtual void makVrf::Dt3DLineFacade::setSelectedColor ( float  r, float  g, float  b, float  a  )

virtual

Sets the current selected color of the line. Calls updateColors to pass down the new color to the model.

Reimplemented from makVrf::DtLineFacadeBase.

virtual void makVrf::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 makVrf::Dt3DLineFacade::upExtent ( ) const

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 void makVrf::Dt3DLineFacade::setDownExtent ( 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 makVrf::Dt3DLineFacade::downExtent ( ) const

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 void makVrf::Dt3DLineFacade::setLeftExtent ( 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 makVrf::Dt3DLineFacade::leftExtent ( ) const

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 void makVrf::Dt3DLineFacade::setRightExtent ( 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 makVrf::Dt3DLineFacade::rightExtent ( ) const

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 void makVrf::Dt3DLineFacade::setDimensions ( float  w, float  h  )

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 void makVrf::Dt3DLineFacade::setScribeColor ( float  r, float  g, float  b, float  a  )

virtual

Sets the color of the scribe. By default it is the same as the color.

virtual void makVrf::Dt3DLineFacade::setSelectedScribeColor ( float  r, float  g, float  b, float  a  )

virtual

Sets the selected color of the scribe. By default it is white.

virtual void makVrf::Dt3DLineFacade::updateColors ( )

virtual

send the colors down to the line model. Called when the object is selected or any of the colors change.

Implements makVrf::DtLineFacadeBase.

virtual void makVrf::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.

makVrv::DtExtrudedLineModelAgent* makVrf::Dt3DLineFacade::extrudedLineModelAgent

(

)

const

Line model agent used by this class.

void makVrf::Dt3DLineFacade::createLineAgent ( )

protected

Creates the line agent. Called from constructor.

Member Data Documentation

makVrv::DtExtrudedLineModelAgent* makVrf::Dt3DLineFacade::myLine

protected

float makVrf::Dt3DLineFacade::myUpExtent

protected

float makVrf::Dt3DLineFacade::myDownExtent

protected

float makVrf::Dt3DLineFacade::myRightExtent

protected

float makVrf::Dt3DLineFacade::myLeftExtent

protected

bool makVrf::Dt3DLineFacade::myScribeColorSet

protected

bool makVrf::Dt3DLineFacade::mySelectedColorSet

protected

float makVrf::Dt3DLineFacade::myScribeWidth

protected

float makVrf::Dt3DLineFacade::myScribedColor[4]

protected

float makVrf::Dt3DLineFacade::mySelectedScribedColor[4]

protected

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-0-branch/include/vrfGuiCore/3DLineFacade.h