Contains DtAreaFacadeInterface class. More...

Inheritance diagram for makVrv::DtAreaFacadeInterface:

Public Member Functions
	DtAreaFacadeInterface (DtAgentManagerInterface &, DtSceneObjectAgent *agent, DtElementID id, int modelSet)
	Constructor that will take an existing scene object agent.
	DtAreaFacadeInterface (DtAgentManagerInterface &, int modelSet, DtElementID id, bool distribute=true)
	Will create a new scene object agent for the given model set and element id.
virtual	~DtAreaFacadeInterface ()
	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	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 area. Returns the index of the newly added point. Index of -1 will append.
virtual void	setSelected (bool)
	Sets the area to be selected.
virtual void	removePoint (int)
	Removes a point from the area.
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	setPoint (int iIndex, const DtVector &)
	Sets position in the area.
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	setLockUpdates (bool)
	Sets whether or not to lock updates.
virtual bool	updatesLocked () const
	Returns whether or not updates are locked.
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.
virtual void	setScribed (bool)
	Sets whether or not line is scribed.
virtual DtSceneObjectAgent *	sceneObjectAgent ()
	Returns the scene object agent associated with this facade.

Protected Attributes
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	myUpdatesLocked
bool	mySelected
makVrv::DtElementID	myElementId

Detailed Description

Contains DtAreaFacadeInterface class.

Facade interface for constructing area objects

Constructor & Destructor Documentation

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

Constructor that will take an existing scene object agent.

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

virtual

DTOR.

Member Function Documentation

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

virtual

Sets the model definition for the model.

virtual void makVrv::DtAreaFacadeInterface::setColor	(	float	r,
		float	g,
		float	b,
		float	a
	)

virtual

Sets the color for the area.

This will apply to all segments of the area. If the default (all 0's), uses the default as defined in the visual definition

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

virtual

Sets the outside color (rim) if available.

Reimplemented in makVrv::Dt2DAreaFacade, makVrv::Dt3DAreaFacade, and makVrv::Dt2DBoxFacade.

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

virtual

Sets inside color (fill) if available.

Reimplemented in makVrv::Dt2DAreaFacade, makVrv::Dt3DAreaFacade, and makVrv::Dt2DBoxFacade.

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

virtual

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

Reimplemented in makVrv::Dt3DAreaFacade.

virtual void makVrv::DtAreaFacadeInterface::setFill ( bool )

virtual

Sets whether or not to fill area. If fill style of line is specified, will override this flag.

virtual void makVrv::DtAreaFacadeInterface::setFillPattern ( vrvTacticalGraphicUtilities::FillStyle )

virtual

Sets the fill pattern for the area.

Note that this will also set the fill to be true if the fill pattern is one that will map to a valid fill pattern. This will be implemented by sub-classes as this feature is subclass specific

Reimplemented in makVrv::Dt2DAreaFacade.

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

Reimplemented in makVrv::DtBoxFacadeInterface.

virtual void makVrv::DtAreaFacadeInterface::addPoint	(	int	index,
		const DtVector &
	)

virtual

Adds a point to the area. Returns the index of the newly added point. Index of -1 will append.

Reimplemented in makVrv::DtBoxFacadeInterface.

virtual void makVrv::DtAreaFacadeInterface::setSelected ( bool )

virtual

Sets the area to be selected.

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

virtual

Removes a point from the area.

Reimplemented in makVrv::DtBoxFacadeInterface.

virtual void makVrv::DtAreaFacadeInterface::setStipplePattern ( int )

virtual

Sets the pattern for the line portion of the area.

virtual void makVrv::DtAreaFacadeInterface::resetOrigin ( )

virtual

Once the origin is set it cannot be changed, unless this method is called first.

Call resetOrigin to make a future call to setOrigin reset the origin

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

virtual

Sets the origin of the area.

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

virtual

Returns origin.

virtual void makVrv::DtAreaFacadeInterface::setPoint	(	int	iIndex,
		const DtVector &
	)

virtual

Sets position in the area.

If index is not within the current bound of the number of points then no action is taken

Reimplemented in makVrv::DtBoxFacadeInterface.

virtual void makVrv::DtAreaFacadeInterface::setUseDynamicOrigin ( bool )

virtual

Sets whether or not to use dynamic origins.

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

virtual

Sets whether or not this is a solid item.

Reimplemented in makVrv::Dt3DAreaFacade, and makVrv::Dt2DAreaFacade.

virtual void makVrv::DtAreaFacadeInterface::setLockUpdates ( bool )

virtual

Sets whether or not to lock updates.

virtual bool makVrv::DtAreaFacadeInterface::updatesLocked ( ) const

virtual

Returns whether or not updates are locked.

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

virtual

Sets the object visible.

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

virtual

Sets pickable or not.

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

virtual

Returns the points in this area.

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

virtual

Returns the unique id of the scene object agent.

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

virtual

Returns the element id of the scene object agent.

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

virtual

Returns the model set.

virtual void makVrv::DtAreaFacadeInterface::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::Dt3DAreaFacade.

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

virtual

Returns the scene object agent associated with this facade.

Member Data Documentation

DtPolygonModelAgent* makVrv::DtAreaFacadeInterface::myArea

protected

DtAgentManagerInterface& makVrv::DtAreaFacadeInterface::myAgentManagerInterface

protected

DtSceneObjectAgent* makVrv::DtAreaFacadeInterface::mySceneObjectAgent

protected

bool makVrv::DtAreaFacadeInterface::myOwnsSceneObjectAgent

protected

float makVrv::DtAreaFacadeInterface::myOutsideColor[4]

protected

float makVrv::DtAreaFacadeInterface::myInsideColor[4]

protected

int makVrv::DtAreaFacadeInterface::myLineWidth

protected

int makVrv::DtAreaFacadeInterface::myModelSet

protected

bool makVrv::DtAreaFacadeInterface::myFill

protected

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

protected

bool makVrv::DtAreaFacadeInterface::myOriginSet

protected

DtVector makVrv::DtAreaFacadeInterface::myOrigin

protected

bool makVrv::DtAreaFacadeInterface::myUpdatesLocked

protected

bool makVrv::DtAreaFacadeInterface::mySelected

protected

makVrv::DtElementID makVrv::DtAreaFacadeInterface::myElementId

protected

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

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

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation