makVrv::DtEllipseFacadeBase Class Reference

Contains DtEllipseFacadeBase class. More...

Inheritance diagram for makVrv::DtEllipseFacadeBase:

Public Member Functions
	DtEllipseFacadeBase (DtAgentManagerInterface &, DtSceneObjectAgent *agent, DtElementID id, int modelSet)
	Constructor that will take an existing scene object agent.
	DtEllipseFacadeBase (DtAgentManagerInterface &, int modelSet, DtElementID id, bool distribute=true)
	Will create a new scene object agent for the given model set and element id.
virtual	~DtEllipseFacadeBase ()
	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 ellipse.
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	setPoints (const std::vector< DtVector > &)
	Sets the origin, and, possible radii of the ellipse.
virtual void	setOrigin (const DtVector &)
	Sets the origin of the ellipse.
virtual void	setPosition (int iIndex, const DtVector &)
	Sets position in ellipse (origin = 0, X = 1 or Y = 2)
virtual void	setSelected (bool)=0
	Sets whether or not the ellipse is selected.
virtual void	setLineWidth (int)=0
	Sets the width of the outside line. Default is 4.
virtual void	setFill (bool)=0
	Sets whether or not to fill ellipse.
virtual void	setDimensions (double, double)
	Sets the dimensions of the ellipse.
virtual void	setXRadius (double)
	Sets the X Radius of the ellipse.
virtual void	setYRadius (double)
	Sets the Y Radius of the ellipse.
virtual void	setPickable (bool)=0
	Sets whether or not items are pickable.
virtual void	setVisible (bool)=0
	Sets whether or not item is visible.
virtual void	setStipplePattern (int)=0
	Sets the 16 bit stipple pattern for the line portion of the area.
virtual void	setFillPattern (const std::vector< unsigned int > &)=0
	Sets the pattern to fill the 2D polygon with.
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	startClamping ()
	Start/stop clamping ellipse.
virtual void	setDynamicOrigin (bool)
	Sets whether or origin is set in the updater or retrieved from the scene object.
virtual void	stopClamping ()
	Stops clamping the ellipse.
DtEllipseUpdaterAgent *	updater () const
	Returns the updater agent for this class.
DtSceneObjectAgent *	sceneObjectAgent () const
	Returns the scene object agent for this class.

Protected Attributes
DtSceneObjectAgent *	mySceneObjectAgent
DtAgentManagerInterface &	myAgentManagerInterface
bool	myOwnsSceneObjectAgent
DtEllipseUpdaterAgent *	myUpdater
float	myInsideColor [4]
float	myOutsideColor [4]
int	myLineWidth
int	myModelSet
int	myNumPoints
double	myXRadius
double	myYRadius
makVrv::DtElementID	myElementId
bool	myDynamicOrigin

Detailed Description

Contains DtEllipseFacadeBase class.

This interface class defines the minimum amount of functionality a ellipse facade must implement The setPoints method will inherently assume that if there are 2 points defined the distance between the first (origin) and second is the X Radius. If there are three points defined the distance between the third and the first is the Y radius.

If there is no Y radius a circle is assumed.

Constructor & Destructor Documentation

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

Constructor that will take an existing scene object agent.

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

virtual

DTOR.

Member Function Documentation

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

pure virtual

Sets the model definition for the model.

Implemented in makVrv::Dt2DEllipseFacade, and makVrv::Dt3DEllipseFacade.

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

virtual

Sets the color for the ellipse.

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

Reimplemented in makVrv::Dt2DEllipseFacade, and makVrv::Dt3DEllipseFacade.

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

virtual

Sets the outside color (rim) if available.

Reimplemented in makVrv::Dt2DEllipseFacade, and makVrv::Dt3DEllipseFacade.

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

virtual

Sets inside color (fill) if available.

Reimplemented in makVrv::Dt2DEllipseFacade, and makVrv::Dt3DEllipseFacade.

virtual void makVrv::DtEllipseFacadeBase::setPoints ( const std::vector< DtVector > &  )

virtual

Sets the origin, and, possible radii of the ellipse.

Akin to calling setOrigin, setXRadius and setYRadius

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

virtual

Sets the origin of the ellipse.

virtual void makVrv::DtEllipseFacadeBase::setPosition ( int  iIndex, const DtVector &    )

virtual

Sets position in ellipse (origin = 0, X = 1 or Y = 2)

Reimplemented in makVrv::Dt2DEllipseFacade, and makVrv::Dt3DEllipseFacade.

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

pure virtual

Sets whether or not the ellipse is selected.

Implemented in makVrv::Dt2DEllipseFacade, and makVrv::Dt3DEllipseFacade.

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

pure virtual

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

Implemented in makVrv::Dt3DEllipseFacade, and makVrv::Dt2DEllipseFacade.

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

pure virtual

Sets whether or not to fill ellipse.

If fill style of line is specified, will override this flag

Implemented in makVrv::Dt3DEllipseFacade, and makVrv::Dt2DEllipseFacade.

virtual void makVrv::DtEllipseFacadeBase::setDimensions ( double  , double    )

virtual

Sets the dimensions of the ellipse.

Will also set the X and Y radius member variables.

Reimplemented in makVrv::Dt2DEllipseFacade, and makVrv::Dt3DEllipseFacade.

virtual void makVrv::DtEllipseFacadeBase::setXRadius ( double  )

virtual

Sets the X Radius of the ellipse.

Reimplemented in makVrv::Dt2DEllipseFacade, and makVrv::Dt3DEllipseFacade.

virtual void makVrv::DtEllipseFacadeBase::setYRadius ( double  )

virtual

Sets the Y Radius of the ellipse.

Reimplemented in makVrv::Dt2DEllipseFacade, and makVrv::Dt3DEllipseFacade.

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

pure virtual

Sets whether or not items are pickable.

Implemented in makVrv::Dt3DEllipseFacade, and makVrv::Dt2DEllipseFacade.

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

pure virtual

Sets whether or not item is visible.

Implemented in makVrv::Dt3DEllipseFacade, and makVrv::Dt2DEllipseFacade.

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

pure virtual

Sets the 16 bit stipple pattern for the line portion of the area.

Implemented in makVrv::Dt2DEllipseFacade, and makVrv::Dt3DEllipseFacade.

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

pure 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

Implemented in makVrv::Dt2DEllipseFacade, and makVrv::Dt3DEllipseFacade.

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

virtual

Returns the unique id of the scene object agent.

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

virtual

Returns the element id of the scene object agent.

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

virtual

Returns the model set.

virtual void makVrv::DtEllipseFacadeBase::startClamping ( )

virtual

Start/stop clamping ellipse.

Clamping an ellipse will clamp it to the terrain and level out the ellipse. See the DtEllipseUpdater class.

Reimplemented in makVrv::Dt3DEllipseFacade, and makVrv::Dt2DEllipseFacade.

virtual void makVrv::DtEllipseFacadeBase::setDynamicOrigin ( bool  )

virtual

Sets whether or origin is set in the updater or retrieved from the scene object.

Default is false (retrieved from origin)

virtual void makVrv::DtEllipseFacadeBase::stopClamping ( )

virtual

Stops clamping the ellipse.

DtEllipseUpdaterAgent* makVrv::DtEllipseFacadeBase::updater

(

)

const

Returns the updater agent for this class.

DtSceneObjectAgent* makVrv::DtEllipseFacadeBase::sceneObjectAgent

(

)

const

Returns the scene object agent for this class.

Member Data Documentation

DtSceneObjectAgent* makVrv::DtEllipseFacadeBase::mySceneObjectAgent

protected

DtAgentManagerInterface& makVrv::DtEllipseFacadeBase::myAgentManagerInterface

protected

bool makVrv::DtEllipseFacadeBase::myOwnsSceneObjectAgent

protected

DtEllipseUpdaterAgent* makVrv::DtEllipseFacadeBase::myUpdater

protected

float makVrv::DtEllipseFacadeBase::myInsideColor[4]

protected

float makVrv::DtEllipseFacadeBase::myOutsideColor[4]

protected

int makVrv::DtEllipseFacadeBase::myLineWidth

protected

int makVrv::DtEllipseFacadeBase::myModelSet

protected

int makVrv::DtEllipseFacadeBase::myNumPoints

protected

double makVrv::DtEllipseFacadeBase::myXRadius

protected

double makVrv::DtEllipseFacadeBase::myYRadius

protected

makVrv::DtElementID makVrv::DtEllipseFacadeBase::myElementId

protected

bool makVrv::DtEllipseFacadeBase::myDynamicOrigin

protected

---

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

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