Interface for an Arc drawn in screen space. More...

Inheritance diagram for makVrv::DtWindowArc:

Public Member Functions
	DtWindowArc (DtDe &de, DtUniqueID id)
	CTOR. More...

virtual	~DtWindowArc ()
	DTOR. More...

virtual void	setOrigin (const DtVector &position)=0
	Set the position of the arc, in window coordinates (0.0 - 1.0) More...

virtual DtVector	getOrigin () const =0


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

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


virtual void	setScale (float scale)=0
	Set/Get the scale factor of the arc. More...

virtual float	scale () const =0


virtual void	setVisible (bool isVisible)=0
	Set/Get whether the arc is visible. More...

virtual bool	isVisible () const =0


virtual void	setMaxAngleSegment (double angleSegmentMax)=0
	Set/Get the max angle segment used when building the geometry. More...

virtual double	maxAngleSegment () const =0


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

virtual double	startAngle () const =0


virtual void	setEndAngle (double endAngle)=0
	Set/Get the end angle of the arc, in radians. More...

virtual double	endAngle () const =0


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

virtual unsigned int	stipplePattern () const =0


virtual void	setLineWidth (float width)=0
	Set/Get the line width of the arc Uses DtLineSegmentInterface::setWidth. More...

virtual float	lineWidth () const =0


virtual void	setColor (float r, float g, float b, float a)=0
	Set/Get the color of the arc Valid range for argument values are 0.0 - 1.0. More...

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

Public Member Functions inherited from makVrv::DtWindowObject
	DtWindowObject (DtDe &de, DtUniqueID id)
	CTOR. More...

virtual	~DtWindowObject ()
	DTOR. More...

virtual bool	visible ()

virtual DtUniqueID	uniqueId ()
	Returns the unique ID of this object. More...

DtWindowObject *	getParent ()
	Get the parent windowObject. More...

virtual ChildList	childList ()
	Returns the child list. More...

virtual void	addChild (DtUniqueID id)
	Add a child to this objects child list. More...

virtual void	removeChild (DtUniqueID id)
	Remove a child from this objects child list. More...

virtual void	getColor (float &r, float &g, float &b, float &a)

virtual void	needsUpdate ()
	Called when position/rotation/scale are updated A windowObject's parent will also call this method on all of it's children to update it's values. More...

virtual Transform	windowTransform ()
	Get the window transform that is the total transform of this object and all it's parents. More...

virtual DtVector2d	windowScale ()
	Get the window scale of the object. More...

virtual DtClipBox	clipBox ()
	Get this object's clip box specifications. More...

virtual void	setParentId (DtUniqueID parentId)
	Get / Set Parent IDs. More...

virtual DtUniqueID	getParentId ()

virtual void	setPosition (double x, double y)
	Set / Get the window position of this object. More...

virtual void	getPosition (double &x, double &y)

virtual void	setScale (double scale)
	Set / Get the scale of the x y components. More...

virtual void	setScale (double x, double y)

virtual void	getScale (double &x, double &y)

virtual void	setRotation (double rotation)
	Set / Get the rotation of the window object around it's set position, (0.0,0.0) if none is set. More...

virtual void	getRotation (double &rotation)

virtual void	setInheritColor (bool inheritColor)
	Set / Get whether this object inherits it's color from it's parent. More...

virtual bool	inheritColor ()

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

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

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

Additional Inherited Members
Public Types inherited from makVrv::DtWindowObject
typedef std::list< DtUniqueID >	ChildList
	typedef list for holding the IDs of the children of this class More...

typedef DtVector2< double >	DtVector2d
	typedef 2D Vector More...

typedef DtMatrix3< double >	Transform
	typedef 3x3 Matrix for holding this object's transform More...

Protected Attributes inherited from makVrv::DtWindowObject
DtDe &	myDe

DtUniqueID	myUniqueId

DtUniqueID	myParentId

ChildList	myChildIdList

DtVector2d	myPosition

DtVector2d	myScale

DtVector2d	myWindowScale

double	myRotation

bool	myVisible

bool	myInheritColor

float	myColorR

float	myColorG

float	myColorB

float	myColorA

Transform	myRelativeTransform

Transform	myWindowTransform

DtClipBox	myClipBox

Detailed Description

Interface for an Arc drawn in screen space.

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::DtWindowArc::DtWindowArc	(	DtDe &	de,
		DtUniqueID	id
	)

CTOR.

virtual makVrv::DtWindowArc::~DtWindowArc ( )

virtual

DTOR.

makVrv::DtWindowArc::DtWindowArc ( )

private

Default Constructor not implemented.

makVrv::DtWindowArc::DtWindowArc ( const DtWindowArc & )

private

Copy Constructor not implemented � Copy not allowed.

Member Function Documentation

virtual void makVrv::DtWindowArc::setOrigin ( const DtVector & position )

pure virtual

Set the position of the arc, in window coordinates (0.0 - 1.0)

Implemented in makVrv::DtOsgWindowArc.

virtual DtVector makVrv::DtWindowArc::getOrigin ( ) const

pure virtual

Implemented in makVrv::DtOsgWindowArc.

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

pure virtual

Set/Get the axis lengths of the ellipse used to draw the arc.

Implemented in makVrv::DtOsgWindowArc.

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

pure virtual

Implemented in makVrv::DtOsgWindowArc.

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

pure virtual

Set/Get the scale factor of the arc.

Implemented in makVrv::DtOsgWindowArc.

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

pure virtual

Implemented in makVrv::DtOsgWindowArc.

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

pure virtual

Set/Get whether the arc is visible.

Reimplemented from makVrv::DtWindowObject.

Implemented in makVrv::DtOsgWindowArc.

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

pure virtual

Implemented in makVrv::DtOsgWindowArc.

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

pure virtual

Set/Get the max angle segment used when building the geometry.

Implemented in makVrv::DtOsgWindowArc.

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

pure virtual

Implemented in makVrv::DtOsgWindowArc.

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

pure virtual

Set/Get the start angle of the arc, in radians.

Implemented in makVrv::DtOsgWindowArc.

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

pure virtual

Implemented in makVrv::DtOsgWindowArc.

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

pure virtual

Set/Get the end angle of the arc, in radians.

Implemented in makVrv::DtOsgWindowArc.

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

pure virtual

Implemented in makVrv::DtOsgWindowArc.

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

pure virtual

Set/Get the stipple line pattern of the arc.

Implemented in makVrv::DtOsgWindowArc.

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

pure virtual

Implemented in makVrv::DtOsgWindowArc.

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

pure virtual

Set/Get the line width of the arc Uses DtLineSegmentInterface::setWidth.

Implemented in makVrv::DtOsgWindowArc.

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

pure virtual

Implemented in makVrv::DtOsgWindowArc.

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

pure virtual

Set/Get the color of the arc Valid range for argument values are 0.0 - 1.0.

Reimplemented from makVrv::DtWindowObject.

Implemented in makVrv::DtOsgWindowArc.

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

pure virtual

Implemented in makVrv::DtOsgWindowArc.

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

private

Assignment Operator not implemented � Copy not allowed.

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

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf4-8-branch/include/vrvCore/DtWindowArc.h

Public Member Functions

Private Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation