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.

Inheritance diagram for makVrf::DtEllipseFacadeBase:

[legend]

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

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

virtual	~DtEllipseFacadeBase ()

virtual void	setModelDefinition (const std::string &)=0

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	setPoints (const std::vector< DtVector > &)

virtual void	setOrigin (const DtVector &)

virtual void	setPosition (int iIndex, const DtVector &)

virtual void	setSelected (bool)

virtual bool	selected ()

virtual void	updateColors ()=0

virtual void	setLineWidth (int)=0

virtual void	setFill (bool)=0

virtual void	setDimensions (double, double)

virtual void	setXRadius (double)

virtual void	setYRadius (double)

virtual void	setPickable (bool)=0

virtual void	setVisible (bool)=0

virtual void	setStipplePattern (int)=0

virtual void	setFillPattern (const std::vector< unsigned int > &)=0

virtual makVrv::DtUniqueID	uniqueId () const

virtual makVrv::DtElementID	elementId () const

virtual int	modelSet () const

virtual void	stopClamping ()

makVrv::DtSceneObjectAgent *	sceneObjectAgent () const

Protected Attributes
makVrv::DtSceneObjectAgent *	mySceneObjectAgent

makVrv::DtAgentManagerInterface &	myAgentManagerInterface

bool	myOwnsSceneObjectAgent

float	myInsideColor [4]

float	myOutsideColor [4]

float	mySelectedOutsideColor [4]

float	mySelectedInsideColor [4]

bool	mySelectedInsideColorSet

int	myLineWidth

int	myModelSet

int	myNumPoints

double	myXRadius

double	myYRadius

makVrv::DtElementID	myElementId

bool	myDynamicOrigin

bool	mySelected

Constructor & Destructor Documentation

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

Constructor that will take an existing scene object agent.

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

virtual

DTOR.

Member Function Documentation

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

pure virtual

Sets the model definition for the model.

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

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

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

virtual

Sets the outside color (rim) if available.

Reimplemented in makVrf::Dt3DEllipseFacade.

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

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

virtual

Sets inside color (fill) if available.

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

virtual

Sets the selected inside color.

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

virtual

Sets the origin of the ellipse.

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

virtual

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

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

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

virtual

Sets whether or not the ellipse is selected.

virtual bool makVrf::DtEllipseFacadeBase::selected ( )

virtual

Get the current selected state.

virtual void makVrf::DtEllipseFacadeBase::updateColors ( )

pure virtual

pass the current color based on selection down to the model

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

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

pure virtual

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

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

virtual void makVrf::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 makVrf::Dt3DEllipseFacade, and makVrf::Dt2DEllipseFacade.

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

virtual

Sets the dimensions of the ellipse. Will also set the X and Y radius member variables.

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

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

virtual

Sets the X Radius of the ellipse.

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

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

virtual

Sets the Y Radius of the ellipse.

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

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

pure virtual

Sets whether or not items are pickable.

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

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

pure virtual

Sets whether or not item is visible.

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

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

pure virtual

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

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

virtual void makVrf::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 makVrf::Dt2DEllipseFacade, and makVrf::Dt3DEllipseFacade.

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

virtual

Returns the unique id of the scene object agent.

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

virtual

Returns the element id of the scene object agent.

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

virtual

Returns the model set.

virtual void makVrf::DtEllipseFacadeBase::stopClamping ( )

virtual

Stops clamping the ellipse.

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

Returns the scene object agent for this class.

Member Data Documentation

makVrv::DtSceneObjectAgent* makVrf::DtEllipseFacadeBase::mySceneObjectAgent

protected

makVrv::DtAgentManagerInterface& makVrf::DtEllipseFacadeBase::myAgentManagerInterface

protected

bool makVrf::DtEllipseFacadeBase::myOwnsSceneObjectAgent

protected

float makVrf::DtEllipseFacadeBase::myInsideColor[4]

protected

float makVrf::DtEllipseFacadeBase::myOutsideColor[4]

protected

float makVrf::DtEllipseFacadeBase::mySelectedOutsideColor[4]

protected

float makVrf::DtEllipseFacadeBase::mySelectedInsideColor[4]

protected

bool makVrf::DtEllipseFacadeBase::mySelectedInsideColorSet

protected

int makVrf::DtEllipseFacadeBase::myLineWidth

protected

int makVrf::DtEllipseFacadeBase::myModelSet

protected

int makVrf::DtEllipseFacadeBase::myNumPoints

protected

double makVrf::DtEllipseFacadeBase::myXRadius

protected

double makVrf::DtEllipseFacadeBase::myYRadius

protected

makVrv::DtElementID makVrf::DtEllipseFacadeBase::myElementId

protected

bool makVrf::DtEllipseFacadeBase::myDynamicOrigin

protected

bool makVrf::DtEllipseFacadeBase::mySelected

protected

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

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

Public Member Functions

Protected Attributes

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation