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

Inheritance diagram for makVrv::DtOverlayWedgeModel:

[legend]

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

virtual	~DtOverlayWedgeModel ()
	DTOR. More...

virtual void	setOrientation (const DtTaitBryan &orientation)=0
	Set the global orientation of the wedge. More...

virtual void	setFillPattern (const std::vector< unsigned int > &)=0
	Set the fill stipple pattern of the wedge. More...

virtual void	setColor (float r, float g, float b, float a)=0
	Sets the inside and outside color of the wedge. More...

Model setters/getters (abstract)
virtual void	setOrigin (const DtVector &position)=0
	Set/Get the global position of the wedge. More...

virtual DtVector	origin () const =0


virtual void	setRelativePosition (double x, double y, double z)=0
	Set/Get the local translation of the wedge. More...

virtual DtVector	relativePosition () 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	setRadius (float len)=0
	Set/Get the radius of the wedge. More...

virtual float	radius () const =0


virtual void	setScale (float scale)=0
	Set/Get the numeric factor the wedge is scaled by. More...

virtual float	scale () const =0


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

virtual bool	isVisible () const =0


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

virtual double	startAngle () const =0


virtual void	setWedgeSpan (double wedgeSpan)=0
	Set/Get the span of the wedge, in radians. More...

virtual double	wedgeSpan () const =0


virtual void	setFill (bool)=0
	Set/Get whether or not to draw a filled wedge. More...

virtual bool	isFill () const =0


virtual void	setOutline (bool)=0
	Set/Get whether or not to outline a filled wedge. More...

virtual bool	isOutline () const =0


virtual void	setSolidFillCenter (bool)=0
	Set/Get whether to solid fill or gradient fill the wedge. More...

virtual bool	isSolidFillCenter () const =0


virtual void	setStipplePattern (unsigned int stipplePattern)=0
	Set/Get the stipple pattern for the wedge. More...

virtual unsigned int	stipplePattern () const =0


virtual void	setOutlineWidth (float)=0
	Set/Get the outline width of the wedge. More...

virtual float	outlineWidth () const =0


virtual void	setCentralVertexColor (float r, float g, float b, float a)=0
	Set/Get the color of the wedge's central vertex. More...

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
	Set/Get the inside color of the wedge. More...

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
	Set/Get the outside color of the wedge. More...

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


virtual void	setEventsEnabled (bool enabled)=0
	Sets to handle or not handle mouse events. More...

virtual bool	eventsEnabled () const =0


virtual void	setGroup (int groupNum)=0
	Sets the group this overlay will be drawn in. More...

virtual int	group () const =0

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

virtual	~DtModel ()
	DTOR. More...

DtModelInstance *	createModelInstance (const std::string &modelDefName, bool realize=true)
	Set the model definition and creates an instance of the model. More...

virtual void	setModelDefinition (const std::string &str)
	Set the model definition. More...

virtual const std::string &	modelDefinitionName ()
	returns the model definition name. More...

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

virtual const std::string &	className () const
	Get the class name of the model instance owner. More...

unsigned int	transformSize () const
	Get the number of position/orientations this model has. More...

virtual void	setPosition (int vtx, const DtVector &position)
	Set the position of a control vertex in the model. More...

virtual const DtVector &	position (int vtx=0) const
	Get the Position of a given point. More...

virtual void	removePosition (int vtx)
	Remove a transform at the given position. More...

virtual void	setPositionOffset (const DtVector &positionOffset)
	Set the position offset of the model. More...

virtual const DtVector &	positionOffset () const
	Get the Position Offset of the model. More...

virtual void	setOrientation (int vtx, const DtTaitBryan &orientation)
	Set the orientation of a vertex in the model. More...

virtual void	setPositionAndOrientation (int vtx, const DtVector &positionOffset, const DtTaitBryan &orientation)
	Set the position and orientation of a vertex in the model at the same time. More...

virtual const DtTaitBryan &	orientation (int vtx=0) const
	Get the Orientation of a given point. More...

virtual void	setOrientationOffset (const DtTaitBryan &orientationOffset)
	Set the Orientation Offset of the model. More...

virtual const DtTaitBryan &	orientationOffset () const
	Get the Orientation Offset of the model. More...

virtual void	enableColorBlending (bool b)
	Enable / disable color blending for this model. More...

virtual void	setBlendColor (float r, float g, float b, float a)
	Set color to use if color blending is enabled. More...

virtual void	getBlendColor (float &r, float &g, float &b, float &a)
	Returns the blend color. More...

virtual bool	colorBlendingEnabled () const
	Returns whether or not blending is enabled. More...

virtual void	enableLighting (bool l)
	set whether the model is lit; this may not be an option on all models More...

virtual int	modelSet () const
	Get the model set this model is part of. More...

const DtVector &	boundingBoxExtents () const
	Get the bounding box extents of the model instance. More...

void	getBoundingBoxExtents (double &x, double &y, double &z) const
	Get the bounding box extents of the model instance. More...

const DtVector &	boundingBoxCenter () const
	Get the bounding box center of the model instance. More...

virtual void	getBoundingBoxCenter (double &x, double &y, double &z) const
	Get the bounding box center of the model instance. More...

virtual void	getBoundingBoxComponents (DtVector &minimum, DtVector &maximum)
	Get the minimum and maximum X,Y,Z components of the bounding box. More...

void	setContributesToBound (bool trueOrFalse)
	Set whether this model instance contributes to an object's overall bounding volume. More...

bool	contributesToBound () const
	Get whether this model instance contributes to an object's overall bounding volume. More...

DtDe &	de ()
	Get the DtDe object. More...

virtual void	setModelInstance (DtModelInstance *modelInstance)
	Internally set the model instance pointer. More...

virtual void	promoteBackgroundModelInstance (DtModelDefinition &defintion)
	Internally set the model instance pointer to the background one, also realizes and sends signal. More...

virtual bool	visible () const
	Get the visible state of the model. More...

DtUniqueID	parentSceneObjectID () const
	Parent of the model. More...

virtual void	addedToSceneObjectAsProp (const DtUniqueID &sceneObj)
	Called when a scene object added the model as a prop. More...

virtual void	addedToSceneObject (const DtUniqueID &sceneObj, int modelSet, int visualizerType)
	Called when a scene object added the model with the given model set and visualizer type. More...

virtual void	setElementId (DtUniqueID id)
	Called when the element ID of the model's parent object is set. More...

virtual void	removedFromSceneObject ()
	Called when the model was removed from a scene object. More...

virtual void	setIsSupportModel (bool isSupport)=0
	Is this model part of the support group? (determines whether or not other scene objects can ground clamp to this model) More...

virtual void	setSolid (bool isSolid)
	Set whether or not other this model is drawn filled in. More...

virtual bool	isProp ()
	Return whether or not this model was added as a prop. More...

virtual void	updateMinLastFrameDistance (float distance)
	updates the closest distance to an observer over the last frame More...

virtual void	resetLastFrameDistance ()
	resets the closest distance to an observer More...

virtual float	minLastFrameDistance () const
	gets the closest distance to an observer last frame More...

virtual DtModelInstance *	modelInstance ()
	Get the model instance. More...

virtual const DtModelInstance *	modelInstance () const

int	visualizerType () const
	The visualizer type determines which channel-specific group node this model will be parented to, and consequently, which observer setting will cause it to be rendered in which channel. More...

virtual bool	supportsMultithreadedLoad ()
	can be quickly overridden to disable background loading More...

virtual void	backgroundLoad ()
	the chunk of loading that can safely happen in the background More...

virtual void	foregroundLoad ()
	the chunk of loading that must happen happen in the foreground, adding to scene graph etc. More...

virtual bool	isActivelyBackgroundLoading ()
	is this being actively loaded (it has a myInLoadQueueHandle object and it's loading) More...

virtual DtLoaderHandle *	getLoadQueueHandle ()
	returns the load queue object More...

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

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

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

Additional Inherited Members
Public Attributes inherited from makVrv::DtModel
boost::signal< void(DtModel *)>	signal_modelToBeDestroyed
	Signal emitted when the model is to be destroyed. More...

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

boost::signal< bool(DtModel *, bool), SlotReturnOR >	signal_visibilityChangeRequested
	Signal when the visibility has been requested, if any slot returns false, it will not change. More...

boost::signal< void(DtModelInstance , DtModel )>	signal_modelInstanceCreated
	Signal emitted when the model instance is created. More...

boost::signal< void(DtModelInstance , DtModel )>	signal_modelInstanceToBeDestroyed
	Signal emitted when the model instance is to be destroyed. More...

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 Functions to be implemented, add this model to the scene. More...

virtual void	addToSceneAsProp (const DtUniqueID &sceneObjectId)
	Add this model to the scene as a prop. More...

virtual void	removeFromScene ()=0
	Virtual Functions to be implemented, remove this model from the scene. More...

virtual void	initializeModelInstance ()
	Push any state maintained by the model to the model instance. More...

void	slot_modelInstanceChanged (DtModelInstance *instance)
	Called when the model instance changed. More...

virtual void	waitAndClearLoadHandle ()
	avoids race condition, on destruction subclasses need to wait for the model to cleanly finish loading this can happen if an object times in and out very quickly More...

virtual void	removedFromLoadQueue ()
	deletes the myInLoadQueueHandle handle More...

virtual void	setDoneBackgroundLoading ()
	called by async task, updates myCurrentlyLoading atomic More...

virtual void	setActivelyBackgroundLoading ()
	called right before tbb task creation More...

Protected Attributes inherited from makVrv::DtModel
DtLoaderHandle *	myInLoadQueueHandle

DtDe &	myDe

const DtUniqueID	myUniqueId
	The unique id is constant after initialization. More...

bool	myColorBlendingEnabled
	The color blending enabled is needed to be set by the derived class so it doesn't get down to the model instances when instancing is enabled. More...

DtModelInstance *	myBackgroundModelInstance
	holds the model created in the background for a bit More...

float	myMinLastFrameDistance
	last frames mimimal distance to the camera, calculated by the instancing system More...

TransformList	myTransforms
	We keep our own copy in case we get updates before we get a model instance. More...

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

Detailed Description

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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.vrf4-8-branch/include/vrvCore/DtOverlayWedgeModel.h

Public Member Functions

Private Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation