makVrv::DtOverlayWedgeModel Class Reference

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

A wedge has the following geometric parameters:

• Start Angle: Change the angle the wedge begins at
• Wedge Span: Change the angular span of the wedge
• Position: Change the position of the wedge's origin
• Radius: Change the radius of the circle used to draw the wedge
• Max Angle Segment: Affects the number of vertices used by changing the angular difference between vertices along the arc of the wedge. If you want to use X vertices to draw arc of the wedge, then the Max Angle Segment is equal to Wedge Span / X.
• Scale: Change the numeric factor that the wedge is scaled by

A wedge has the following style properties:

• Line Width: Change the width of all of the wedge's line segments
• Line Color: Change the color of all of the wedge's line segments
• Line Stipple Pattern: Change the stipple pattern of all of the wedge's line segments
• Outlined/Filled: Change whether or not the wedge is outlined, filled, or both
• Pattern Filled: Change whether or not the wedge is filled with a stipple pattern
• Gradient Filled: Change whether or not the wedge is filled with a gradient
• Solid Filled: Change whether or not the wedge is filled with a solid color
• Inside Color: Change the inside color of the wedge
• Outside Color: Change the outside color of the wedge

Special Considerations:

• In a 2D plane, the positive Y-Axis is 0 radians with clockwise being the positive direction
• The wedge span cannot be negative and cannot be greater than PI

Inheritance diagram for makVrv::DtOverlayWedgeModel:

Public Member Functions
	DtOverlayWedgeModel (DtDe &de, DtUniqueID id)
virtual	~DtOverlayWedgeModel ()
virtual void	setOrientation (const DtTaitBryan &orientation)=0
virtual void	setFillPattern (const std::vector< unsigned int > &)=0
virtual void	setColor (float r, float g, float b, float a)=0
Model setters/getters (abstract)
virtual void	setOrigin (const DtVector &position)=0
virtual DtVector	origin () const =0
virtual void	setRelativePosition (double x, double y, double z)=0
virtual DtVector	relativePosition () const =0
virtual void	setMaxAngleSegment (double angleSegmentMax)=0
virtual double	maxAngleSegment () const =0
virtual void	setRadius (float len)=0
virtual float	radius () 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	setStartAngle (double startAngle)=0
virtual double	startAngle () const =0
virtual void	setWedgeSpan (double wedgeSpan)=0
virtual double	wedgeSpan () const =0
virtual void	setFill (bool)=0
virtual bool	isFill () const =0
virtual void	setOutline (bool)=0
virtual bool	isOutline () const =0
virtual void	setSolidFillCenter (bool)=0
virtual bool	isSolidFillCenter () const =0
virtual void	setStipplePattern (unsigned int stipplePattern)=0
virtual unsigned int	stipplePattern () const =0
virtual void	setOutlineWidth (float)=0
virtual float	outlineWidth () const =0
virtual void	setCentralVertexColor (float r, float g, float b, float a)=0
virtual bool	getCentralVertexColor (float &r, float &g, float &b, float &a) const =0
virtual void	setInsideColor (float r, float g, float b, float a)=0
virtual bool	getInsideColor (float &r, float &g, float &b, float &a) const =0
virtual void	setOutsideColor (float r, float g, float b, float a)=0
virtual bool	getOutsideColor (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
	DtOverlayWedgeModel ()
	DtOverlayWedgeModel (const DtOverlayWedgeModel &)
DtOverlayWedgeModel &	operator= (const DtOverlayWedgeModel &)

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

CTOR.

virtual makVrv::DtOverlayWedgeModel::~DtOverlayWedgeModel ( )

virtual

DTOR.

makVrv::DtOverlayWedgeModel::DtOverlayWedgeModel ( )

private

Default Constructor not implemented.

makVrv::DtOverlayWedgeModel::DtOverlayWedgeModel ( const DtOverlayWedgeModel &  )

private

Copy Constructor not implemented – Copy not allowed.

Member Function Documentation

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

pure virtual

Set/Get the global position of the wedge.

Implemented in makVrv::DtOsgOverlayWedgeModel.

virtual DtVector makVrv::DtOverlayWedgeModel::origin ( ) const

pure virtual

Set/Get the global position of the wedge.

Implemented in makVrv::DtOsgOverlayWedgeModel.

virtual void makVrv::DtOverlayWedgeModel::setRelativePosition ( double  x, double  y, double  z  )

pure virtual

Set/Get the local translation of the wedge.

Implemented in makVrv::DtOsgOverlayWedgeModel.

virtual DtVector makVrv::DtOverlayWedgeModel::relativePosition ( ) const

pure virtual

Set/Get the local translation of the wedge.

Implemented in makVrv::DtOsgOverlayWedgeModel.

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

pure virtual

Set the global orientation of the wedge.

Implemented in makVrv::DtOsgOverlayWedgeModel.

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

pure virtual

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

Implemented in makVrv::DtOsgOverlayWedgeModel.

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

pure virtual

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

Implemented in makVrv::DtOsgOverlayWedgeModel.

virtual void makVrv::DtOverlayWedgeModel::setRadius ( float  len )

pure virtual

Set/Get the radius of the wedge.

Implemented in makVrv::DtOsgOverlayWedgeModel.

virtual float makVrv::DtOverlayWedgeModel::radius ( ) const

pure virtual

Set/Get the radius of the wedge.

Implemented in makVrv::DtOsgOverlayWedgeModel.

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

pure virtual

Set/Get the numeric factor the wedge is scaled by.

Implemented in makVrv::DtOsgOverlayWedgeModel.

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

pure virtual

Set/Get the numeric factor the wedge is scaled by.

Implemented in makVrv::DtOsgOverlayWedgeModel.

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

pure virtual

Set/Get whether the wedge is visible.

Reimplemented from makVrv::DtModel.

Implemented in makVrv::DtOsgOverlayWedgeModel.

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

pure virtual

Set/Get whether the wedge is visible.

Implemented in makVrv::DtOsgOverlayWedgeModel.

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

pure virtual

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

Implemented in makVrv::DtOsgOverlayWedgeModel.

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

pure virtual

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

Implemented in makVrv::DtOsgOverlayWedgeModel.

virtual void makVrv::DtOverlayWedgeModel::setWedgeSpan ( double  wedgeSpan )

pure virtual

Set/Get the span of the wedge, in radians. Valid range for argument values are 0 to PI radians.

Implemented in makVrv::DtOsgOverlayWedgeModel.

virtual double makVrv::DtOverlayWedgeModel::wedgeSpan ( ) const

pure virtual

Set/Get the span of the wedge, in radians. Valid range for argument values are 0 to PI radians.

Implemented in makVrv::DtOsgOverlayWedgeModel.

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

pure virtual

Set/Get whether or not to draw a filled wedge. If false, an outline of the wedge is drawn.

Implemented in makVrv::DtOsgOverlayWedgeModel.

virtual bool makVrv::DtOverlayWedgeModel::isFill ( ) const

pure virtual

Set/Get whether or not to draw a filled wedge. If false, an outline of the wedge is drawn.

Implemented in makVrv::DtOsgOverlayWedgeModel.

virtual void makVrv::DtOverlayWedgeModel::setOutline ( bool  )

pure virtual

Set/Get whether or not to outline a filled wedge. This function does nothing if setFill(false).

Implemented in makVrv::DtOsgOverlayWedgeModel.

virtual bool makVrv::DtOverlayWedgeModel::isOutline ( ) const

pure virtual

Set/Get whether or not to outline a filled wedge. This function does nothing if setFill(false).

Implemented in makVrv::DtOsgOverlayWedgeModel.

virtual void makVrv::DtOverlayWedgeModel::setSolidFillCenter ( bool  )

pure virtual

Set/Get whether to solid fill or gradient fill the wedge. This function does nothing if setFill(false).

Implemented in makVrv::DtOsgOverlayWedgeModel.

virtual bool makVrv::DtOverlayWedgeModel::isSolidFillCenter ( ) const

pure virtual

Set/Get whether to solid fill or gradient fill the wedge. This function does nothing if setFill(false).

Implemented in makVrv::DtOsgOverlayWedgeModel.

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

pure virtual

Set the fill stipple pattern of the wedge.

Implemented in makVrv::DtOsgOverlayWedgeModel.

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

pure virtual

Set/Get the stipple pattern for the wedge.

Implemented in makVrv::DtOsgOverlayWedgeModel.

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

pure virtual

Set/Get the stipple pattern for the wedge.

Implemented in makVrv::DtOsgOverlayWedgeModel.

virtual void makVrv::DtOverlayWedgeModel::setOutlineWidth ( float  )

pure virtual

Set/Get the outline width of the wedge.

Implemented in makVrv::DtOsgOverlayWedgeModel.

virtual float makVrv::DtOverlayWedgeModel::outlineWidth ( ) const

pure virtual

Set/Get the outline width of the wedge.

Implemented in makVrv::DtOsgOverlayWedgeModel.

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

pure virtual

Sets the inside and outside color of the wedge. Akin to calling setInsideColor(...) and setOutsideColor(...).

Reimplemented from makVrv::DtModel.

Implemented in makVrv::DtOsgOverlayWedgeModel.

virtual void makVrv::DtOverlayWedgeModel::setCentralVertexColor ( float  r, float  g, float  b, float  a  )

pure virtual

Set/Get the color of the wedge's central vertex. Valid range for argument values are 0.0 - 1.0.

Implemented in makVrv::DtOsgOverlayWedgeModel.

virtual bool makVrv::DtOverlayWedgeModel::getCentralVertexColor ( float &  r, float &  g, float &  b, float &  a  ) const

pure virtual

Set/Get the color of the wedge's central vertex. Valid range for argument values are 0.0 - 1.0.

Implemented in makVrv::DtOsgOverlayWedgeModel.

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

pure virtual

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

Implemented in makVrv::DtOsgOverlayWedgeModel.

virtual bool makVrv::DtOverlayWedgeModel::getInsideColor ( float &  r, float &  g, float &  b, float &  a  ) const

pure virtual

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

Implemented in makVrv::DtOsgOverlayWedgeModel.

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

pure virtual

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

Implemented in makVrv::DtOsgOverlayWedgeModel.

virtual bool makVrv::DtOverlayWedgeModel::getOutsideColor ( float &  r, float &  g, float &  b, float &  a  ) const

pure virtual

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

Implemented in makVrv::DtOsgOverlayWedgeModel.

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

pure virtual

Sets to handle or not handle mouse events.

Implemented in makVrv::DtOsgOverlayWedgeModel.

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

pure virtual

Sets to handle or not handle mouse events.

Implemented in makVrv::DtOsgOverlayWedgeModel.

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

pure 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.

Implemented in makVrv::DtOsgOverlayWedgeModel.

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

pure 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.

Implemented in makVrv::DtOsgOverlayWedgeModel.

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

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/DtOverlayWedgeModel.h