Interface class for an Overlay Arc Model. An overlay model is positioned in 3D space and drawn onto a model set specific overlay.

An arc has 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 has the following style 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

Inheritance diagram for makVrv::DtOverlayArcModel:

[legend]

Public Member Functions
	DtOverlayArcModel (DtDe &de, DtUniqueID id)

virtual	~DtOverlayArcModel ()

virtual void	setTopographicHeading (double topoHeading)=0

Model setters/getters (abstract)
virtual void	setOrientation (const DtTaitBryan &orientation)=0

virtual DtTaitBryan	orientation () const =0


virtual void	setDimensions (double x, double y)=0

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


virtual void	setScale (float scale)=0

virtual float	scale () const =0


virtual void	setVisible (bool isVisible)=0

virtual bool	isVisible () const =0


virtual void	setMaxAngleSegment (double angleSegmentMax)=0

virtual double	maxAngleSegment () const =0


virtual void	setStartAngle (double startAngle)=0

virtual double	startAngle () const =0


virtual void	setEndAngle (double endAngle)=0

virtual double	endAngle () const =0


virtual void	setStipplePattern (unsigned int stipplePattern)=0

virtual unsigned int	stipplePattern () const =0


virtual void	setLineWidth (float width)=0

virtual float	lineWidth () const =0


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

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


virtual void	setEventsEnabled (bool enabled)=0

virtual bool	eventsEnabled () const =0


virtual void	setGroup (int groupNum)=0

virtual int	group () const =0

Public Member Functions inherited from makVrv::DtModel
	DtModel (DtDe &de, DtUniqueID id)

virtual	~DtModel ()

DtModelInstance *	createModelInstance (const std::string &modelDefName, bool realize=true)

virtual void	setModelDefinition (const std::string &str)

virtual const std::string &	modelDefinitionName ()

virtual void	saveModelToFile (const std::string &filename)

virtual const std::string &	className () const

unsigned int	transformSize () const

virtual void	setPosition (int vtx, const DtVector &position)

virtual const DtVector &	position (int vtx=0) const

virtual void	removePosition (int vtx)

virtual void	setPositionOffset (const DtVector &positionOffset)

virtual const DtVector &	positionOffset () const

virtual void	setOrientation (int vtx, const DtTaitBryan &orientation)

virtual void	setPositionAndOrientation (int vtx, const DtVector &positionOffset, const DtTaitBryan &orientation)

virtual const DtTaitBryan &	orientation (int vtx=0) const

virtual void	setOrientationOffset (const DtTaitBryan &orientationOffset)

virtual const DtTaitBryan &	orientationOffset () const

virtual void	enableColorBlending (bool b)

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

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

virtual bool	colorBlendingEnabled () const

virtual void	enableLighting (bool l)

virtual int	modelSet () const

const DtVector &	boundingBoxExtents () const

void	getBoundingBoxExtents (double &x, double &y, double &z) const

const DtVector &	boundingBoxCenter () const

virtual void	getBoundingBoxCenter (double &x, double &y, double &z) const

virtual void	getBoundingBoxComponents (DtVector &minimum, DtVector &maximum)

void	setContributesToBound (bool trueOrFalse)

bool	contributesToBound () const

DtDe &	de ()

virtual void	setModelInstance (DtModelInstance *modelInstance)

virtual void	promoteBackgroundModelInstance (DtModelDefinition &defintion)

virtual bool	visible () const

DtUniqueID	parentSceneObjectID () const

virtual void	addedToSceneObjectAsProp (const DtUniqueID &sceneObj)

virtual void	addedToSceneObject (const DtUniqueID &sceneObj, int modelSet, int visualizerType)

virtual void	setElementId (DtUniqueID id)

virtual void	removedFromSceneObject ()

virtual void	setIsSupportModel (bool isSupport)=0

virtual void	setSolid (bool isSolid)

virtual bool	isProp ()

virtual void	updateMinLastFrameDistance (float distance)

virtual void	resetLastFrameDistance ()

virtual float	minLastFrameDistance () const

virtual DtModelInstance *	modelInstance ()

virtual const DtModelInstance *	modelInstance () const

int	visualizerType () const

virtual bool	supportsMultithreadedLoad ()

virtual void	backgroundLoad ()

virtual void	foregroundLoad ()

virtual bool	isActivelyBackgroundLoading ()

virtual DtLoaderHandle *	getLoadQueueHandle ()

Private Member Functions
	DtOverlayArcModel ()

	DtOverlayArcModel (const DtOverlayArcModel &)

DtOverlayArcModel &	operator= (const DtOverlayArcModel &)

Additional Inherited Members
Public Attributes inherited from makVrv::DtModel
boost::signalslib::signal < void(DtModel *)>	signal_modelToBeDestroyed

boost::signalslib::signal < void(DtModel *)>	signal_modelChanged

boost::signalslib::signal < bool(DtModel *, bool), SlotReturnOR >	signal_visibilityChangeRequested

boost::signalslib::signal < void(DtModelInstance , DtModel )>	signal_modelInstanceCreated

boost::signalslib::signal < void(DtModelInstance , DtModel )>	signal_modelInstanceToBeDestroyed

Protected Types inherited from makVrv::DtModel
typedef std::vector < ObjectTransform >	TransformList

Protected Member Functions inherited from makVrv::DtModel
virtual void	addToScene (const DtUniqueID &sceneObjectId, int modelSet, int visualizerType)=0

virtual void	addToSceneAsProp (const DtUniqueID &sceneObjectId)

virtual void	removeFromScene ()=0

virtual void	initializeModelInstance ()

void	slot_modelInstanceChanged (DtModelInstance *instance)

virtual void	waitAndClearLoadHandle ()

virtual void	removedFromLoadQueue ()

virtual void	setDoneBackgroundLoading ()

virtual void	setActivelyBackgroundLoading ()

Protected Attributes inherited from makVrv::DtModel
DtLoaderHandle *	myInLoadQueueHandle

DtDe &	myDe

const DtUniqueID	myUniqueId

bool	myColorBlendingEnabled

DtModelInstance *	myBackgroundModelInstance

float	myMinLastFrameDistance

TransformList	myTransforms

DtModelInstance *	myModelInstance

int	myModelSet

int	myVisualizerType

bool	myContributesToBound

DtUniqueID	myParentSceneObjectID

bool	myIsPropFlag

float	myBlendColor [4]

bool	myVisibleFlag

DtVector	myPositionOffset

DtTaitBryan	myOrientationOffset

std::string	myModelDefinitionName

Static Protected Attributes inherited from makVrv::DtModel
static bool	theInittedState

Constructor & Destructor Documentation

makVrv::DtOverlayArcModel::DtOverlayArcModel	(	DtDe &	de,
		DtUniqueID	id
	)

CTOR.

virtual makVrv::DtOverlayArcModel::~DtOverlayArcModel ( )

virtual

DTOR.

makVrv::DtOverlayArcModel::DtOverlayArcModel ( )

private

Default Constructor not implemented.

makVrv::DtOverlayArcModel::DtOverlayArcModel ( const DtOverlayArcModel & )

private

Copy Constructor not implemented � Copy not allowed.

Member Function Documentation

virtual void makVrv::DtOverlayArcModel::setOrientation ( const DtTaitBryan & orientation )

pure virtual

Set the global orientation of the arc.

Implemented in makVrv::DtOsgOverlayArcModel.

virtual DtTaitBryan makVrv::DtOverlayArcModel::orientation ( ) const

pure virtual

Set the global orientation of the arc.

Implemented in makVrv::DtOsgOverlayArcModel.

virtual void makVrv::DtOverlayArcModel::setTopographicHeading ( double topoHeading )

pure virtual

Set the arc's topographic heading, in radians.

Implemented in makVrv::DtOsgOverlayArcModel.

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

pure virtual

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

Implemented in makVrv::DtOsgOverlayArcModel.

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

pure virtual

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

Implemented in makVrv::DtOsgOverlayArcModel.

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

pure virtual

Set/Get the scale factor of the arc.

Implemented in makVrv::DtOsgOverlayArcModel.

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

pure virtual

Set/Get the scale factor of the arc.

Implemented in makVrv::DtOsgOverlayArcModel.

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

pure virtual

Set/Get whether the arc is visible.

Reimplemented from makVrv::DtModel.

Implemented in makVrv::DtOsgOverlayArcModel.

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

pure virtual

Set/Get whether the arc is visible.

Implemented in makVrv::DtOsgOverlayArcModel.

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

pure virtual

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

Implemented in makVrv::DtOsgOverlayArcModel.

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

pure virtual

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

Implemented in makVrv::DtOsgOverlayArcModel.

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

pure virtual

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

Implemented in makVrv::DtOsgOverlayArcModel.

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

pure virtual

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

Implemented in makVrv::DtOsgOverlayArcModel.

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

pure virtual

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

Implemented in makVrv::DtOsgOverlayArcModel.

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

pure virtual

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

Implemented in makVrv::DtOsgOverlayArcModel.

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

pure virtual

Set/Get the stipple line pattern of the arc.

Implemented in makVrv::DtOsgOverlayArcModel.

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

pure virtual

Set/Get the stipple line pattern of the arc.

Implemented in makVrv::DtOsgOverlayArcModel.

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

pure virtual

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

Implemented in makVrv::DtOsgOverlayArcModel.

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

pure virtual

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

Implemented in makVrv::DtOsgOverlayArcModel.

virtual void makVrv::DtOverlayArcModel::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::DtModel.

Implemented in makVrv::DtOsgOverlayArcModel.

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

pure virtual

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

Implemented in makVrv::DtOsgOverlayArcModel.

virtual void makVrv::DtOverlayArcModel::setEventsEnabled ( bool enabled )

pure virtual

Set/Get to handle or not handle mouse events.

Implemented in makVrv::DtOsgOverlayArcModel.

virtual bool makVrv::DtOverlayArcModel::eventsEnabled ( ) const

pure virtual

Set/Get to handle or not handle mouse events.

Implemented in makVrv::DtOsgOverlayArcModel.

virtual void makVrv::DtOverlayArcModel::setGroup ( int groupNum )

pure virtual

Set/Get 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.

Implemented in makVrv::DtOsgOverlayArcModel.

virtual int makVrv::DtOverlayArcModel::group ( ) const

pure virtual

Set/Get 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.

Implemented in makVrv::DtOsgOverlayArcModel.

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

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.vrf5-0-branch/include/vrvCore/DtOverlayArcModel.h

Public Member Functions

Private Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation