makVrv::Dt2DBoxFacade Class Reference

Contains Dt2DBoxFacade class. More...

Inheritance diagram for makVrv::Dt2DBoxFacade:

Public Member Functions
	Dt2DBoxFacade (DtAgentManagerInterface &, DtSceneObjectAgent *agent, DtElementID id, int modelSet)
	Constructor that will take an existing scene object agent.
	Dt2DBoxFacade (DtAgentManagerInterface &, int modelSet, DtElementID id, bool distribute=true)
	Will create a new scene object agent for the given model set and element id.
virtual	~Dt2DBoxFacade ()
	DTOR.
virtual void	setOutsideColor (float r, float g, float b, float a)
	Sets the outside color (rim) if available.
virtual void	setInsideColor (float r, float g, float b, float a)
	Sets inside color (fill) if available.
virtual void	setFillPattern (const std::vector< unsigned int > &)
	Sets the pattern to fill the 2D polygon with.
virtual void	setSolid (bool)
	No-op. Use setFill to fill with solid color.
virtual void	startClamping ()
	Start/stop clamping box.
virtual void	stopClamping ()
Public Member Functions inherited from makVrv::DtBoxFacadeBase
	DtBoxFacadeBase (DtAgentManagerInterface &, DtSceneObjectAgent *agent, DtElementID id, int modelSet)
	Constructor that will take an existing scene object agent.
	DtBoxFacadeBase (DtAgentManagerInterface &, int modelSet, DtElementID id, bool distribute=true)
	Will create a new scene object agent for the given model set and element id.
virtual	~DtBoxFacadeBase ()
	DTOR.
virtual void	addPoint (int index, const DtVector &)
	Overridden to make sure no more than 4 points are added.
virtual void	setPoint (int iIndex, const DtVector &)
	Sets position box.
virtual void	removePoint (int)
	Overriden for no-op. Boxes cannot remove points.
virtual void	setPoints (const std::vector< DtVector > &, const DtVector &withOffset=DtVector::zero())
	Overriden to make sure there are exactly 4 points.
Public Member Functions inherited from makVrv::DtAreaFacadeBase
	DtAreaFacadeBase (DtAgentManagerInterface &, DtSceneObjectAgent *agent, DtElementID id, int modelSet)
	Constructor that will take an existing scene object agent.
	DtAreaFacadeBase (DtAgentManagerInterface &, int modelSet, DtElementID id, bool distribute=true)
	Will create a new scene object agent for the given model set and element id.
virtual	~DtAreaFacadeBase ()
	DTOR.
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 area.
virtual void	setLineWidth (int)
	Sets the width of the outside line. Default is 2.
virtual void	setFill (bool)
	Sets whether or not to fill area. If fill style of line is specified, will override this flag.
virtual void	setFillPattern (vrvTacticalGraphicUtilities::FillStyle)
	Sets the fill pattern for the area.
virtual void	setSelected (bool)
	Sets the area to be selected.
virtual void	setStipplePattern (int)
	Sets the pattern for the line portion of the area.
virtual void	resetOrigin ()
	Once the origin is set it cannot be changed, unless this method is called first.
virtual void	setOrigin (const DtVector &)
	Sets the origin of the area.
virtual const DtVector &	origin () const
	Returns origin.
virtual void	setScribed (bool)
	Sets whether or not line is scribed.
virtual void	setUseDynamicOrigin (bool)
	Sets whether or not to use dynamic origins.
virtual void	setVisible (bool)
	Sets the object visible.
virtual void	setPickable (bool)
	Sets pickable or not.
virtual const std::vector < DtVector > &	points () const
	Returns the points in this area.
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.
DtPolygonModelAgent *	polygonModelAgent () const
	Returns the polygon model agent created for this class.

Protected Member Functions
void	createBoxAgent ()
	Creates the agent used to display the box. Called from constructor.

Protected Attributes
DtOverlayPolygonModelAgent *	myPolygonAgent
DtBoxUpdaterAgent *	myUpdater

Detailed Description

Contains Dt2DBoxFacade class.

Facade for a 2D (overlay) box.

The points are laid out as 0 = upper left, 1 = upper right, 2 = lower right, 3 = lower left.

Constructor & Destructor Documentation

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

Constructor that will take an existing scene object agent.

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

virtual

DTOR.

Member Function Documentation

virtual void makVrv::Dt2DBoxFacade::setOutsideColor ( float  r, float  g, float  b, float  a  )

virtual

Sets the outside color (rim) if available.

Reimplemented from makVrv::DtAreaFacadeBase.

virtual void makVrv::Dt2DBoxFacade::setInsideColor ( float  r, float  g, float  b, float  a  )

virtual

Sets inside color (fill) if available.

Reimplemented from makVrv::DtAreaFacadeBase.

virtual void makVrv::Dt2DBoxFacade::setFillPattern ( const std::vector< unsigned int > &  )

virtual

Sets the pattern to fill the 2D polygon with.

The fill pattern is a bit pattern of 32 x 32 integers. The bits of the integers will be considered "on" if they are 1 and off if they are 0. The pattern will be repeated to fill the interior of the polygon

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

virtual

No-op. Use setFill to fill with solid color.

Reimplemented from makVrv::DtAreaFacadeBase.

virtual void makVrv::Dt2DBoxFacade::startClamping ( )

virtual

Start/stop clamping box.

virtual void makVrv::Dt2DBoxFacade::stopClamping ( )

virtual

void makVrv::Dt2DBoxFacade::createBoxAgent ( )

protected

Creates the agent used to display the box. Called from constructor.

Member Data Documentation

DtOverlayPolygonModelAgent* makVrv::Dt2DBoxFacade::myPolygonAgent

protected

DtBoxUpdaterAgent* makVrv::Dt2DBoxFacade::myUpdater

protected

---

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

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