This class will expose some members that are necessary to be considered a 3D Area interface. More...

Inheritance diagram for makVrv::Dt3DBoxFacadeBase:

Public Member Functions
	Dt3DBoxFacadeBase (DtAgentManagerInterface &, DtSceneObjectAgent *agent, DtElementID id, int modelSet)
	Constructor that will take an existing scene object agent.
	Dt3DBoxFacadeBase (DtAgentManagerInterface &, int modelSet, DtElementID id, bool distribute=true)
	Will create a new scene object agent for the given model set and element id.
virtual	~Dt3DBoxFacadeBase ()
	DTOR.
virtual void	setScribeColor (float r, float g, float b, float a)=0
	Sets the color of the scribe. By default it is based on outside color at 0% alpha.
virtual void	setScribeAllPolygons (bool)=0
	Sets whether or not to only scribe the outline (and not the line edges).
virtual void	setScribeWidth (float width)=0
	Sets the width of the scribe line in pixel space.

virtual void	setUpExtent (float)=0
virtual float	upExtent () const =0
virtual void	setDownExtent (float)=0
virtual float	downExtent () const =0
virtual void	setLeftExtent (float)=0
virtual float	leftExtent () const =0
virtual void	setRightExtent (float)=0
virtual float	rightExtent () const =0
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	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	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	setSolid (bool)
	Sets whether or not this is a solid item.
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.

Additional Inherited Members
Protected Attributes inherited from makVrv::DtAreaFacadeBase
DtPolygonModelAgent *	myArea
DtAgentManagerInterface &	myAgentManagerInterface
DtSceneObjectAgent *	mySceneObjectAgent
bool	myOwnsSceneObjectAgent
float	myOutsideColor [4]
float	myInsideColor [4]
int	myLineWidth
int	myModelSet
bool	myFill
std::vector< DtVector >	myControlPoints
bool	myOriginSet
DtVector	myOrigin
bool	mySelected
bool	myScribed
makVrv::DtElementID	myElementId

Detailed Description

This class will expose some members that are necessary to be considered a 3D Area interface.

Constructor & Destructor Documentation

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

Constructor that will take an existing scene object agent.

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

virtual

DTOR.

Member Function Documentation

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

pure 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

Implemented in makVrv::Dt3DBoxFacade.

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

pure virtual

Implemented in makVrv::Dt3DBoxFacade.

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

pure virtual

Implemented in makVrv::Dt3DBoxFacade.

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

pure virtual

Implemented in makVrv::Dt3DBoxFacade.

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

pure virtual

Implemented in makVrv::Dt3DBoxFacade.

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

pure virtual

Implemented in makVrv::Dt3DBoxFacade.

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

pure virtual

Implemented in makVrv::Dt3DBoxFacade.

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

pure virtual

Implemented in makVrv::Dt3DBoxFacade.

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

pure virtual

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

Implemented in makVrv::Dt3DBoxFacade.

virtual void makVrv::Dt3DBoxFacadeBase::setScribeAllPolygons ( bool )

pure virtual

Sets whether or not to only scribe the outline (and not the line edges).

Only valid if scribed is true. If set to true will scribe all point connections along the polygon. If false will only scribe the top and bottom of the polygon

Implemented in makVrv::Dt3DBoxFacade.

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

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

Implemented in makVrv::Dt3DBoxFacade.

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

/exports/nfedora7-1/nightly/docs/vrforcesDevelopment.vrf4-6-branch/include/vrvCore/DtBoxFacadeBase.h

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation