Contains DtAreaFacadeBase class. Facade base for constructing area objects.

Inheritance diagram for makVrf::DtAreaFacadeBase:

Public Member Functions
	DtAreaFacadeBase (makVrv::DtAgentManagerInterface &, makVrv::DtSceneObjectAgent *agent, makVrv::DtElementID id, int modelSet)

	DtAreaFacadeBase (makVrv::DtAgentManagerInterface &, int modelSet, makVrv::DtElementID id, bool distribute=false)

virtual	~DtAreaFacadeBase ()

virtual void	setModelDefinition (const std::string &)

virtual void	setColor (float r, float g, float b, float a)

virtual void	setOutsideColor (float r, float g, float b, float a)

virtual void	setSelectedOutsideColor (float r, float g, float b, float a)

virtual void	setInsideColor (float r, float g, float b, float a)

virtual void	setSelectedInsideColor (float r, float g, float b, float a)

virtual void	setLineWidth (int)

virtual void	setFill (bool)

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

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

virtual void	addPoint (int index, const DtVector &)

virtual void	setSelected (bool)

virtual bool	selected ()

virtual void	removePoint (int)

virtual void	setStipplePattern (int)

virtual void	resetOrigin ()

virtual void	setOrigin (const DtVector &)

virtual const DtVector &	origin () const

virtual void	setScribed (bool)

virtual void	setPoint (int iIndex, const DtVector &)

virtual void	setUseDynamicOrigin (bool)

virtual void	setSolid (bool)

virtual void	setVisible (bool)

virtual void	setPickable (bool)

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

virtual makVrv::DtUniqueID	uniqueId () const

virtual makVrv::DtElementID	elementId () const

virtual int	modelSet () const

makVrv::DtSceneObjectAgent *	sceneObjectAgent () const

makVrv::DtPolygonModelAgent *	polygonModelAgent () const

virtual void	updateColors ()=0

Protected Attributes
makVrv::DtPolygonModelAgent *	myArea

makVrv::DtAgentManagerInterface &	myAgentManagerInterface

makVrv::DtSceneObjectAgent *	mySceneObjectAgent

bool	myOwnsSceneObjectAgent

float	myOutsideColor [4]

float	myInsideColor [4]

float	mySelectedOutsideColor [4]

float	mySelectedInsideColor [4]

bool	mySelectedInsideColorSet

int	myLineWidth

int	myModelSet

bool	myFill

std::vector< DtVector >	myControlPoints

bool	myOriginSet

DtVector	myOrigin

bool	mySelected

bool	myScribed

makVrv::DtElementID	myElementId

Constructor & Destructor Documentation

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

Constructor that will take an existing scene object agent.

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

virtual

DTOR.

Member Function Documentation

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

virtual

Sets the model definition for the model.

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

virtual void makVrf::DtAreaFacadeBase::setOutsideColor	(	float	r,
		float	g,
		float	b,
		float	a
	)

virtual

Sets the outside color (rim) if available.

Reimplemented in makVrf::Dt3DAreaFacade.

virtual void makVrf::DtAreaFacadeBase::setSelectedOutsideColor	(	float	r,
		float	g,
		float	b,
		float	a
	)

virtual

Sets the selected outside color. This color is used if the object is selected.

Reimplemented in makVrf::Dt3DAreaFacade.

virtual void makVrf::DtAreaFacadeBase::setInsideColor	(	float	r,
		float	g,
		float	b,
		float	a
	)

virtual

Sets inside color (fill) if available.

virtual void makVrf::DtAreaFacadeBase::setSelectedInsideColor	(	float	r,
		float	g,
		float	b,
		float	a
	)

virtual

Sets the selected inside color.

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

virtual

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

Reimplemented in makVrf::Dt3DAreaFacade.

virtual void makVrf::DtAreaFacadeBase::setFill ( bool )

virtual

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

virtual void makVrf::DtAreaFacadeBase::setFillPattern ( makVrv::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 makVrf::Dt2DAreaFacade.

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

virtual void makVrf::DtAreaFacadeBase::setSelected ( bool )

virtual

Sets the area to be selected.

virtual bool makVrf::DtAreaFacadeBase::selected ( )

virtual

Get the current selected state.

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

virtual

Removes a point from the area.

virtual void makVrf::DtAreaFacadeBase::setStipplePattern ( int )

virtual

Sets the pattern for the line portion of the area.

virtual void makVrf::DtAreaFacadeBase::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 makVrf::DtAreaFacadeBase::setOrigin ( const DtVector & )

virtual

Sets the origin of the area.

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

virtual

Returns origin.

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

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

virtual void makVrf::DtAreaFacadeBase::setUseDynamicOrigin ( bool )

virtual

Sets whether or not to use dynamic origins.

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

virtual

Sets whether or not this is a solid item.

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

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

virtual

Sets the object visible.

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

virtual

Sets pickable or not.

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

virtual

Returns the points in this area.

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

virtual

Returns the unique id of the scene object agent.

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

virtual

Returns the element id of the scene object agent.

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

virtual

Returns the model set.

makVrv::DtSceneObjectAgent* makVrf::DtAreaFacadeBase::sceneObjectAgent ( ) const

Returns the scene object agent associated with this facade.

makVrv::DtPolygonModelAgent* makVrf::DtAreaFacadeBase::polygonModelAgent ( ) const

Returns the polygon model agent created for this class.

virtual void makVrf::DtAreaFacadeBase::updateColors ( )

pure virtual

pass the current color based on selection down to the model

Implemented in makVrf::Dt3DAreaFacade, and makVrf::Dt2DAreaFacade.

Member Data Documentation

makVrv::DtPolygonModelAgent* makVrf::DtAreaFacadeBase::myArea

protected

makVrv::DtAgentManagerInterface& makVrf::DtAreaFacadeBase::myAgentManagerInterface

protected

makVrv::DtSceneObjectAgent* makVrf::DtAreaFacadeBase::mySceneObjectAgent

protected

bool makVrf::DtAreaFacadeBase::myOwnsSceneObjectAgent

protected

float makVrf::DtAreaFacadeBase::myOutsideColor[4]

protected

float makVrf::DtAreaFacadeBase::myInsideColor[4]

protected

float makVrf::DtAreaFacadeBase::mySelectedOutsideColor[4]

protected

float makVrf::DtAreaFacadeBase::mySelectedInsideColor[4]

protected

bool makVrf::DtAreaFacadeBase::mySelectedInsideColorSet

protected

int makVrf::DtAreaFacadeBase::myLineWidth

protected

int makVrf::DtAreaFacadeBase::myModelSet

protected

bool makVrf::DtAreaFacadeBase::myFill

protected

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

protected

bool makVrf::DtAreaFacadeBase::myOriginSet

protected

DtVector makVrf::DtAreaFacadeBase::myOrigin

protected

bool makVrf::DtAreaFacadeBase::mySelected

protected

bool makVrf::DtAreaFacadeBase::myScribed

protected

makVrv::DtElementID makVrf::DtAreaFacadeBase::myElementId

protected

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

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

Public Member Functions

Protected Attributes

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation