OSG implementation of the DtRectangularPyramidModel. More...

Inheritance diagram for makVrv::DtOsgRectangularPyramidModel:

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

virtual	~DtOsgRectangularPyramidModel ()
	Virtual DTOR. More...


virtual const std::string &	className () const
	Returns the name of this class. More...

virtual void	addToScene (const makVrv::DtUniqueID &sceneObjectId, int modelSet, int visualizerType)
	Attaches the model to the scene If this model has a modelinstance, it is attached to the scene. More...

virtual void	removeFromScene ()
	Detaches the model from the scene If this model has a modelinstance, it is detached from the scene. More...

virtual void	setModelDefinition (const std::string &str)
	Sets the model definition on the model instance Overridden to prevent lookup and instantiation of model instance using the DtModelInstanceFactory. More...

virtual void	setPosition (int vtx, const DtVector &position)
	Set the position of the rectangular pyramid Sets the position of the model's scene connector (model root) More...

virtual void	setOrientation (int vtx, const DtTaitBryan &orientation)
	Set the orientation of the rectangular pyramid Sets the orientation of the model's scene connector (model root) More...


virtual void	setRelativePosition (double x, double y, double z)
	Set the relative position of the rectangular pyramid Sets the position of the model instance relative to the parent node. More...

virtual void	setRelativeOrientation (const DtTaitBryan &ori)
	Set the relative orientation of the rectangular pyramid Sets the orientation of the model instance relative to the parent node. More...

virtual void	setSize (double slantHeight)
	Sets the size of the rectangular pyramid. More...

virtual void	setColor (float r, float g, float b, float a)
	Sets both the inside and outside colors. More...

virtual void	setInnerColor (float r, float g, float b, float a)
	Sets the inner color. More...

virtual void	setOuterColor (float r, float g, float b, float a)
	Sets the outer color. More...

virtual void	setXHalfAngle (double xHalfAngle)
	Set the half angle amount in the x direction. More...

virtual void	setYHalfAngle (double yHalfAngle)
	Set the half angle amount in the y direction. More...

virtual void	setShowLines (bool showLines)
	Set whether the wireframe outlines are visible on the geometry Sets whether the wireframe lines for the rectangular pyramid should be drawn If set, the wireframe lines are drawn in addition to the geometry faces. More...

virtual void	setLinesHaveAlpha (bool lineAlpha)
	Set whether the wireframe outlines should be rendered with alpha Sets whether the alpha component of the pyramid's colors should apply to the wireframe outlines as well as the faces, or just to the faces. 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...

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

virtual	~DtRectangularPyramidModel ()
	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)

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	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 void	setVisible (bool isVisible)
	Set the visible state of the model. 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	update ()
	Called on tick when updated, calls updateGeometry() of model instance. More...

virtual void	needsUpdate ()
	Call to set up callback for needing an update. 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
makVrv::DtOsgSceneConnector *	mySceneConnector

DtUniqueID	myTargetObjectId

DtUniqueID	myHostObjectId

DtVector	myRelativePosition

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

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

OSG implementation of the DtRectangularPyramidModel.

Constructor & Destructor Documentation

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

CTOR.

See Also: makVrv::DtRectangularPyramidModel( makVrv::DtDe&, makVrv::DtUniqueID& )

virtual makVrv::DtOsgRectangularPyramidModel::~DtOsgRectangularPyramidModel ( )

virtual

Virtual DTOR.

Member Function Documentation

virtual const std::string& makVrv::DtOsgRectangularPyramidModel::className ( ) const

virtual

Returns the name of this class.

See Also: makVrv::DtModel::className()

Reimplemented from makVrv::DtRectangularPyramidModel.

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

virtual

Attaches the model to the scene If this model has a modelinstance, it is attached to the scene.

See Also: makVrv::DtModel::addToScene( const DtUniqueID&, int, int )

Implements makVrv::DtModel.

virtual void makVrv::DtOsgRectangularPyramidModel::removeFromScene ( )

virtual

Detaches the model from the scene If this model has a modelinstance, it is detached from the scene.

See Also: makVrv::DtModel::removeFromScene()

Implements makVrv::DtModel.

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

virtual

Sets the model definition on the model instance Overridden to prevent lookup and instantiation of model instance using the DtModelInstanceFactory.

Parameters

str	the model definition to set

See Also: makVrv::DtModel::setModelDefinition( const std::string& )

Reimplemented from makVrv::DtModel.

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

virtual

Set the position of the rectangular pyramid Sets the position of the model's scene connector (model root)

Parameters

vtx	the vertex to set the position of (only 0 has any effect)
position	the position to set

See Also: makVrv::DtModel::setPosition( int, const DtVector& )

Reimplemented from makVrv::DtModel.

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

virtual

Set the orientation of the rectangular pyramid Sets the orientation of the model's scene connector (model root)

Parameters

vtx	the vertex to set the position of (only 0 has any effect)
ori	the orientation to set

See Also: makVrv::DtModel::setOrientation( int, const DtTaitBryan& )

Reimplemented from makVrv::DtModel.

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

virtual

Set the relative position of the rectangular pyramid Sets the position of the model instance relative to the parent node.

Parameters

x	the relative x translation
y	the relative y translation
z	the relative z translation

Implements makVrv::DtRectangularPyramidModel.

virtual void makVrv::DtOsgRectangularPyramidModel::setRelativeOrientation ( const DtTaitBryan & ori )

virtual

Set the relative orientation of the rectangular pyramid Sets the orientation of the model instance relative to the parent node.

Parameters

yaw	the yaw, -DtTaitBryan::psi()
pitch	the pitch, DtTaitBryan::theta()
roll	the roll, DtTaitBryan::phi()

Implements makVrv::DtRectangularPyramidModel.

virtual void makVrv::DtOsgRectangularPyramidModel::setSize ( double slantHeight )

virtual

Sets the size of the rectangular pyramid.

Parameters

slantHeight the length of the pyramid's slant height.

Implements makVrv::DtRectangularPyramidModel.

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

virtual

Sets both the inside and outside colors.

Sets the color of the entire rectangular pyramid.

Parameters

r	the red component of the color
g	the green component of the color
b	the blue component of the color
a	the alpha component of the color

Implements makVrv::DtRectangularPyramidModel.

virtual void makVrv::DtOsgRectangularPyramidModel::setInnerColor	(	float	r,
		float	g,
		float	b,
		float	a
	)

virtual

Sets the inner color.

Sets the color of the inside (near vertex) of the rectangular pyramid.

Parameters

r	the red component of the color
g	the green component of the color
b	the blue component of the color
a	the alpha component of the color

Implements makVrv::DtRectangularPyramidModel.

virtual void makVrv::DtOsgRectangularPyramidModel::setOuterColor	(	float	r,
		float	g,
		float	b,
		float	a
	)

virtual

Sets the outer color.

Sets the color of the outside (far vertices) of the rectangular pyramid.

Parameters

r	the red component of the color
g	the green component of the color
b	the blue component of the color
a	the alpha component of the color

Implements makVrv::DtRectangularPyramidModel.

virtual void makVrv::DtOsgRectangularPyramidModel::setXHalfAngle ( double xHalfAngle )

virtual

Set the half angle amount in the x direction.

Parameters

xHalfAngle the half-angle in the x direction.

Implements makVrv::DtRectangularPyramidModel.

virtual void makVrv::DtOsgRectangularPyramidModel::setYHalfAngle ( double yHalfAngle )

virtual

Set the half angle amount in the y direction.

Parameters

yHalfAngle the half-angle in the y direction.

Implements makVrv::DtRectangularPyramidModel.

virtual void makVrv::DtOsgRectangularPyramidModel::setShowLines ( bool showLines )

virtual

Set whether the wireframe outlines are visible on the geometry Sets whether the wireframe lines for the rectangular pyramid should be drawn If set, the wireframe lines are drawn in addition to the geometry faces.

Parameters

showLines whether the lines should be visible or hidden

Implements makVrv::DtRectangularPyramidModel.

virtual void makVrv::DtOsgRectangularPyramidModel::setLinesHaveAlpha ( bool lineAlpha )

virtual

Set whether the wireframe outlines should be rendered with alpha Sets whether the alpha component of the pyramid's colors should apply to the wireframe outlines as well as the faces, or just to the faces.

Parameters

whether the lines should be affected by the color's alpha values.

Implements makVrv::DtRectangularPyramidModel.

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

virtual

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

Implements makVrv::DtRectangularPyramidModel.

virtual void makVrv::DtOsgRectangularPyramidModel::update ( )

protectedvirtual

Called on tick when updated, calls updateGeometry() of model instance.

virtual void makVrv::DtOsgRectangularPyramidModel::needsUpdate ( )

protectedvirtual

Call to set up callback for needing an update.

Member Data Documentation

makVrv::DtOsgSceneConnector* makVrv::DtOsgRectangularPyramidModel::mySceneConnector

protected

DtUniqueID makVrv::DtOsgRectangularPyramidModel::myTargetObjectId

protected

DtUniqueID makVrv::DtOsgRectangularPyramidModel::myHostObjectId

protected

DtVector makVrv::DtOsgRectangularPyramidModel::myRelativePosition

protected

bool makVrv::DtOsgRectangularPyramidModel::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/DtOsgRectangularPyramidModel.h

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation