An articulated model manipulator for controlling an articulated model. More...

Inheritance diagram for makVrv::DtArticulatedModel:

Public Types
enum	AnimationState { START, STOP, PAUSE, RESUME }

typedef std::vector< int >	PartList

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

virtual	~DtArticulatedModel ()
	DTOR. More...

virtual void	setModelScalingEnabled (bool b)=0
	Indicate whether or not this model may be model-scaled Default is false. More...

virtual void	setModelDefinition (const std::string &def)=0
	Override the set model definition function. More...

virtual void	setLocalModelScalingEnabled (bool enabled)=0
	Indicates whether local model scaling for the model is enabled. More...

virtual void	setLocalModelScalingAmount (float localScl)=0
	Sets the amount of local scaling to apply to the model. More...

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

virtual bool	findPartPositionAndOrientation (int partNumber, DtVector &position, DtQuat &ori)=0
	Finds the absolute position and orientation of a part. More...

virtual bool	supportsMultithreadedLoad ()
	controls if the model is loaded in the background More...


virtual void	setPartTranslation (int partNumber, const DtVector &transform, const DtVector &velocity)=0
	Update the part translation. More...

virtual void	setPartOrientation (int partNumber, const DtTaitBryan &orientation, const DtVector &rotationalVelocity)=0
	Rotate the part. More...

virtual void	setPartRotationalVelocity (int partNumber, const DtVector &rotationalVelocity, bool forceUpdate)=0
	Set just rotational velocity for part with the option to force an update next frame (default) or not. More...

virtual void	setPartVisibility (int partNumber, bool onOff)=0

virtual void	setState (int stateNumber, int stateValue)=0
	Set the state on the model. More...

virtual void	setLightpointMaxDistance (float distance)=0
	Specify the maximum range at which lightpoints on this model will be visible. More...

virtual void	setAnimationFrame (const std::string &animationName, int frameIndex)=0
	Set the current frame of an animation. More...

virtual void	setAnimationRange (const std::string &animationName, int firstFrameIndex, int lastFrameIndex)=0
	Set the animation range. More...

virtual void	setAnimationSpeed (const std::string &animationName, double framesPerSecond)=0
	Set the animation speed. More...

virtual void	setAnimationState (const std::string &animationName, AnimationState mode)=0

virtual void	getParts (PartList &parts) const =0
	Get the part list. More...

virtual void	setUvOffset (const std::string &annotation, float uOffset, float vOffset)=0
	Groups using a texture atlas are identified using an annotation (ex. More...

virtual void	setDynamicSensorRegion (const std::string &region, bool state)=0
	Set the state of a dynamic sensor region. More...

virtual bool	dynamicSensorRegion (const std::string &region)=0
	Get the state of a dynamic sensor region. More...

virtual void	setLinkageConfigPair (const std::string &linkageName, const std::string &configName)=0
	Configure an entity according to a (linkageName, configName) pair. 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 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	setColor (float r, float g, float b, float a)
	set the model's color 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	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 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...

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

An articulated model manipulator for controlling an articulated model.

Member Typedef Documentation

typedef std::vector<int> makVrv::DtArticulatedModel::PartList

Member Enumeration Documentation

enum makVrv::DtArticulatedModel::AnimationState

Enumerator
START
STOP
PAUSE
RESUME

Constructor & Destructor Documentation

makVrv::DtArticulatedModel::DtArticulatedModel	(	DtDe &	,
		DtUniqueID	id
	)

CTOR.

virtual makVrv::DtArticulatedModel::~DtArticulatedModel ( )

virtual

DTOR.

Member Function Documentation

virtual void makVrv::DtArticulatedModel::setModelScalingEnabled ( bool b )

pure virtual

Indicate whether or not this model may be model-scaled Default is false.

Implemented in makVrv::DtOsgArticulatedModel.

virtual void makVrv::DtArticulatedModel::setModelDefinition ( const std::string & def )

pure virtual

Override the set model definition function.

Use this to parse a model after it is loaded.

Reimplemented from makVrv::DtModel.

Implemented in makVrv::DtOsgArticulatedModel, makVrf::DtVrfOsgArticulatedModel, and DtVrfOsgArticulatedModel.

virtual void makVrv::DtArticulatedModel::setLocalModelScalingEnabled ( bool enabled )

pure virtual

Indicates whether local model scaling for the model is enabled.

Local model scaling overrides generic (global) model scaling. Default is false.

Implemented in makVrv::DtOsgArticulatedModel.

virtual void makVrv::DtArticulatedModel::setLocalModelScalingAmount ( float localScl )

pure virtual

Sets the amount of local scaling to apply to the model.

Only applies when local model scaling is enabled.

Implemented in makVrv::DtOsgArticulatedModel.

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

pure virtual

Get the class name of the model instance owner.

This is used to control how model instances are created.

Reimplemented from makVrv::DtModel.

Implemented in makVrv::DtOsgArticulatedModel.

virtual void makVrv::DtArticulatedModel::setPartTranslation	(	int	partNumber,
		const DtVector &	transform,
		const DtVector &	velocity
	)

pure virtual

Update the part translation.

Implemented in makVrv::DtOsgArticulatedModel.

virtual void makVrv::DtArticulatedModel::setPartOrientation	(	int	partNumber,
		const DtTaitBryan &	orientation,
		const DtVector &	rotationalVelocity
	)

pure virtual

Rotate the part.

Implemented in makVrv::DtOsgArticulatedModel.

virtual void makVrv::DtArticulatedModel::setPartRotationalVelocity	(	int	partNumber,
		const DtVector &	rotationalVelocity,
		bool	forceUpdate
	)

pure virtual

Set just rotational velocity for part with the option to force an update next frame (default) or not.

Implemented in makVrv::DtOsgArticulatedModel.

virtual void makVrv::DtArticulatedModel::setPartVisibility	(	int	partNumber,
		bool	onOff
	)

pure virtual

Implemented in makVrv::DtOsgArticulatedModel.

virtual void makVrv::DtArticulatedModel::setState	(	int	stateNumber,
		int	stateValue
	)

pure virtual

Set the state on the model.

Implemented in DtVrfOsgMultipleArticulatedModel, and makVrv::DtOsgArticulatedModel.

virtual void makVrv::DtArticulatedModel::setLightpointMaxDistance ( float distance )

pure virtual

Specify the maximum range at which lightpoints on this model will be visible.

This sets ALL lightpoints to the same range.

Implemented in makVrv::DtOsgArticulatedModel.

virtual void makVrv::DtArticulatedModel::setAnimationFrame	(	const std::string &	animationName,
		int	frameIndex
	)

pure virtual

Set the current frame of an animation.

Implemented in makVrv::DtOsgArticulatedModel.

virtual void makVrv::DtArticulatedModel::setAnimationRange	(	const std::string &	animationName,
		int	firstFrameIndex,
		int	lastFrameIndex
	)

pure virtual

Set the animation range.

Implemented in makVrv::DtOsgArticulatedModel.

virtual void makVrv::DtArticulatedModel::setAnimationSpeed	(	const std::string &	animationName,
		double	framesPerSecond
	)

pure virtual

Set the animation speed.

Implemented in makVrv::DtOsgArticulatedModel.

virtual void makVrv::DtArticulatedModel::setAnimationState	(	const std::string &	animationName,
		AnimationState	mode
	)

pure virtual

Implemented in makVrv::DtOsgArticulatedModel.

virtual void makVrv::DtArticulatedModel::getParts ( PartList & parts ) const

pure virtual

Get the part list.

Implemented in makVrv::DtOsgArticulatedModel.

virtual void makVrv::DtArticulatedModel::setUvOffset	(	const std::string &	annotation,
		float	uOffset,
		float	vOffset
	)

pure virtual

Groups using a texture atlas are identified using an annotation (ex.

annotation label_char_1). setUvOffset is used to set the offset into the atlas texture for the group indicated by the annotation.

Implemented in makVrv::DtOsgArticulatedModel.

virtual void makVrv::DtArticulatedModel::setDynamicSensorRegion	(	const std::string &	region,
		bool	state
	)

pure virtual

Set the state of a dynamic sensor region.

Implemented in makVrv::DtOsgArticulatedModel.

virtual bool makVrv::DtArticulatedModel::dynamicSensorRegion ( const std::string & region )

pure virtual

Get the state of a dynamic sensor region.

Implemented in makVrv::DtOsgArticulatedModel.

virtual void makVrv::DtArticulatedModel::setLinkageConfigPair	(	const std::string &	linkageName,
		const std::string &	configName
	)

pure virtual

Configure an entity according to a (linkageName, configName) pair.

Additional entity state may be configured via a metafile referenced by the DtModelDefinition. The linkageName is the name of the linkage within the metafile, either the NodeName or the Annotation. The configName is how the linkage of the entity is to be configured using data a from the configName mappings of the FeatureData for the linkage according to the FeatureName tag.

Implemented in makVrv::DtOsgArticulatedModel.

virtual bool makVrv::DtArticulatedModel::findPartPositionAndOrientation	(	int	partNumber,
		DtVector &	position,
		DtQuat &	ori
	)

pure virtual

Finds the absolute position and orientation of a part.

This function is more efficient than calling both the position and orientation functions.

Implemented in makVrv::DtOsgArticulatedModel.

virtual bool makVrv::DtArticulatedModel::supportsMultithreadedLoad ( )

virtual

controls if the model is loaded in the background

Reimplemented from makVrv::DtModel.

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

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf4-8-branch/include/vrvCore/DtArticulatedModel.h

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation