makVrf::DtLineFacadeBase Class Reference

Contains DtLineFacadeBase class. Facade interface for constructing line objects.

Inheritance diagram for makVrf::DtLineFacadeBase:

Public Member Functions
	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 void	setModelDefinition (const std::string &)=0
virtual void	setColor (float r, float g, float b, float a)
virtual void	setSelectedColor (float r, float g, float b, float a)
virtual bool	selected ()
virtual void	setLineWidth (int)=0
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	setStipplePattern (unsigned int)=0
virtual void	setOrigin (const DtVector &)
virtual const DtVector &	origin () const
virtual void	setPoint (int iIndex, const DtVector &)
virtual void	setSolid (bool)=0
virtual void	setVisible (bool)
virtual const std::vector < DtVector > &	points () const
virtual void	setScribed (bool)
virtual void	setPickable (bool)
virtual bool	pickable () const
virtual void	setLineStyle (makVrv::vrvTacticalGraphicUtilities::LineStyle)
virtual makVrv::vrvTacticalGraphicUtilities::LineStyle	lineStyle () const
virtual void	setArrowHeadPlacement (makVrv::vrvTacticalGraphicUtilities::ArrowHeadPlacement)
virtual makVrv::vrvTacticalGraphicUtilities::ArrowHeadPlacement	arrowHeadPlacement () const
virtual void	setArrowStyle (makVrv::vrvTacticalGraphicUtilities::ArrowStyle)
virtual makVrv::vrvTacticalGraphicUtilities::ArrowStyle	arrowStyle () const
virtual void	setSegmentEndArrow (int seg, bool flag)=0
virtual void	setSegmentStartArrow (int seg, bool flag)=0
virtual void	setArrowSize (double)
virtual double	arrowSize () const
virtual void	setFixedWidthSizing (bool)
virtual bool	fixedWidthSizing () const
virtual makVrv::DtUniqueID	uniqueId () const
virtual makVrv::DtElementID	elementId () const
virtual int	modelSet () const
virtual void	setSelected (bool selected)
virtual void	updateColors ()=0
makVrv::DtSceneObjectAgent *	sceneObjectAgent () const

Protected Member Functions
virtual void	updateArrowFrequencyForSegment (int)

Protected Attributes
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::DtLineFacadeBase::DtLineFacadeBase	(	makVrv::DtAgentManagerInterface &	,
		makVrv::DtSceneObjectAgent *	agent,
		makVrv::DtElementID	id,
		int	modelSet
	)

Constructor that will take an existing scene object agent.

makVrf::DtLineFacadeBase::DtLineFacadeBase	(	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::DtLineFacadeBase::~DtLineFacadeBase ( )

virtual

DTOR.

Member Function Documentation

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

pure virtual

Sets the model definition for the model.

Implemented in makVrf::Dt2DLineFacade, and makVrf::Dt3DLineFacade.

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

Reimplemented in makVrf::Dt3DLineFacade.

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

virtual

Sets the selected color for the line. When a line is selected then it will use this color instead.

Reimplemented in makVrf::Dt3DLineFacade.

virtual bool makVrf::DtLineFacadeBase::selected ( )

virtual

Gets the current seletion state for the facade.

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

pure virtual

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

Implemented in makVrf::Dt2DLineFacade, and makVrf::Dt3DLineFacade.

virtual void makVrf::DtLineFacadeBase::setPoints ( const std::vector< DtVector > &  , const DtVector &  withOffset = DtVector::zero()  )

virtual

Sets the points for the area. If withOffset is specified, the offset is added to the supplied points.

virtual void makVrf::DtLineFacadeBase::addPoint ( int  index, const DtVector &    )

virtual

Adds a point to the line. Returns the index of the newly added point.

virtual void makVrf::DtLineFacadeBase::removePoint ( int  )

virtual

Removes a point from the line.

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

pure virtual

Sets the pattern for the line portion of the line.

Implemented in makVrf::Dt2DLineFacade, and makVrf::Dt3DLineFacade.

virtual void makVrf::DtLineFacadeBase::setOrigin ( const DtVector &  )

virtual

Sets the origin of the line.

virtual const DtVector& makVrf::DtLineFacadeBase::origin ( ) const

virtual

virtual void makVrf::DtLineFacadeBase::setPoint ( int  iIndex, const DtVector &    )

virtual

Sets position in the line. If the index is > the number of current points on the line the point array is resized to the size of the index.

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

pure virtual

Sets whether or not this is a solid item.

Implemented in makVrf::Dt2DLineFacade, and makVrf::Dt3DLineFacade.

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

virtual

Sets the object visible.

Reimplemented in makVrf::Dt3DLineFacade, and makVrf::Dt2DLineFacade.

virtual const std::vector<DtVector>& makVrf::DtLineFacadeBase::points ( ) const

virtual

Returns the points of the facade.

virtual void makVrf::DtLineFacadeBase::setScribed ( bool  )

virtual

Sets whether or not line is scribed. Default is to do nothing. Implemented by subclasses that support line scribing.

Reimplemented in makVrf::Dt3DLineFacade.

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

virtual

Sets whether or not item is pickable.

Reimplemented in makVrf::Dt3DLineFacade, and makVrf::Dt2DLineFacade.

virtual bool makVrf::DtLineFacadeBase::pickable ( ) const

virtual

Returns whether or not item is pickable.

virtual void makVrf::DtLineFacadeBase::setLineStyle ( makVrv::vrvTacticalGraphicUtilities::LineStyle  )

virtual

Sets the style of line (default simple). The line style will map to internal factory of line styles to transform the line points into the final line style.

Reimplemented in makVrf::Dt3DLineFacade, and makVrf::Dt2DLineFacade.

virtual makVrv::vrvTacticalGraphicUtilities::LineStyle makVrf::DtLineFacadeBase::lineStyle ( ) const

virtual

Returns the current line style.

virtual void makVrf::DtLineFacadeBase::setArrowHeadPlacement ( makVrv::vrvTacticalGraphicUtilities::ArrowHeadPlacement  )

virtual

Sets how often the arrows should be displayed.

See Also

makVrv::vrvTacticalGraphicUtilities::ArrowHeadPlacement

virtual makVrv::vrvTacticalGraphicUtilities::ArrowHeadPlacement makVrf::DtLineFacadeBase::arrowHeadPlacement ( ) const

virtual

Returns the current arrow head placement strategy.

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

virtual

Sets the style of arrows for the line.

Reimplemented in makVrf::Dt3DLineFacade, and makVrf::Dt2DLineFacade.

virtual makVrv::vrvTacticalGraphicUtilities::ArrowStyle makVrf::DtLineFacadeBase::arrowStyle ( ) const

virtual

Returns the arrow style.

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

pure virtual

Sets arrow at end of segment.

Implemented in makVrf::Dt3DLineFacade, and makVrf::Dt2DLineFacade.

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

pure virtual

Sets arrow at start of segment.

Implemented in makVrf::Dt3DLineFacade, and makVrf::Dt2DLineFacade.

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

virtual

Sets the size of the arrow (will mean pixels in fixed width mode and meters in variable width mode)

Reimplemented in makVrf::Dt3DLineFacade, and makVrf::Dt2DLineFacade.

virtual double makVrf::DtLineFacadeBase::arrowSize ( ) const

virtual

Returns the size of the arrow.

virtual void makVrf::DtLineFacadeBase::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 in makVrf::Dt3DLineFacade, and makVrf::Dt2DLineFacade.

virtual bool makVrf::DtLineFacadeBase::fixedWidthSizing ( ) const

virtual

Returns whether or not line is using fixed width sizing.

virtual makVrv::DtUniqueID makVrf::DtLineFacadeBase::uniqueId ( ) const

virtual

Returns the unique id of the scene object agent.

virtual makVrv::DtElementID makVrf::DtLineFacadeBase::elementId ( ) const

virtual

Returns the element id of the scene object agent.

virtual int makVrf::DtLineFacadeBase::modelSet ( ) const

virtual

Returns the model set.

virtual void makVrf::DtLineFacadeBase::setSelected ( bool  selected )

virtual

Set the current selected state. Also calls updateColors() to update the model with the correct color.

virtual void makVrf::DtLineFacadeBase::updateColors ( )

pure virtual

called whenever a color or the mySelected changes so the model can be updated with the correct color.

Implemented in makVrf::Dt3DLineFacade, and makVrf::Dt2DLineFacade.

makVrv::DtSceneObjectAgent* makVrf::DtLineFacadeBase::sceneObjectAgent

(

)

const

Returns the scene object agent associated with this facade.

virtual void makVrf::DtLineFacadeBase::updateArrowFrequencyForSegment ( int  )

protectedvirtual

Updates the arrow segments given the current arrow segment frequency for the given segment.

Member Data Documentation

makVrv::DtAgentManagerInterface& makVrf::DtLineFacadeBase::myAgentManagerInterface

protected

makVrv::DtSceneObjectAgent* makVrf::DtLineFacadeBase::mySceneObjectAgent

protected

bool makVrf::DtLineFacadeBase::myOwnsSceneObjectAgent

protected

float makVrf::DtLineFacadeBase::myColor[4]

protected

float makVrf::DtLineFacadeBase::mySelectedColor[4]

protected

int makVrf::DtLineFacadeBase::myLineWidth

protected

int makVrf::DtLineFacadeBase::myModelSet

protected

bool makVrf::DtLineFacadeBase::mySelected

protected

bool makVrf::DtLineFacadeBase::myFixedWidthSizing

protected

DtVector makVrf::DtLineFacadeBase::myOrigin

protected

std::vector<DtVector> makVrf::DtLineFacadeBase::myControlPoints

protected

makVrv::vrvTacticalGraphicUtilities::ArrowStyle makVrf::DtLineFacadeBase::myArrowStyle

protected

makVrv::vrvTacticalGraphicUtilities::ArrowHeadPlacement makVrf::DtLineFacadeBase::myArrowHeadPlacement

protected

makVrv::vrvTacticalGraphicUtilities::LineStyle makVrf::DtLineFacadeBase::myLineStyle

protected

double makVrf::DtLineFacadeBase::myArrowSize

protected

bool makVrf::DtLineFacadeBase::myPickable

protected

bool makVrf::DtLineFacadeBase::myVisible

protected

makVrv::DtElementID makVrf::DtLineFacadeBase::myElementId

protected

bool makVrf::DtLineFacadeBase::myScribed

protected

---

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

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