An articulated model manipulator for controlling an articulated model. Supports indirect rendering of models. Old code paths for OSG rendering and instanced rendering have moved to.

See Also: DtDeprecatedOsgArticulatedModel. This class uses the singleton; DtIndirectEntityManager to interact with the indirect rendering system. Entity instances are added to the indirect system through this manager along with any changes to the state of the model (dofs/switches/colors/etc). The; DtIndirectEntityManager functions take in the myUniqueId for the model and map it into an instance in the indirect system. Any state that is set before the instance has been added to the indirect system is saved by the; DtOsgArticulatedModel object and sent down once the instance has been created (reapplyState()).

Inheritance diagram for makVrv::DtOsgArticulatedModel:

[legend]

Public Types
typedef std::vector< osg::Node * >	NodeList

typedef std::unordered_map < int, NodeList >	NodePathCache

typedef std::map< std::string, std::string >	LinkageConfigMap

typedef std::unordered_map < std::string, std::pair < float, float > >	AnnotationNameToUvsMap

Public Types inherited from makVrv::DtArticulatedModel
enum	AnimationState { START, STOP, PAUSE, RESUME }

typedef std::vector< int >	PartList

Public Member Functions
	DtOsgArticulatedModel (DtDe &, DtUniqueID id)

virtual	~DtOsgArticulatedModel ()

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

virtual const std::string &	modelDefinition () const

virtual const std::string &	className () const

virtual DtUniqueID	uniqueId () const

virtual DtUniqueID	sceneObjectId () const

virtual void	setElementId (DtUniqueID id)

virtual DtUniqueID	elementId ()

virtual void	weaponFired (const DtUnicode &munitionModelDefName) override

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

virtual const AnnotationNameToUvsMap &	annotationsMap (void) const

virtual void	setDepthMask (osg::Group &parent)

virtual void	addAnnotationGroup (const std::string &annotation, osg::Group *group)

virtual void	setIsSupportModel (bool isSupport)

virtual void	getBoundingBoxComponents (DtVector &minimum, DtVector &maximum)

virtual bool	applyMetafile (const DtModelDefinition *definition)

virtual void	slot_onShadowStateChanged (bool on)

virtual void	slot_atcModeEnableChanged (bool state)

virtual void	setSingleChildOn (osgSim::MultiSwitch *multiSwitch, unsigned int switchIndex, int nodeTypeIndex)

virtual void	setDofHpr (osgSim::DOFTransform *dof, const DtVector &hpr, int animationFlags)

virtual void	setDofHprVel (osgSim::DOFTransform *dof, const DtVector &hprVel, int animationFlags)


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

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

virtual void	setPositionOffset (const DtVector &positionOffset)

virtual void	setOrientationOffset (const DtTaitBryan &orientationOffset)

virtual void	setPositionAndOrientation (int vtx, const DtVector &position, const DtTaitBryan &orientation)

virtual void	setVisible (bool isVisible)


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

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

virtual void	setPartRotationalVelocity (int partNumber, const DtVector &rotationalVelocity, bool forceUpdate=true)

virtual bool	findPartPositionAndOrientation (int partNumber, DtVector &position, DtQuat &ori) override

virtual DtVector	partTranslation (int partNumber) const

virtual DtTaitBryan	partOrientation (int partNumber) const

virtual void	setPartVisibility (int partNumber, bool onOff)

const DtArticulatedModelParser::PartMap &	parts () const

virtual void	getParts (PartList &parts) const

virtual void	addPart (int partNumber, osgSim::DOFTransform *node)


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

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

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

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

virtual void	setAnimationLastFrameTime (const std::string &animationName, double animationLastFrameTime)

virtual void	setAnimationLoopCount (const std::string &animationName, int loopCount)

virtual int	animationFrameCount (const std::string &animationName) const

virtual int	animationCurrentFrame (const std::string &animationName) const

virtual int	animationFirstFrame (const std::string &animationName) const

virtual int	animationLastFrame (const std::string &animationName) const

virtual double	animationSpeed (const std::string &animationName) const

virtual AnimationState	animationState (const std::string &animationName) const

virtual double	animationLastFrameTime (const std::string &animationName) const

virtual int	animationLoopCount (const std::string &animationName) const

virtual const DtArticulatedModelParser::AnimationMap &	animations () const

virtual void	addAnimation (const std::string &animationName, osg::Sequence *node)

virtual const DtArticulatedModelParser::FlipBookAnimationMap &	flipBookAnimations () const

virtual const DtArticulatedModelParser::FlipBookAnimationMap &	flipBookAnimationsWithVelocityControl () const

virtual void	setFlipBookAnimationsSpeed (double leftSpeed, double rightSpeed, double mainSpeed)

virtual const DtArticulatedModelParser::ScrollableTextureGroupMap &	scrollableTextureGroupMap () const

virtual void	scrollUvTextures (double leftSpeed, double rightSpeed, double mainSpeed)


virtual void	setModelScalingEnabled (bool b)

virtual bool	modelScalingEnabled ()

virtual void	setLocalModelScalingEnabled (bool enabled)

virtual void	setLocalModelScalingAmount (float localScl)


virtual void	setColor (float r, float g, float b, float a)

virtual void	enableColorBlending (bool b)

virtual void	setBlendColor (float r, float g, float b, float a)


virtual void	setOtherData0 (float r, float g, float b, float a)


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

virtual LinkageConfigMap &	linkageConfigMap ()

virtual const LinkageConfigMap &	linkageConfigMap () const


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

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


virtual void	setState (int stateNumber, int stateValue)

virtual void	setStateUnfiltered (int stateNumber, int stateValue)

virtual void	reapplyState ()

virtual int	state (int stateNumber) const

const DtArticulatedModelParser::MapStateNumberToMultiSwitchList &	states () const

virtual void	addState (int stateNumber, osgSim::MultiSwitch *node)

virtual void	setStateValueExists (int stateNumber, int stateValue)


virtual void	setLightpointMaxDistance (float distance)

virtual void	setLightPointGroup (const std::string &groupName)

virtual const std::string &	lightPointGroup () const

Public Member Functions inherited from makVrv::DtArticulatedModel
	DtArticulatedModel (DtDe &, DtUniqueID id)

virtual	~DtArticulatedModel ()

virtual bool	supportsMultithreadedLoad ()

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

virtual	~DtModel ()

DtModelInstance *	createModelInstance (const std::string &modelDefName, bool realize=true)

virtual const std::string &	modelDefinitionName ()

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

unsigned int	transformSize () const

virtual const DtVector &	position (int vtx=0) const

virtual void	removePosition (int vtx)

virtual const DtVector &	positionOffset () const

virtual const DtTaitBryan &	orientation (int vtx=0) const

virtual const DtTaitBryan &	orientationOffset () const

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

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	removedFromSceneObject ()

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	isActivelyBackgroundLoading ()

virtual DtLoaderHandle *	getLoadQueueHandle ()

Static Public Member Functions

static void	setTrackObjects (bool val)

static bool	trackObjects (void)

Public Attributes
boost::signalslib::signal < void(DtOsgArticulatedModel *, int, int)>	signal_SetState

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
typedef std::unordered_map < std::string, bool >	SensorRegionStateMap

typedef std::map< int, std::pair< DtTaitBryan, DtVector > >	PartOrientationMap

typedef std::map< int, std::pair< DtVector, DtVector > >	PartTranslationMap

Protected Types inherited from makVrv::DtModel
typedef std::vector < ObjectTransform >	TransformList

Protected Member Functions
virtual void	setStateInternal (int stateNumber, int stateValue)

virtual void	setUvOffsetInternal (const std::string &annotation, float uOffset, float vOffset)

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

virtual void	removeFromScene ()

virtual void	modelInstanceToBeDeleted ()

virtual void	modelInstanceCreatedInternal (osg::Node root, DtOsgModelInstance osgModelInstance, bool daylightControlledLights, float scale)

virtual void	modelInstanceCreated (bool castShadows, bool daylightControlledLights, float scale)

virtual void	mergeCurrentStateWithDefaults (DtArticulatedModelParser *parser)

virtual void	parseModel (osg::Node *root)

virtual void	backgroundLoad ()

virtual void	discoverDynamicRegions (const DtModelDefinition *definition)

virtual void	foregroundLoad ()

virtual void	backgroundLoadInternal (DtModelDefinition *definition)

virtual void	backgroundLoadFirstLoadInternal (DtModelDefinition *definition)

virtual void	foregroundLoadInternal ()

virtual void	modelInstanceToBeDeletedInternal (void)


virtual void	setPartTranslationInternal (int partNumber, const DtVector &transform, const DtVector &velocity)

virtual void	setPartOrientationInternal (int partNumber, const DtTaitBryan &orientation, const DtVector &rotationalVelocity)

virtual void	setPartRotationalVelocityInternal (int partNumber, const DtVector &rotationalVelocity, bool forceUpdate=true)

virtual void	disablePart (int partNumber)

virtual void	enablePart (int partNumber)

Protected Member Functions inherited from makVrv::DtModel
virtual void	addToSceneAsProp (const DtUniqueID &sceneObjectId)

virtual void	initializeModelInstance ()

void	slot_modelInstanceChanged (DtModelInstance *instance)

virtual void	waitAndClearLoadHandle ()

virtual void	removedFromLoadQueue ()

virtual void	setDoneBackgroundLoading ()

virtual void	setActivelyBackgroundLoading ()

Protected Attributes
DtArticulatedModelParser::MapStateNumberToStateExistenceList	myMapStateNumberToStateExistenceList

DtArticulatedModelParser::MapStateNumberToStateValue	myMapStateNumberToStateValue

DtArticulatedModelParser::PartMap	myPartMap

DtArticulatedModelParser::MapStateNumberToMultiSwitchList	myMapStateNumberToMultiSwitchList

DtArticulatedModelParser::AnimationMap	myAnimationMap

DtArticulatedModelParser::FlipBookAnimationMap	myFlipBookAnimationMap

DtArticulatedModelParser::FlipBookAnimationMap	myFlipBookAnimationMapWithVelocityControl

DtArticulatedModelParser::AnnotationMap	myAnnotationMap

DtArticulatedModelParser::ScrollableTextureGroupMap	myScrollableTextureGroupMap

DtOsgSceneConnector *	mySceneConnector

NodePathCache	myNodePathCache

bool	myUseSwitch

AnnotationNameToUvsMap	myAnnotationsUvMap

SensorRegionStateMap	mySensorRegionMap

DtIndirectEntityManager &	myIndirectEntityManager

DtUniqueID	mySceneObjectId

DtMetaFileManager::LinkageValueVec	myModelMetaFeatures

LinkageConfigMap	myLinkageConfigMap

std::vector< DtVirtualBaseClass * >	myModelMetaAttachments

PartOrientationMap	myPartOrientationMap

PartTranslationMap	myPartTranslationMap

DtVector	myBoundMin

DtVector	myBoundMax

bool	myModelScalingEnabled

DtVector	mySetPosition

bool	myInitialPositionSet

DtTaitBryan	mySetOrientation

bool	myInitialOrientationSet

bool	myInitialPositionOffsetSet

bool	myInitialOrientationOffsetSet

DtUniqueID	myElementId

DtSignalConnectionManager	myConnections

std::string	myLightPointGroup

bool	myHandlersRegisterered

std::list< std::string >	myMovingDynamicRegions

std::list< std::string >	myPowerPlantDynamicRegions

std::list< std::string >	myWeaponFireDynamicRegions

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
static const unsigned int	theNodePathCacheSize = 4

static boost::mutex	theBackgroundLoadCloneMutex

static const std::unordered_set< int >	theStatesToFilter

static bool	theTrackObjects

static tbb::atomic< int >	theTotalObjects

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

Private Member Functions
	DtOsgArticulatedModel ()=delete

	DtOsgArticulatedModel (const DtOsgArticulatedModel &rhs)=delete

DtOsgArticulatedModel &	operator= (const DtOsgArticulatedModel &rhs)=delete

Member Typedef Documentation

typedef std::vector<osg::Node*> makVrv::DtOsgArticulatedModel::NodeList

typedef std::unordered_map<int, NodeList> makVrv::DtOsgArticulatedModel::NodePathCache

typedef std::map<std::string, std::string> makVrv::DtOsgArticulatedModel::LinkageConfigMap

typedef std::unordered_map<std::string, std::pair<float, float> > makVrv::DtOsgArticulatedModel::AnnotationNameToUvsMap

typedef std::unordered_map<std::string, bool> makVrv::DtOsgArticulatedModel::SensorRegionStateMap

protected

typedef std::map<int, std::pair<DtTaitBryan, DtVector> > makVrv::DtOsgArticulatedModel::PartOrientationMap

protected

typedef std::map<int, std::pair<DtVector, DtVector> > makVrv::DtOsgArticulatedModel::PartTranslationMap

protected

Constructor & Destructor Documentation

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

CTOR.

virtual makVrv::DtOsgArticulatedModel::~DtOsgArticulatedModel ( )

virtual

DTOR.

makVrv::DtOsgArticulatedModel::DtOsgArticulatedModel ( )

privatedelete

not allowed

makVrv::DtOsgArticulatedModel::DtOsgArticulatedModel ( const DtOsgArticulatedModel & rhs )

privatedelete

not allowed

Member Function Documentation

DtOsgArticulatedModel& makVrv::DtOsgArticulatedModel::operator= ( const DtOsgArticulatedModel & rhs )

privatedelete

not allowed

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

virtual

Override the set model definition function. Use this to parse a model after it is loaded. This is the model definition name which links back to the DtModelDefinition. That holds the filename and other state that is needed for this model.

Implements makVrv::DtArticulatedModel.

Reimplemented in makVrf::DtVrfOsgArticulatedModel, and DtVrfOsgArticulatedModel.

virtual const std::string& makVrv::DtOsgArticulatedModel::modelDefinition ( ) const

virtual

get the model definition This is the model definition name which links back to the DtModelDefinition. That holds the filename and other state that is needed for this model.

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

virtual

Get the class name of the model instance owner. This is used to control how model instances are created.

Implements makVrv::DtArticulatedModel.

virtual DtUniqueID makVrv::DtOsgArticulatedModel::uniqueId ( ) const

virtual

return the entity indirect manager

virtual DtUniqueID makVrv::DtOsgArticulatedModel::sceneObjectId ( ) const

virtual

Get the ID for this model's scene object, if any.

Returns 0 if it's not part of a scene object

virtual void makVrv::DtOsgArticulatedModel::setElementId ( DtUniqueID id )

virtual

Set the element ID of the scene object this model is attached to.

Reimplemented from makVrv::DtModel.

Reimplemented in makVrv::DtDeprecatedOsgArticulatedModel.

virtual DtUniqueID makVrv::DtOsgArticulatedModel::elementId ( )

virtual

Get the element ID of the scene object this model is attached to.

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

virtual

Set the model's position for the specified vertex.

Vertex 0 moves the whole model; other vertices are no-ops

Reimplemented from makVrv::DtModel.

Reimplemented in makVrv::DtDeprecatedOsgArticulatedModel.

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

virtual

Set the model's orientation for the specified vertex.

Vertex 0 moves the whole model; other vertices are no-ops

Reimplemented from makVrv::DtModel.

Reimplemented in makVrv::DtDeprecatedOsgArticulatedModel.

virtual void makVrv::DtOsgArticulatedModel::setPositionOffset ( const DtVector & positionOffset )

virtual

Set the position offset of the model. This offsets the position of the entire model.

Reimplemented from makVrv::DtModel.

Reimplemented in makVrv::DtDeprecatedOsgArticulatedModel.

virtual void makVrv::DtOsgArticulatedModel::setOrientationOffset ( const DtTaitBryan & orientationOffset )

virtual

Set the Orientation Offset of the model. This offsets the orientation of the entire model.

Reimplemented from makVrv::DtModel.

Reimplemented in makVrv::DtDeprecatedOsgArticulatedModel.

virtual void makVrv::DtOsgArticulatedModel::setPositionAndOrientation	(	int	vtx,
		const DtVector &	position,
		const DtTaitBryan &	orientation
	)

virtual

Set both the position and orientation at the same time to avoid extra work when they both change at the same time.

Reimplemented from makVrv::DtModel.

Reimplemented in makVrv::DtDeprecatedOsgArticulatedModel.

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

virtual

Set the visible state of the model and scene connector.

Parameters

[in] isVisible is the new visible state; true = visible, false = hidden.

Reimplemented from makVrv::DtModel.

Reimplemented in makVrv::DtDeprecatedOsgArticulatedModel.

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

virtual

Update the part translation.

Implements makVrv::DtArticulatedModel.

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

virtual

Rotate the part.

Implements makVrv::DtArticulatedModel.

virtual void makVrv::DtOsgArticulatedModel::setPartRotationalVelocity	(	int	partNumber,
		const DtVector &	rotationalVelocity,
		bool	forceUpdate = `true`
	)

virtual

Set just the rotational velocity (without having to do orientation) forceUpdate will force an update when instancing is enabled.

Implements makVrv::DtArticulatedModel.

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

overridevirtual

Finds the absolute position and orientation of a part. This function is more efficient than calling both the position and orientation functions.

Implements makVrv::DtArticulatedModel.

virtual DtVector makVrv::DtOsgArticulatedModel::partTranslation ( int partNumber ) const

virtual

Get a part translation.

Return values

0,0,0 when the part number is invalid.

virtual DtTaitBryan makVrv::DtOsgArticulatedModel::partOrientation ( int partNumber ) const

virtual

Get a part orientation.

Return values

0,0,0 when the part number is invalid.

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

virtual

Set an articulated part visible/invisible by part number.

Implements makVrv::DtArticulatedModel.

const DtArticulatedModelParser::PartMap& makVrv::DtOsgArticulatedModel::parts ( ) const

Get a map of the current parts.

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

virtual

Only a list of all the parts.

Implements makVrv::DtArticulatedModel.

virtual void makVrv::DtOsgArticulatedModel::addPart	(	int	partNumber,
		osgSim::DOFTransform *	node
	)

virtual

Add a part off the DOF transform node and a part Number.

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

overridevirtual

Set the current frame of an animation.

Implements makVrv::DtArticulatedModel.

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

overridevirtual

Set the animation range.

Implements makVrv::DtArticulatedModel.

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

overridevirtual

Set the animation speed.

Implements makVrv::DtArticulatedModel.

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

overridevirtual

Set the animation mode.

Implements makVrv::DtArticulatedModel.

Reimplemented in makVrv::DtDeprecatedOsgArticulatedModel.

virtual void makVrv::DtOsgArticulatedModel::setAnimationLastFrameTime	(	const std::string &	animationName,
		double	animationLastFrameTime
	)

virtual

Set the last frame time in the current range in an animation /param animationLastFrameTime should be non-negative value.

virtual void makVrv::DtOsgArticulatedModel::setAnimationLoopCount	(	const std::string &	animationName,
		int	loopCount
	)

virtual

Set the animation loop count in an animation /param loopCount -1:repeat forever 0:no repetitions.

virtual int makVrv::DtOsgArticulatedModel::animationFrameCount ( const std::string & animationName ) const

virtual

Get number of frames in an animation.

Return values

-1	when the animation number is invalid.

virtual int makVrv::DtOsgArticulatedModel::animationCurrentFrame ( const std::string & animationName ) const

virtual

Get the current frame of an animation.

Return values

-1	when the animation number is invalid.

virtual int makVrv::DtOsgArticulatedModel::animationFirstFrame ( const std::string & animationName ) const

virtual

Get the first frame in the current range in an animation.

Return values

-1	when the animation number is invalid.

virtual int makVrv::DtOsgArticulatedModel::animationLastFrame ( const std::string & animationName ) const

virtual

Get the last frame in the current range in an animation.

Return values

-1	when the animation number is invalid.

virtual double makVrv::DtOsgArticulatedModel::animationSpeed ( const std::string & animationName ) const

virtual

Get the speed of an animation.

Return values

-1.0	when the animation number is invalid.

virtual AnimationState makVrv::DtOsgArticulatedModel::animationState ( const std::string & animationName ) const

virtual

Get the animation mode of an animation.

Return values

STOP	when the animation name is invalid

virtual double makVrv::DtOsgArticulatedModel::animationLastFrameTime ( const std::string & animationName ) const

virtual

Get the last frame time in the current range in an animation.

Return values

-1	when the animation number is invalid.

virtual int makVrv::DtOsgArticulatedModel::animationLoopCount ( const std::string & animationName ) const

virtual

Get the animation loop count in an animation.

virtual const DtArticulatedModelParser::AnimationMap& makVrv::DtOsgArticulatedModel::animations ( ) const

virtual

Get a map of the current animations.

virtual void makVrv::DtOsgArticulatedModel::addAnimation	(	const std::string &	animationName,
		osg::Sequence *	node
	)

virtual

Add animation Sequence.

virtual const DtArticulatedModelParser::FlipBookAnimationMap& makVrv::DtOsgArticulatedModel::flipBookAnimations ( ) const

virtual

Get a map of the flip book animations.

virtual const DtArticulatedModelParser::FlipBookAnimationMap& makVrv::DtOsgArticulatedModel::flipBookAnimationsWithVelocityControl ( ) const

virtual

Get a map of the flip book animations which have velocity control (loopduration multiplier found in comment).

virtual void makVrv::DtOsgArticulatedModel::setFlipBookAnimationsSpeed	(	double	leftSpeed,
		double	rightSpeed,
		double	mainSpeed
	)

virtual

adjust speed of flip book animations based on an incoming velocity

virtual const DtArticulatedModelParser::ScrollableTextureGroupMap& makVrv::DtOsgArticulatedModel::scrollableTextureGroupMap ( ) const

virtual

Get a map of the scrollable textures.

virtual void makVrv::DtOsgArticulatedModel::scrollUvTextures	(	double	leftSpeed,
		double	rightSpeed,
		double	mainSpeed
	)

virtual

adjust scroll textures based on an incoming velocity

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

virtual

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

Implements makVrv::DtArticulatedModel.

Reimplemented in makVrv::DtDeprecatedOsgArticulatedModel.

virtual bool makVrv::DtOsgArticulatedModel::modelScalingEnabled ( )

virtual

getter for model scaling enabled flag

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

virtual

Indicates whether local model scaling for the model is enabled. Local model scaling overrides generic (global) model scaling. Default is false.

Implements makVrv::DtArticulatedModel.

Reimplemented in makVrv::DtDeprecatedOsgArticulatedModel.

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

virtual

Sets the amount of local scaling to apply to the model. Only applies when local model scaling is enabled.

Implements makVrv::DtArticulatedModel.

Reimplemented in makVrv::DtDeprecatedOsgArticulatedModel.

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

virtual

Set the blend color for the model.

Reimplemented from makVrv::DtModel.

Reimplemented in makVrv::DtDeprecatedOsgArticulatedModel.

virtual void makVrv::DtOsgArticulatedModel::enableColorBlending ( bool b )

virtual

enable color blending for the model

Reimplemented from makVrv::DtModel.

Reimplemented in makVrv::DtDeprecatedOsgArticulatedModel.

virtual void makVrv::DtOsgArticulatedModel::setBlendColor	(	float	r,
		float	g,
		float	b,
		float	a
	)

virtual

Set the blend color for the model.

Reimplemented from makVrv::DtModel.

Reimplemented in makVrv::DtDeprecatedOsgArticulatedModel.

virtual void makVrv::DtOsgArticulatedModel::setOtherData0	(	float	r,
		float	g,
		float	b,
		float	a
	)

virtual

Set the instance otherData0 for the model.

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

virtual

Specifies a linkage/config pair where the linkageName is the name of a node or an annotation on a node that identifies it and configName is a string looked up in the Mappings section of the FeatureData for the linkage in the metafile associated with the model. The resultant string from the configName is used to apply textures to the node.

Implements makVrv::DtArticulatedModel.

virtual LinkageConfigMap& makVrv::DtOsgArticulatedModel::linkageConfigMap ( )

virtual

Get the mapping of linkage names (NodeName/Annotation) to configName pairs.

virtual const LinkageConfigMap& makVrv::DtOsgArticulatedModel::linkageConfigMap ( ) const

virtual

Get the mapping of linkage names (NodeName/Annotation) to configName pairs.

virtual void makVrv::DtOsgArticulatedModel::weaponFired ( const DtUnicode & munitionModelDefName )

overridevirtual

let the model know when a weapon was fired and what the model definition for the munition is

Implements makVrv::DtArticulatedModel.

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

overridevirtual

Set the state of a dynamic sensor region.

Implements makVrv::DtArticulatedModel.

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

virtual

Get the state of a dynamic sensor region.

Implements makVrv::DtArticulatedModel.

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

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.

Implements makVrv::DtArticulatedModel.

virtual const AnnotationNameToUvsMap& makVrv::DtOsgArticulatedModel::annotationsMap ( void ) const

virtual

access the annotations' map

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

virtual

Set the state on the model.

Implements makVrv::DtArticulatedModel.

Reimplemented in DtVrfOsgMultipleArticulatedModel.

virtual void makVrv::DtOsgArticulatedModel::setStateUnfiltered	(	int	stateNumber,
		int	stateValue
	)

virtual

set state via a manager that filtered out a state (in setState)

virtual void makVrv::DtOsgArticulatedModel::reapplyState ( )

virtual

Set the state on the model.

virtual int makVrv::DtOsgArticulatedModel::state ( int stateNumber ) const

virtual

Get a state of the model Returns -1 if no such state exists.

Reimplemented in DtVrfOsgMultipleArticulatedModel, DtVrfDeprecatedOsgArticulatedModel, and DtVrfOsgArticulatedModel.

const DtArticulatedModelParser::MapStateNumberToMultiSwitchList& makVrv::DtOsgArticulatedModel::states ( ) const

Get a map of the current states.

virtual void makVrv::DtOsgArticulatedModel::addState	(	int	stateNumber,
		osgSim::MultiSwitch *	node
	)

virtual

Add a switch off the DOF switch node and a part number.

virtual void makVrv::DtOsgArticulatedModel::setStateValueExists	(	int	stateNumber,
		int	stateValue
	)

virtual

Set when a state value exists; only state values that have had this method called on them will be used.

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

virtual

Specify the maximum range at which lightpoints on this model will be visible. This sets ALL lightpoints to the same range.

Implements makVrv::DtArticulatedModel.

Reimplemented in makVrv::DtDeprecatedOsgArticulatedModel.

virtual void makVrv::DtOsgArticulatedModel::setLightPointGroup ( const std::string & groupName )

virtual

Set the light point group that this model's light points belong to.

virtual const std::string& makVrv::DtOsgArticulatedModel::lightPointGroup ( ) const

virtual

Get the light point group that this model's light points belong to.

virtual void makVrv::DtOsgArticulatedModel::setDepthMask ( osg::Group & parent )

virtual

Sets child nodes as a depth mask, which writes to the depth buffer and does not get sorted as transparent. (Useful for things like masking water out of the inside of ship hulls by placing a transparent polygon above it as a depth mask.)

virtual void makVrv::DtOsgArticulatedModel::addAnnotationGroup	(	const std::string &	annotation,
		osg::Group *	group
	)

virtual

Add a mapping from an annotation to a group node.

virtual void makVrv::DtOsgArticulatedModel::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::DtModel.

Reimplemented in makVrv::DtDeprecatedOsgArticulatedModel.

virtual void makVrv::DtOsgArticulatedModel::getBoundingBoxComponents	(	DtVector &	minimum,
		DtVector &	maximum
	)

virtual

Get the minimum and maximum X,Y,Z components of the bounding box.

Reimplemented from makVrv::DtModel.

Reimplemented in makVrv::DtDeprecatedOsgArticulatedModel.

virtual bool makVrv::DtOsgArticulatedModel::applyMetafile ( const DtModelDefinition * definition )

virtual

For a given model definition, get the .medf file name, load the corresponding .meta file and created nodes in the DtOsgModelInstance.

Reimplemented in makVrv::DtDeprecatedOsgArticulatedModel.

virtual void makVrv::DtOsgArticulatedModel::slot_onShadowStateChanged ( bool on )

virtual

Turn on or off the shadow polygon on objects (ex. vehicles)

virtual void makVrv::DtOsgArticulatedModel::slot_atcModeEnableChanged ( bool state )

virtual

slot for handling when alpha to coverage on all models is changed

Reimplemented in makVrv::DtDeprecatedOsgArticulatedModel.

virtual void makVrv::DtOsgArticulatedModel::setSingleChildOn	(	osgSim::MultiSwitch *	multiSwitch,
		unsigned int	switchIndex,
		int	nodeTypeIndex
	)

virtual

set a single switch on a multi switch node

Reimplemented in makVrv::DtDeprecatedOsgArticulatedModel.

virtual void makVrv::DtOsgArticulatedModel::setDofHpr	(	osgSim::DOFTransform *	dof,
		const DtVector &	hpr,
		int	animationFlags
	)

virtual

set hpr directly on a dof node

Reimplemented in makVrv::DtDeprecatedOsgArticulatedModel.

virtual void makVrv::DtOsgArticulatedModel::setDofHprVel	(	osgSim::DOFTransform *	dof,
		const DtVector &	hprVel,
		int	animationFlags
	)

virtual

set hpr vel directly on a dof node

Reimplemented in makVrv::DtDeprecatedOsgArticulatedModel.

static void makVrv::DtOsgArticulatedModel::setTrackObjects ( bool val )

static

debug log level output is provided when objects construct/deleted

static bool makVrv::DtOsgArticulatedModel::trackObjects ( void )

static

debug log level output is provided when objects construct/deleted

virtual void makVrv::DtOsgArticulatedModel::setStateInternal	(	int	stateNumber,
		int	stateValue
	)

protectedvirtual

actually sets the state, it does not cache the state, call setUvOffset to cache the state

Reimplemented in makVrv::DtDeprecatedOsgArticulatedModel.

virtual void makVrv::DtOsgArticulatedModel::setUvOffsetInternal	(	const std::string &	annotation,
		float	uOffset,
		float	vOffset
	)

protectedvirtual

actually sets the uv offset, it does not cache the state, call setUvOffset to cache the state

Reimplemented in makVrv::DtDeprecatedOsgArticulatedModel.

virtual void makVrv::DtOsgArticulatedModel::setPartTranslationInternal	(	int	partNumber,
		const DtVector &	transform,
		const DtVector &	velocity
	)

protectedvirtual

Actually update the part translation. Does not cache the state call setPartTranslation to cache the state.

Reimplemented in makVrv::DtDeprecatedOsgArticulatedModel.

virtual void makVrv::DtOsgArticulatedModel::setPartOrientationInternal	(	int	partNumber,
		const DtTaitBryan &	orientation,
		const DtVector &	rotationalVelocity
	)

protectedvirtual

Actually rotate the part. Does not cache the state call setPartOrientation to cache the state.

Reimplemented in makVrv::DtDeprecatedOsgArticulatedModel.

virtual void makVrv::DtOsgArticulatedModel::setPartRotationalVelocityInternal	(	int	partNumber,
		const DtVector &	rotationalVelocity,
		bool	forceUpdate = `true`
	)

protectedvirtual

Actually update the rotational velocity of the part. Does not cache the state call setPartRotationVelocity to cache the state forceUpdate will force an update when instancing is enabled.

Reimplemented in makVrv::DtDeprecatedOsgArticulatedModel.

virtual void makVrv::DtOsgArticulatedModel::disablePart ( int partNumber )

protectedvirtual

disable a part

Reimplemented in makVrv::DtDeprecatedOsgArticulatedModel.

virtual void makVrv::DtOsgArticulatedModel::enablePart ( int partNumber )

protectedvirtual

enable a part

Reimplemented in makVrv::DtDeprecatedOsgArticulatedModel.

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

protectedvirtual

add to the scene

Implements makVrv::DtModel.

Reimplemented in makVrv::DtDeprecatedOsgArticulatedModel.

virtual void makVrv::DtOsgArticulatedModel::removeFromScene ( )

protectedvirtual

remove from the scene

Implements makVrv::DtModel.

Reimplemented in makVrv::DtDeprecatedOsgArticulatedModel, DtVrfDeprecatedOsgArticulatedModel, and DtVrfOsgArticulatedModel.

virtual void makVrv::DtOsgArticulatedModel::modelInstanceToBeDeleted ( )

protectedvirtual

internal to handle model instance deletion

virtual void makVrv::DtOsgArticulatedModel::modelInstanceCreatedInternal	(	osg::Node *	root,
		DtOsgModelInstance *	osgModelInstance,
		bool	daylightControlledLights,
		float	scale
	)

protectedvirtual

internal function to handle model instance creation

Reimplemented in makVrv::DtDeprecatedOsgArticulatedModel.

virtual void makVrv::DtOsgArticulatedModel::modelInstanceCreated	(	bool	castShadows,
		bool	daylightControlledLights,
		float	scale
	)

protectedvirtual

internal to handle instance creation sets up dynamic sensor region, cast shadows and further calls modelInstanceCreatedInternal daylightControlled is only used if the light points do not already have a type specified

virtual void makVrv::DtOsgArticulatedModel::mergeCurrentStateWithDefaults ( DtArticulatedModelParser * parser )

protectedvirtual

applies all the state merging code

virtual void makVrv::DtOsgArticulatedModel::parseModel ( osg::Node * root )

protectedvirtual

parses the model

Reimplemented in DtVrfDeprecatedOsgArticulatedModel, and DtVrfOsgArticulatedModel.

virtual void makVrv::DtOsgArticulatedModel::backgroundLoad ( )

protectedvirtual

multi-threaded loading functions (worker thread) further calls backgroundLoadInternal

Reimplemented from makVrv::DtModel.

virtual void makVrv::DtOsgArticulatedModel::discoverDynamicRegions ( const DtModelDefinition * definition )

protectedvirtual

virtual void makVrv::DtOsgArticulatedModel::foregroundLoad ( )

protectedvirtual

internal, further calls foregroundLoadInternal

Reimplemented from makVrv::DtModel.

virtual void makVrv::DtOsgArticulatedModel::backgroundLoadInternal ( DtModelDefinition * definition )

protectedvirtual

internal, called from backgroundLoad

Reimplemented in makVrv::DtDeprecatedOsgArticulatedModel.

virtual void makVrv::DtOsgArticulatedModel::backgroundLoadFirstLoadInternal ( DtModelDefinition * definition )

protectedvirtual

internal, called from backgroundLoad on first load of a definition

Reimplemented in makVrv::DtDeprecatedOsgArticulatedModel.

virtual void makVrv::DtOsgArticulatedModel::foregroundLoadInternal ( )

protectedvirtual

//! internal, called from foregroundLoad

Reimplemented in makVrv::DtDeprecatedOsgArticulatedModel.

virtual void makVrv::DtOsgArticulatedModel::modelInstanceToBeDeletedInternal ( void )

protectedvirtual

brief internal

Reimplemented in makVrv::DtDeprecatedOsgArticulatedModel.

Member Data Documentation

boost::signalslib::signal<void(DtOsgArticulatedModel*, int, int)> makVrv::DtOsgArticulatedModel::signal_SetState

signal to emit when a state is set

DtArticulatedModelParser::MapStateNumberToStateExistenceList makVrv::DtOsgArticulatedModel::myMapStateNumberToStateExistenceList

protected

DtArticulatedModelParser::MapStateNumberToStateValue makVrv::DtOsgArticulatedModel::myMapStateNumberToStateValue

protected

DtArticulatedModelParser::PartMap makVrv::DtOsgArticulatedModel::myPartMap

protected

DtArticulatedModelParser::MapStateNumberToMultiSwitchList makVrv::DtOsgArticulatedModel::myMapStateNumberToMultiSwitchList

protected

DtArticulatedModelParser::AnimationMap makVrv::DtOsgArticulatedModel::myAnimationMap

protected

DtArticulatedModelParser::FlipBookAnimationMap makVrv::DtOsgArticulatedModel::myFlipBookAnimationMap

protected

DtArticulatedModelParser::FlipBookAnimationMap makVrv::DtOsgArticulatedModel::myFlipBookAnimationMapWithVelocityControl

protected

DtArticulatedModelParser::AnnotationMap makVrv::DtOsgArticulatedModel::myAnnotationMap

protected

DtArticulatedModelParser::ScrollableTextureGroupMap makVrv::DtOsgArticulatedModel::myScrollableTextureGroupMap

protected

DtOsgSceneConnector* makVrv::DtOsgArticulatedModel::mySceneConnector

protected

NodePathCache makVrv::DtOsgArticulatedModel::myNodePathCache

protected

const unsigned int makVrv::DtOsgArticulatedModel::theNodePathCacheSize = 4

staticprotected

bool makVrv::DtOsgArticulatedModel::myUseSwitch

protected

AnnotationNameToUvsMap makVrv::DtOsgArticulatedModel::myAnnotationsUvMap

protected

SensorRegionStateMap makVrv::DtOsgArticulatedModel::mySensorRegionMap

protected

DtIndirectEntityManager& makVrv::DtOsgArticulatedModel::myIndirectEntityManager

protected

DtUniqueID makVrv::DtOsgArticulatedModel::mySceneObjectId

protected

DtMetaFileManager::LinkageValueVec makVrv::DtOsgArticulatedModel::myModelMetaFeatures

protected

List of node pointers that have meta data associated with them.

LinkageConfigMap makVrv::DtOsgArticulatedModel::myLinkageConfigMap

protected

Map of linkage names (NodeName/Annotation) from the metafile(if it exists) to config names. Used by applyMetafile function.

std::vector<DtVirtualBaseClass*> makVrv::DtOsgArticulatedModel::myModelMetaAttachments

protected

Vector of metafile attachment on this object so they can be deleted on object destruction.

PartOrientationMap makVrv::DtOsgArticulatedModel::myPartOrientationMap

protected

PartTranslationMap makVrv::DtOsgArticulatedModel::myPartTranslationMap

protected

DtVector makVrv::DtOsgArticulatedModel::myBoundMin

protected

DtVector makVrv::DtOsgArticulatedModel::myBoundMax

protected

bool makVrv::DtOsgArticulatedModel::myModelScalingEnabled

protected

DtVector makVrv::DtOsgArticulatedModel::mySetPosition

protected

bool makVrv::DtOsgArticulatedModel::myInitialPositionSet

protected

DtTaitBryan makVrv::DtOsgArticulatedModel::mySetOrientation

protected

bool makVrv::DtOsgArticulatedModel::myInitialOrientationSet

protected

bool makVrv::DtOsgArticulatedModel::myInitialPositionOffsetSet

protected

bool makVrv::DtOsgArticulatedModel::myInitialOrientationOffsetSet

protected

DtUniqueID makVrv::DtOsgArticulatedModel::myElementId

protected

DtSignalConnectionManager makVrv::DtOsgArticulatedModel::myConnections

protected

std::string makVrv::DtOsgArticulatedModel::myLightPointGroup

protected

bool makVrv::DtOsgArticulatedModel::myHandlersRegisterered

protected

std::list<std::string> makVrv::DtOsgArticulatedModel::myMovingDynamicRegions

protected

std::list<std::string> makVrv::DtOsgArticulatedModel::myPowerPlantDynamicRegions

protected

std::list<std::string> makVrv::DtOsgArticulatedModel::myWeaponFireDynamicRegions

protected

boost::mutex makVrv::DtOsgArticulatedModel::theBackgroundLoadCloneMutex

staticprotected

const std::unordered_set<int> makVrv::DtOsgArticulatedModel::theStatesToFilter

staticprotected

which states are we filtering to take additional/optional actions on?

bool makVrv::DtOsgArticulatedModel::theTrackObjects

staticprotected

tbb::atomic<int> makVrv::DtOsgArticulatedModel::theTotalObjects

staticprotected

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

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-0-branch/include/vrvOsg/DtOsgArticulatedModel.h

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Types

Protected Member Functions

Protected Attributes

Static Protected Attributes

Private Member Functions

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation