makVrv::DtLineFacadeInterface Class Reference

Contains DtLineFacadeInterface class. More...

Inheritance diagram for makVrv::DtLineFacadeInterface:

Public Member Functions
	DtLineFacadeInterface (DtAgentManagerInterface &, DtSceneObjectAgent *agent, DtElementID id, int modelSet)
	Constructor that will take an existing scene object agent.
	DtLineFacadeInterface (DtAgentManagerInterface &, int modelSet, DtElementID id, bool distribute=true)
	Will create a new scene object agent for the given model set and element id.
virtual	~DtLineFacadeInterface ()
	DTOR.
virtual void	setModelDefinition (const std::string &)=0
	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)=0
	Sets the width of the outside line. Default is 2.
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	setStipplePattern (unsigned int)=0
	Sets the pattern for the line portion of 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 void	setSolid (bool)=0
	Sets whether or not this is a solid item.
virtual void	setVisible (bool)
	Sets the object visible.
virtual const std::vector < DtVector > &	points () const
	Returns the points of the facade.
virtual void	setScribed (bool)
	Sets whether or not line is scribed.
virtual void	setPickable (bool)
	Sets whether or not item is pickable.
virtual bool	pickable () const
	Returns whether or not item is pickable.
virtual void	setLineStyle (vrvTacticalGraphicUtilities::LineStyle)
	Sets the style of line (default simple).
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 void	setArrowStyle (vrvTacticalGraphicUtilities::ArrowStyle)
	Sets the style of arrows for the line.
virtual vrvTacticalGraphicUtilities::ArrowStyle	arrowStyle () const
	Returns the arrow style.
virtual void	setSegmentEndArrow (int seg, bool flag)=0
	Sets arrow at end of segment.
virtual void	setSegmentStartArrow (int seg, bool flag)=0
	Sets arrow at start of segment.
virtual void	setArrowSize (double)
	Sets the size of the arrow (will mean pixels in fixed width mode and meters in variable width mode)
virtual double	arrowSize () const
	Returns the size of the arrow.
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 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.
virtual DtSceneObjectAgent *	sceneObjectAgent ()
	Returns the scene object agent associated with this facade.

Protected Member Functions
virtual void	updateArrowFrequencyForSegment (int)
	Updates the arrow segments given the current arrow segment frequency for the given segment.

Protected Attributes
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

Detailed Description

Contains DtLineFacadeInterface class.

Facade interface for constructing line objects

Constructor & Destructor Documentation

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

Constructor that will take an existing scene object agent.

makVrv::DtLineFacadeInterface::DtLineFacadeInterface	(	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::DtLineFacadeInterface::~DtLineFacadeInterface ( )

virtual

DTOR.

Member Function Documentation

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

pure virtual

Sets the model definition for the model.

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

virtual void makVrv::DtLineFacadeInterface::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 in makVrv::Dt2DAirCorridorLineFacade, makVrv::Dt3DAirCorridorLineFacade, makVrv::Dt2DLineFacade, and makVrv::Dt3DLineFacade.

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

pure virtual

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

Implemented in makVrv::Dt2DAirCorridorLineFacade, makVrv::Dt3DAirCorridorLineFacade, makVrv::Dt2DLineFacade, and makVrv::Dt3DLineFacade.

virtual void makVrv::DtLineFacadeInterface::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 makVrv::DtLineFacadeInterface::addPoint ( int  index, const DtVector &    )

virtual

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

Reimplemented in makVrv::Dt3DAirCorridorLineFacade, and makVrv::Dt2DAirCorridorLineFacade.

virtual void makVrv::DtLineFacadeInterface::removePoint ( int  )

virtual

Removes a point from the line.

Reimplemented in makVrv::Dt3DAirCorridorLineFacade, and makVrv::Dt2DAirCorridorLineFacade.

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

pure virtual

Sets the pattern for the line portion of the line.

Implemented in makVrv::Dt2DAirCorridorLineFacade, makVrv::Dt3DAirCorridorLineFacade, makVrv::Dt2DLineFacade, and makVrv::Dt3DLineFacade.

virtual void makVrv::DtLineFacadeInterface::setOrigin ( const DtVector &  )

virtual

Sets the origin of the line.

virtual const DtVector& makVrv::DtLineFacadeInterface::origin ( ) const

virtual

virtual void makVrv::DtLineFacadeInterface::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

Reimplemented in makVrv::Dt3DAirCorridorLineFacade, and makVrv::Dt2DAirCorridorLineFacade.

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

pure virtual

Sets whether or not this is a solid item.

Implemented in makVrv::Dt3DAirCorridorLineFacade, makVrv::Dt2DLineFacade, and makVrv::Dt3DLineFacade.

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

virtual

Sets the object visible.

Reimplemented in makVrv::Dt3DAirCorridorLineFacade, makVrv::Dt2DAirCorridorLineFacade, makVrv::Dt3DLineFacade, and makVrv::Dt2DLineFacade.

virtual const std::vector<DtVector>& makVrv::DtLineFacadeInterface::points ( ) const

virtual

Returns the points of the facade.

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

virtual

Sets whether or not line is scribed.

Default is to do nothing. Implemented by subclasses that support line scribing

Reimplemented in makVrv::Dt3DLineFacade.

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

virtual

Sets whether or not item is pickable.

Reimplemented in makVrv::Dt3DAirCorridorLineFacade, makVrv::Dt2DAirCorridorLineFacade, makVrv::Dt3DLineFacade, and makVrv::Dt2DLineFacade.

virtual bool makVrv::DtLineFacadeInterface::pickable ( ) const

virtual

Returns whether or not item is pickable.

virtual void makVrv::DtLineFacadeInterface::setLineStyle ( 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 makVrv::Dt2DAirCorridorLineFacade, makVrv::Dt3DAirCorridorLineFacade, makVrv::Dt3DLineFacade, and makVrv::Dt2DLineFacade.

virtual vrvTacticalGraphicUtilities::LineStyle makVrv::DtLineFacadeInterface::lineStyle ( ) const

virtual

Returns the current line style.

virtual void makVrv::DtLineFacadeInterface::setArrowHeadPlacement ( vrvTacticalGraphicUtilities::ArrowHeadPlacement  )

virtual

Sets how often the arrows should be displayed.

See Also

makVrv::vrvTacticalGraphicUtilities::ArrowHeadPlacement

virtual vrvTacticalGraphicUtilities::ArrowHeadPlacement makVrv::DtLineFacadeInterface::arrowHeadPlacement ( ) const

virtual

Returns the current arrow head placement strategy.

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

virtual

Sets the style of arrows for the line.

Reimplemented in makVrv::Dt3DAirCorridorLineFacade, makVrv::Dt2DAirCorridorLineFacade, makVrv::Dt3DLineFacade, and makVrv::Dt2DLineFacade.

virtual vrvTacticalGraphicUtilities::ArrowStyle makVrv::DtLineFacadeInterface::arrowStyle ( ) const

virtual

Returns the arrow style.

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

pure virtual

Sets arrow at end of segment.

Implemented in makVrv::Dt3DAirCorridorLineFacade, makVrv::Dt2DAirCorridorLineFacade, makVrv::Dt3DLineFacade, and makVrv::Dt2DLineFacade.

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

pure virtual

Sets arrow at start of segment.

Implemented in makVrv::Dt3DAirCorridorLineFacade, makVrv::Dt2DAirCorridorLineFacade, makVrv::Dt3DLineFacade, and makVrv::Dt2DLineFacade.

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

virtual

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

Reimplemented in makVrv::Dt3DAirCorridorLineFacade, makVrv::Dt2DAirCorridorLineFacade, makVrv::Dt3DLineFacade, and makVrv::Dt2DLineFacade.

virtual double makVrv::DtLineFacadeInterface::arrowSize ( ) const

virtual

Returns the size of the arrow.

virtual void makVrv::DtLineFacadeInterface::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 makVrv::Dt3DLineFacade, and makVrv::Dt2DLineFacade.

virtual bool makVrv::DtLineFacadeInterface::fixedWidthSizing ( ) const

virtual

Returns whether or not line is using fixed width sizing.

virtual makVrv::DtUniqueID makVrv::DtLineFacadeInterface::uniqueId ( ) const

virtual

Returns the unique id of the scene object agent.

virtual makVrv::DtElementID makVrv::DtLineFacadeInterface::elementId ( ) const

virtual

Returns the element id of the scene object agent.

virtual int makVrv::DtLineFacadeInterface::modelSet ( ) const

virtual

Returns the model set.

virtual DtSceneObjectAgent* makVrv::DtLineFacadeInterface::sceneObjectAgent ( )

virtual

Returns the scene object agent associated with this facade.

virtual void makVrv::DtLineFacadeInterface::updateArrowFrequencyForSegment ( int  )

protectedvirtual

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

Member Data Documentation

DtAgentManagerInterface& makVrv::DtLineFacadeInterface::myAgentManagerInterface

protected

DtSceneObjectAgent* makVrv::DtLineFacadeInterface::mySceneObjectAgent

protected

bool makVrv::DtLineFacadeInterface::myOwnsSceneObjectAgent

protected

float makVrv::DtLineFacadeInterface::myColor[4]

protected

int makVrv::DtLineFacadeInterface::myLineWidth

protected

int makVrv::DtLineFacadeInterface::myModelSet

protected

bool makVrv::DtLineFacadeInterface::mySelected

protected

bool makVrv::DtLineFacadeInterface::myFixedWidthSizing

protected

DtVector makVrv::DtLineFacadeInterface::myOrigin

protected

std::vector<DtVector> makVrv::DtLineFacadeInterface::myControlPoints

protected

vrvTacticalGraphicUtilities::ArrowStyle makVrv::DtLineFacadeInterface::myArrowStyle

protected

vrvTacticalGraphicUtilities::ArrowHeadPlacement makVrv::DtLineFacadeInterface::myArrowHeadPlacement

protected

vrvTacticalGraphicUtilities::LineStyle makVrv::DtLineFacadeInterface::myLineStyle

protected

double makVrv::DtLineFacadeInterface::myArrowSize

protected

bool makVrv::DtLineFacadeInterface::myPickable

protected

bool makVrv::DtLineFacadeInterface::myVisible

protected

makVrv::DtElementID makVrv::DtLineFacadeInterface::myElementId

protected

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.vrf4-3-branch/include/vrvCore/DtLineFacadeInterface.h