Interface class for an Arc Facade. More...

Inheritance diagram for makVrv::DtArcFacadeBase:

Public Member Functions
virtual	~DtArcFacadeBase ()
	Destructor. More...

virtual void	setDynamicOrigin (bool)
	Sets whether or not the origin's position is changing or not If the origin is changing (hence dynamic), we use the DtArcUpdaterAgent to update the arc's origin instead of using the arc's scene object directly. More...

virtual makVrv::DtUniqueID	uniqueId () const
	Returns the unique id of the scene object agent. More...

virtual makVrv::DtElementID	elementId () const
	Returns the element id of the scene object agent. More...

virtual int	modelSet () const
	Returns the model set. More...

DtArcUpdaterAgent *	findUpdater () const
	Returns the updater agent for this class, can return null. More...

DtSceneObjectAgent *	sceneObjectAgent () const
	Returns the scene object agent for this class. More...

virtual void	setPosition (int index, const DtVector &position)
	Set the position of a vertex in the arc. More...

virtual void	setModelDefinition (const std::string &)
	Sets the model definition for the model. More...

virtual void	setPickable (bool)
	Sets whether or not items are pickable. More...

virtual void	setGroup (int)
	Sets the group this overlay will be drawn in The higher the group number, the "closer" to the eyepoint this overlay will be drawn. More...

DtOverlayArcModelAgent *	findArcAgent ()
	Returns the arc model agent used for this class This function can return null. More...


virtual void	setSelected (bool)
	Set/Get whether or not the arc is selected Default value is false (not selected) More...

virtual bool	isSelected () const


virtual void	setDimensions (double x, double y)
	Set/Get the axis lengths of the ellipse used to draw the arc Default value is 0, 0. More...

virtual bool	getDimensions (double &x, double &y) const


virtual void	setScale (float scale)
	Set/Get the scale factor of the arc Default value is 1. More...

virtual float	scale () const


virtual void	setVisible (bool isVisible)
	Set/Get whether the arc is visible Default value is true (visible) More...

virtual bool	isVisible () const


virtual void	setMaxAngleSegment (double angleSegmentMax)
	Set/Get the max angle segment used when building the geometry Default value is PI / 18. More...

virtual double	maxAngleSegment () const


virtual void	setStartAngle (double startAngle)
	Set/Get the start angle of the arc, in radians Default value is 0. More...

virtual double	startAngle () const


virtual void	setEndAngle (double endAngle)
	Set/Get the end angle of the arc, in radians Default value is PI. More...

virtual double	endAngle () const


virtual void	setStipplePattern (unsigned int stipplePattern)
	Set/Get the stipple line pattern of the arc Default value is 0xFFFF. More...

virtual unsigned int	stipplePattern () const


virtual void	setLineWidth (float width)
	Set/Get the line width of the arc Uses DtLineSegmentInterface::setWidth Default value is 1. More...

virtual float	lineWidth () const


virtual void	setColor (float r, float g, float b, float a)
	Set/Get the color of the arc - default is (0, 0, 0, 1). More...

virtual bool	getColor (float &r, float &g, float &b, float &a) const


virtual void	setSelectedColor (float r, float g, float b, float a)
	Set/Get the selected color of the arc - default is (1, 1, 1, 1). More...

virtual bool	getSelectedColor (float &r, float &g, float &b, float &a) const

Protected Member Functions
	DtArcFacadeBase (DtAgentManagerInterface &, DtSceneObjectAgent *agent, DtElementID id, int modelSet)
	Constructor that takes an existing scene object agent Throws a DtException if the provided DtSceneObjectAgent is NULL. More...

	DtArcFacadeBase (DtAgentManagerInterface &, int modelSet, DtElementID id, bool distribute=true)
	Constructor that creates a new scene object agent The given model set and element id is used to create the new scene object agent. More...

virtual void	updateColors ()
	Passes set color values down to the model. More...

Protected Attributes
DtOverlayArcModelAgent *	myArcModelAgent

DtSceneObjectAgent *	mySceneObjectAgent

DtAgentManagerInterface &	myAgentManagerInterface

bool	myOwnsSceneObjectAgent

int	myModelSet

DtArcUpdaterAgent *	myUpdater

float	myColor [4]

float	mySelectedColor [4]

makVrv::DtElementID	myElementId

bool	myDynamicOrigin

bool	mySelected

DtVector	myPosition

double	myStartAngle

double	myEndAngle

double	myMaxAngleSegment

double	myDimensions [2]

float	myScale

bool	myVisible

unsigned int	myStipplePattern

float	myLineWidth

Private Member Functions
	DtArcFacadeBase ()
	Default Constructor not implemented. More...

	DtArcFacadeBase (const DtArcFacadeBase &)
	Copy Constructor not implemented � Copy not allowed. More...

DtArcFacadeBase &	operator= (const DtArcFacadeBase &)
	Assignment Operator not implemented � Copy not allowed. More...

Detailed Description

Interface class for an Arc Facade.

An arc with the following geometric parameters:

Start Angle: Change which part of the ellipse is used to draw the arc
End Angle: Change which part of the ellipse is used to draw the arc
Position: Change the position of the arc's origin
Dimensions: Change the dimensions of the ellipse used to draw the arc
Max Angle Segment: Affects the number of vertices used by changing the angular difference between vertices along the arc. If you want to use X vertices to draw the arc, then set Max Angle Segment equal to PI / X

An arc with the following geometric parameters:

Line Width: Change the width of all of the arc's line segments
Line Color: Change the color of all of the arc's line segments
Line Stipple Pattern: Change the stipple pattern of all of the arc's line segments

Special Considerations:

In a 2D plane, the positive Y-Axis is 0 radians with clockwise being the positive direction
If the start and end angle are 0 and 2 * PI respectively, an ellipse is drawn
If the height of the arc is 0, a line is drawn

Constructor & Destructor Documentation

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

protected

Constructor that takes an existing scene object agent Throws a DtException if the provided DtSceneObjectAgent is NULL.

makVrv::DtArcFacadeBase::DtArcFacadeBase	(	DtAgentManagerInterface &	,
		int	modelSet,
		DtElementID	id,
		bool	distribute = `true`
	)

protected

Constructor that creates a new scene object agent The given model set and element id is used to create the new scene object agent.

virtual makVrv::DtArcFacadeBase::~DtArcFacadeBase ( )

virtual

Destructor.

makVrv::DtArcFacadeBase::DtArcFacadeBase ( )

private

Default Constructor not implemented.

makVrv::DtArcFacadeBase::DtArcFacadeBase ( const DtArcFacadeBase & )

private

Copy Constructor not implemented � Copy not allowed.

Member Function Documentation

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

virtual

Set/Get whether or not the arc is selected Default value is false (not selected)

virtual bool makVrv::DtArcFacadeBase::isSelected ( ) const

virtual

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

virtual

Sets whether or not the origin's position is changing or not If the origin is changing (hence dynamic), we use the DtArcUpdaterAgent to update the arc's origin instead of using the arc's scene object directly.

The updater will ensure the arc is updated according to the changing origin.

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

virtual

Returns the unique id of the scene object agent.

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

virtual

Returns the element id of the scene object agent.

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

virtual

Returns the model set.

DtArcUpdaterAgent* makVrv::DtArcFacadeBase::findUpdater ( ) const

Returns the updater agent for this class, can return null.

DtSceneObjectAgent* makVrv::DtArcFacadeBase::sceneObjectAgent ( ) const

Returns the scene object agent for this class.

virtual void makVrv::DtArcFacadeBase::setPosition	(	int	index,
		const DtVector &	position
	)

virtual

Set the position of a vertex in the arc.

virtual void makVrv::DtArcFacadeBase::setDimensions	(	double	x,
		double	y
	)

virtual

Set/Get the axis lengths of the ellipse used to draw the arc Default value is 0, 0.

virtual bool makVrv::DtArcFacadeBase::getDimensions	(	double &	x,
		double &	y
	)		const

virtual

virtual void makVrv::DtArcFacadeBase::setScale ( float scale )

virtual

Set/Get the scale factor of the arc Default value is 1.

virtual float makVrv::DtArcFacadeBase::scale ( ) const

virtual

virtual void makVrv::DtArcFacadeBase::setVisible ( bool isVisible )

virtual

Set/Get whether the arc is visible Default value is true (visible)

virtual bool makVrv::DtArcFacadeBase::isVisible ( ) const

virtual

virtual void makVrv::DtArcFacadeBase::setMaxAngleSegment ( double angleSegmentMax )

virtual

Set/Get the max angle segment used when building the geometry Default value is PI / 18.

virtual double makVrv::DtArcFacadeBase::maxAngleSegment ( ) const

virtual

virtual void makVrv::DtArcFacadeBase::setStartAngle ( double startAngle )

virtual

Set/Get the start angle of the arc, in radians Default value is 0.

virtual double makVrv::DtArcFacadeBase::startAngle ( ) const

virtual

virtual void makVrv::DtArcFacadeBase::setEndAngle ( double endAngle )

virtual

Set/Get the end angle of the arc, in radians Default value is PI.

virtual double makVrv::DtArcFacadeBase::endAngle ( ) const

virtual

virtual void makVrv::DtArcFacadeBase::setStipplePattern ( unsigned int stipplePattern )

virtual

Set/Get the stipple line pattern of the arc Default value is 0xFFFF.

virtual unsigned int makVrv::DtArcFacadeBase::stipplePattern ( ) const

virtual

virtual void makVrv::DtArcFacadeBase::setLineWidth ( float width )

virtual

Set/Get the line width of the arc Uses DtLineSegmentInterface::setWidth Default value is 1.

virtual float makVrv::DtArcFacadeBase::lineWidth ( ) const

virtual

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

virtual

Set/Get the color of the arc - default is (0, 0, 0, 1).

Valid range for argument values are 0.0 - 1.0.

virtual bool makVrv::DtArcFacadeBase::getColor	(	float &	r,
		float &	g,
		float &	b,
		float &	a
	)		const

virtual

virtual void makVrv::DtArcFacadeBase::setSelectedColor	(	float	r,
		float	g,
		float	b,
		float	a
	)

virtual

Set/Get the selected color of the arc - default is (1, 1, 1, 1).

Valid range for argument values are 0.0 - 1.0.

virtual bool makVrv::DtArcFacadeBase::getSelectedColor	(	float &	r,
		float &	g,
		float &	b,
		float &	a
	)		const

virtual

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

virtual

Sets the model definition for the model.

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

virtual

Sets whether or not items are pickable.

virtual void makVrv::DtArcFacadeBase::setGroup ( int )

virtual

Sets the group this overlay will be drawn in The higher the group number, the "closer" to the eyepoint this overlay will be drawn.

Use this function to stack overlay objects in the particular order you want them displayed

DtOverlayArcModelAgent* makVrv::DtArcFacadeBase::findArcAgent ( )

Returns the arc model agent used for this class This function can return null.

virtual void makVrv::DtArcFacadeBase::updateColors ( )

protectedvirtual

Passes set color values down to the model.

DtArcFacadeBase& makVrv::DtArcFacadeBase::operator= ( const DtArcFacadeBase & )

private

Assignment Operator not implemented � Copy not allowed.

Member Data Documentation

DtOverlayArcModelAgent* makVrv::DtArcFacadeBase::myArcModelAgent

protected

DtSceneObjectAgent* makVrv::DtArcFacadeBase::mySceneObjectAgent

protected

DtAgentManagerInterface& makVrv::DtArcFacadeBase::myAgentManagerInterface

protected

bool makVrv::DtArcFacadeBase::myOwnsSceneObjectAgent

protected

int makVrv::DtArcFacadeBase::myModelSet

protected

DtArcUpdaterAgent* makVrv::DtArcFacadeBase::myUpdater

protected

float makVrv::DtArcFacadeBase::myColor[4]

protected

float makVrv::DtArcFacadeBase::mySelectedColor[4]

protected

makVrv::DtElementID makVrv::DtArcFacadeBase::myElementId

protected

bool makVrv::DtArcFacadeBase::myDynamicOrigin

protected

bool makVrv::DtArcFacadeBase::mySelected

protected

DtVector makVrv::DtArcFacadeBase::myPosition

protected

double makVrv::DtArcFacadeBase::myStartAngle

protected

double makVrv::DtArcFacadeBase::myEndAngle

protected

double makVrv::DtArcFacadeBase::myMaxAngleSegment

protected

double makVrv::DtArcFacadeBase::myDimensions[2]

protected

float makVrv::DtArcFacadeBase::myScale

protected

bool makVrv::DtArcFacadeBase::myVisible

protected

unsigned int makVrv::DtArcFacadeBase::myStipplePattern

protected

float makVrv::DtArcFacadeBase::myLineWidth

protected

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

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf4-10-branch/include/vrvCore/DtArcFacadeBase.h

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation