An OSG implementation of the Overlay Spider Web Model. More...

Inheritance diagram for makVrv::DtOsgOverlaySpiderWebModel:

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

virtual	~DtOsgOverlaySpiderWebModel ()
	DTOR. More...

virtual void	update ()
	Called on tick. More...

Model setters/getters (abstract)
virtual void	setPosition (const DtVector &position)
	Set/Get the global position of the spider web. More...

virtual DtVector	position () const


virtual void	setOrientation (const DtTaitBryan &orientation)
	Set the global orientation of the spider web. More...

virtual DtTaitBryan	orientation () const


virtual void	setMaxAngleSegment (double angleSegmentMax)
	Set/Get the max angle segment used when building the spider web. More...

virtual double	maxAngleSegment () const


virtual void	setRadius (double x)
	Set/Get the radius (in meters) of the spider web. More...

virtual double	radius () const


virtual void	setScale (float scale)
	Set/Get the spider web's scale factor. More...

virtual float	scale () const


virtual void	setVisible (bool isVisible)
	Set/Get whether the spider web is visible. More...

virtual bool	isVisible () const


virtual void	setNumberOfSpokes (unsigned int numSpokes)
	Set/Get the number of spokes the spider web has. More...

virtual unsigned int	numberOfSpokes () const


virtual void	setNumberOfRings (unsigned int numRings)
	Set/Get the number of rings the spider web has. More...

virtual unsigned int	numberOfRings () const


virtual void	setLineStipplePattern (unsigned int stipplePattern)
	Set/Get the line stipple pattern of the spider web. More...

virtual unsigned int	lineStipplePattern () const


virtual void	setLineWidth (float width)
	Set/Get the line width of the spider web. More...

virtual float	lineWidth () const


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

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


virtual void	setEventsEnabled (bool enabled)
	Set/Get to handle or not handle mouse events. More...

virtual bool	eventsEnabled () const


virtual void	setGroup (int groupNum)
	Set/Get the group this overlay will be drawn in. More...

virtual int	group () const


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

virtual void	setPosition (int vtx, const DtVector &position)
	Set the position of a vertex in the spider web This function only does something if vtx equals 0. More...

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

virtual	~DtOverlaySpiderWebModel ()
	DTOR. More...

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

Protected Member Functions
virtual void	needsUpdate ()
	Sets flag so the object is updated in the next update pass. More...


virtual void	addToScene (const DtUniqueID &sceneObjectId, int modelSet, int visualizerType)
	Attaches the model to the scene. More...

virtual void	removeFromScene ()
	Detaches the model from the scene. More...

virtual void	setIsSupportModel (bool isSupport)
	Set whether the model is part of the support group (whether or not other scene objects can ground clamp to this model) More...

Protected Member Functions inherited from makVrv::DtModel
virtual void	addToSceneAsProp (const DtUniqueID &sceneObjectId)
	Add this model to the scene as a prop. 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
double	myOffsetAngle

DtUniqueID	myParentId

bool	myNeedsUpdate

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

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

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

DtOsgOverlaySpiderWebModel &	operator= (const DtOsgOverlaySpiderWebModel &)
	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

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

Detailed Description

An OSG implementation of the Overlay Spider Web Model.

A spider web has the following geometric parameters:

Number of Spokes: Change the number of spokes the spider web has
Number of Rings: Change the rings the spider web has
Position: Change the position of the spider web's origin
Radius: Change the radius of the circle used to draw the spider web
Max Angle Segment: Affects the number of vertices used to draw each ring of the spider web. If you want to use X vertices to draw each ring of the spider web, then Max Angle Segment is equal to (2*PI) / X.
Scale: Change the numeric factor that the spider web is scaled by

A spider web has the following style properties:

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

Special Considerations:

The spokes and rings will be drawn equally distanced from each other
The spokes indicate the number of diameter length spokes, i.e. there will be 2 times the number of radius length spokes.

Constructor & Destructor Documentation

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

CTOR.

virtual makVrv::DtOsgOverlaySpiderWebModel::~DtOsgOverlaySpiderWebModel ( )

virtual

DTOR.

makVrv::DtOsgOverlaySpiderWebModel::DtOsgOverlaySpiderWebModel ( )

private

Default Constructor not implemented.

makVrv::DtOsgOverlaySpiderWebModel::DtOsgOverlaySpiderWebModel ( const DtOsgOverlaySpiderWebModel & )

private

Copy Constructor not implemented � Copy not allowed.

Member Function Documentation

virtual void makVrv::DtOsgOverlaySpiderWebModel::setPosition ( const DtVector & position )

virtual

Set/Get the global position of the spider web.

Implements makVrv::DtOverlaySpiderWebModel.

virtual DtVector makVrv::DtOsgOverlaySpiderWebModel::position ( ) const

virtual

Implements makVrv::DtOverlaySpiderWebModel.

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

virtual

Set the global orientation of the spider web.

Implements makVrv::DtOverlaySpiderWebModel.

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

virtual

Implements makVrv::DtOverlaySpiderWebModel.

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

virtual

Set/Get the max angle segment used when building the spider web.

Implements makVrv::DtOverlaySpiderWebModel.

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

virtual

Implements makVrv::DtOverlaySpiderWebModel.

virtual void makVrv::DtOsgOverlaySpiderWebModel::setRadius ( double x )

virtual

Set/Get the radius (in meters) of the spider web.

Implements makVrv::DtOverlaySpiderWebModel.

virtual double makVrv::DtOsgOverlaySpiderWebModel::radius ( ) const

virtual

Implements makVrv::DtOverlaySpiderWebModel.

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

virtual

Set/Get the spider web's scale factor.

Implements makVrv::DtOverlaySpiderWebModel.

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

virtual

Implements makVrv::DtOverlaySpiderWebModel.

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

virtual

Set/Get whether the spider web is visible.

Implements makVrv::DtOverlaySpiderWebModel.

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

virtual

Implements makVrv::DtOverlaySpiderWebModel.

virtual void makVrv::DtOsgOverlaySpiderWebModel::setNumberOfSpokes ( unsigned int numSpokes )

virtual

Set/Get the number of spokes the spider web has.

Implements makVrv::DtOverlaySpiderWebModel.

virtual unsigned int makVrv::DtOsgOverlaySpiderWebModel::numberOfSpokes ( ) const

virtual

Implements makVrv::DtOverlaySpiderWebModel.

virtual void makVrv::DtOsgOverlaySpiderWebModel::setNumberOfRings ( unsigned int numRings )

virtual

Set/Get the number of rings the spider web has.

Implements makVrv::DtOverlaySpiderWebModel.

virtual unsigned int makVrv::DtOsgOverlaySpiderWebModel::numberOfRings ( ) const

virtual

Implements makVrv::DtOverlaySpiderWebModel.

virtual void makVrv::DtOsgOverlaySpiderWebModel::setLineStipplePattern ( unsigned int stipplePattern )

virtual

Set/Get the line stipple pattern of the spider web.

Implements makVrv::DtOverlaySpiderWebModel.

virtual unsigned int makVrv::DtOsgOverlaySpiderWebModel::lineStipplePattern ( ) const

virtual

Implements makVrv::DtOverlaySpiderWebModel.

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

virtual

Set/Get the line width of the spider web.

Implements makVrv::DtOverlaySpiderWebModel.

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

virtual

Implements makVrv::DtOverlaySpiderWebModel.

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

virtual

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

Implements makVrv::DtOverlaySpiderWebModel.

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

virtual

Implements makVrv::DtOverlaySpiderWebModel.

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

virtual

Set/Get to handle or not handle mouse events.

Implements makVrv::DtOverlaySpiderWebModel.

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

virtual

Implements makVrv::DtOverlaySpiderWebModel.

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

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.

Implements makVrv::DtOverlaySpiderWebModel.

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

virtual

Implements makVrv::DtOverlaySpiderWebModel.

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

virtual

Sets the model definition on the model instance.

Reimplemented from makVrv::DtModel.

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

virtual

Set the position of a vertex in the spider web This function only does something if vtx equals 0.

Reimplemented from makVrv::DtModel.

virtual void makVrv::DtOsgOverlaySpiderWebModel::update ( )

virtual

Called on tick.

virtual void makVrv::DtOsgOverlaySpiderWebModel::addToScene	(	const DtUniqueID &	sceneObjectId,
		int	modelSet,
		int	visualizerType
	)

protectedvirtual

Attaches the model to the scene.

Implements makVrv::DtModel.

virtual void makVrv::DtOsgOverlaySpiderWebModel::removeFromScene ( )

protectedvirtual

Detaches the model from the scene.

Implements makVrv::DtModel.

virtual void makVrv::DtOsgOverlaySpiderWebModel::setIsSupportModel ( bool isSupport )

protectedvirtual

Set whether the model is part of the support group (whether or not other scene objects can ground clamp to this model)

Implements makVrv::DtModel.

virtual void makVrv::DtOsgOverlaySpiderWebModel::needsUpdate ( )

protectedvirtual

Sets flag so the object is updated in the next update pass.

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

private

Assignment Operator not implemented � Copy not allowed.

Member Data Documentation

double makVrv::DtOsgOverlaySpiderWebModel::myOffsetAngle

protected

DtUniqueID makVrv::DtOsgOverlaySpiderWebModel::myParentId

protected

bool makVrv::DtOsgOverlaySpiderWebModel::myNeedsUpdate

protected

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

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf4-8-branch/include/vrvOsg/DtOsgOverlaySpiderWebModel.h

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation