Inheritance diagram for DtScriptAnimationModel:

Public Member Functions
	DtScriptAnimationModel (const DtScriptVrfObject *vrfObject)

	DtScriptAnimationModel (const DtScriptAnimationModel &orig)

DtScriptAnimationModel &	operator= (const DtScriptAnimationModel &orig)

	~DtScriptAnimationModel ()

bool	operator== (const DtScriptAnimationModel &orig)

virtual const DtAnimationModel &	animationModel () const
	Script API functions above. More...

virtual DtString	serialize ()
	Inherited from DtAsciiSerializable. Returns a string serialized version of this class. More...

bool	deserialize (const DtString &data)
	Inherited from DtAsciiSerializable. More...

virtual DtString	objectType () const
	Should return the string name of this object. More...

const DtVrfObject *	vrfObject () const
	Returns the vrf object referenced by mySharedObject. More...

virtual void	reset ()
	Resets state of the animation model. More...


virtual void	setAnimationModelFile (const std::string &)
	Script API functions. More...

virtual const std::string &	animationModelFile () const

virtual void	setTimeScale (double)
	Sets the time scale of the animation model. Default is 1. More...

virtual double	timeScale () const

virtual void	setFrameTime (double)
	Sets the time for each frame to be the specified time, regardless of what the file says. More...

virtual double	frameTime () const

virtual int	numAnimationFrames () const
	Returns the number of animation frames. More...

virtual void	setClampType (int)
	Sets how to clamp the entity. See scriptedMovementObject.h. More...

virtual int	clampType () const

virtual void	setCompletionRule (int)
	Sets what to do with the entity after movement is complete. See scriptedMovementObject.h. More...

virtual int	completionRule () const

virtual void	init (void *userData)
	Save as sim manager. More...

virtual void	setTimeDeltaFromPreviousRow (int forRow, double timeDelta)
	Sets the time delta for the current row from the previous row. Does not effect any other row. More...

virtual void	setTransitionSpeed (double)
	Sets the speed to use to transition into this animation. More...

virtual double	transitionSpeed () const
	Returns current transitionspeed. More...

virtual void	setAnimationFrame (int)
	Sets the frame to animate from. More...

virtual int	animationFrame () const
	The animation frame currently on. More...

virtual double	elapsedAnimationTime () const
	Returns the amount of animation time elapsed. More...

virtual bool	isFinished () const
	Returns true if the animation is finished. More...

virtual int	addAnimationRow (double deltaTime, double lateral, double range, double altitude, double headingOffset=0, double pitchOffset=0, double rollOffset=0)
	Adds a new data row into the system. More...

virtual double	speed (int) const
	Returns the current speed (meters/second) at the given frame. More...

virtual DtLocation3D	location (int) const
	Returns the location at the given frame. More...

virtual void	orientation (int frame, double &heading, double &pitch, double &roll) const
	Returns topographic heading, pitch and roll. More...

virtual DtVector3D	rotationalVelocity (int) const
	Returns rotational velocity at given frame. More...

virtual DtVector3D	acceleration (int) const
	Returns acceleration (local) at given frame. More...

virtual DtVector3D	velocity (int) const
	Returns velocity (local) at given frame. More...

Public Member Functions inherited from DtAsciiSerializable
	DtAsciiSerializable ()
	The implementer of this interface should be sure to create a creator function to create an empty object that returns a pointer to this interface. More...

	DtAsciiSerializable (const DtAsciiSerializable &orig)

virtual	~DtAsciiSerializable ()

virtual std::string	objectTypeC () const
	Returns a std::string version of the objectType. More...

Static Public Member Functions
static DtAsciiSerializable *	creator ()
	Inherited from DtAsciiSerializable. Returns a new object of this type with default values. More...

Protected Attributes
DtSimManager *	mySimManager

boost::shared_ptr < DtScriptVrfObject >	mySharedObject

DtAnimationModel	myAnimationModel

std::string	myAnimationModelFile

Constructor & Destructor Documentation

DtScriptAnimationModel::DtScriptAnimationModel ( const DtScriptVrfObject * vrfObject )

DtScriptAnimationModel::DtScriptAnimationModel ( const DtScriptAnimationModel & orig )

DtScriptAnimationModel::~DtScriptAnimationModel ( )

Member Function Documentation

DtScriptAnimationModel& DtScriptAnimationModel::operator= ( const DtScriptAnimationModel & orig )

bool DtScriptAnimationModel::operator== ( const DtScriptAnimationModel & orig )

virtual void DtScriptAnimationModel::setAnimationModelFile ( const std::string & )

virtual

Script API functions.

////////////////////////////////////! Sets the animated movement object to use as the model. Needs to be already loaded into the simulation

virtual const std::string& DtScriptAnimationModel::animationModelFile ( ) const

virtual

virtual void DtScriptAnimationModel::setTimeScale ( double )

virtual

Sets the time scale of the animation model. Default is 1.

virtual double DtScriptAnimationModel::timeScale ( ) const

virtual

virtual void DtScriptAnimationModel::setFrameTime ( double )

virtual

Sets the time for each frame to be the specified time, regardless of what the file says.

To reset back to original time scale set to 0

virtual double DtScriptAnimationModel::frameTime ( ) const

virtual

virtual int DtScriptAnimationModel::numAnimationFrames ( ) const

virtual

Returns the number of animation frames.

virtual void DtScriptAnimationModel::setClampType ( int )

virtual

Sets how to clamp the entity. See scriptedMovementObject.h.

virtual int DtScriptAnimationModel::clampType ( ) const

virtual

virtual void DtScriptAnimationModel::setCompletionRule ( int )

virtual

Sets what to do with the entity after movement is complete. See scriptedMovementObject.h.

virtual int DtScriptAnimationModel::completionRule ( ) const

virtual

virtual void DtScriptAnimationModel::init ( void * userData )

virtual

Save as sim manager.

Reimplemented from DtAsciiSerializable.

virtual void DtScriptAnimationModel::setTimeDeltaFromPreviousRow	(	int	forRow,
		double	timeDelta
	)

virtual

Sets the time delta for the current row from the previous row. Does not effect any other row.

virtual void DtScriptAnimationModel::setTransitionSpeed ( double )

virtual

Sets the speed to use to transition into this animation.

Will skip over frames until the desired speed is met, speeding up the animation to get to that point. Speed is in meters/second and is only used if the calculation animation frame is 0

virtual double DtScriptAnimationModel::transitionSpeed ( ) const

virtual

Returns current transitionspeed.

virtual void DtScriptAnimationModel::setAnimationFrame ( int )

virtual

Sets the frame to animate from.

virtual int DtScriptAnimationModel::animationFrame ( ) const

virtual

The animation frame currently on.

virtual double DtScriptAnimationModel::elapsedAnimationTime ( ) const

virtual

Returns the amount of animation time elapsed.

virtual bool DtScriptAnimationModel::isFinished ( ) const

virtual

Returns true if the animation is finished.

virtual int DtScriptAnimationModel::addAnimationRow	(	double	deltaTime,
		double	lateral,
		double	range,
		double	altitude,
		double	headingOffset = `0`,
		double	pitchOffset = `0`,
		double	rollOffset = `0`
	)

virtual

Adds a new data row into the system.

The offsets are lateral distance, range and altitude distance from the entities starting position. The orientation is heading, pitch, roll from the starting orientation. If no time is given the current frame time is used or the last two frames (if they exist) difference will be used as the delta for the new frame. The row number of the newly added row is returned

virtual double DtScriptAnimationModel::speed ( int ) const

virtual

Returns the current speed (meters/second) at the given frame.

virtual DtLocation3D DtScriptAnimationModel::location ( int ) const

virtual

Returns the location at the given frame.

virtual void DtScriptAnimationModel::orientation	(	int	frame,
		double &	heading,
		double &	pitch,
		double &	roll
	)		const

virtual

Returns topographic heading, pitch and roll.

virtual DtVector3D DtScriptAnimationModel::rotationalVelocity ( int ) const

virtual

Returns rotational velocity at given frame.

virtual DtVector3D DtScriptAnimationModel::acceleration ( int ) const

virtual

Returns acceleration (local) at given frame.

virtual DtVector3D DtScriptAnimationModel::velocity ( int ) const

virtual

Returns velocity (local) at given frame.

virtual const DtAnimationModel& DtScriptAnimationModel::animationModel ( ) const

virtual

Script API functions above.

////////////////////////////////////! Returns the animation model for this class

virtual DtString DtScriptAnimationModel::serialize ( )

virtual

Inherited from DtAsciiSerializable. Returns a string serialized version of this class.

Implements DtAsciiSerializable.

bool DtScriptAnimationModel::deserialize ( const DtString & data )

virtual

Inherited from DtAsciiSerializable.

Returns true if it could fill its members with the data contained in the string. False otherwise.

Implements DtAsciiSerializable.

virtual DtString DtScriptAnimationModel::objectType ( ) const

virtual

Should return the string name of this object.

The object name should not be part of the serialization unless you want it to be, but you should take it into account when implementing both functions.

Implements DtAsciiSerializable.

static DtAsciiSerializable* DtScriptAnimationModel::creator ( )

static

Inherited from DtAsciiSerializable. Returns a new object of this type with default values.

const DtVrfObject* DtScriptAnimationModel::vrfObject ( ) const

Returns the vrf object referenced by mySharedObject.

virtual void DtScriptAnimationModel::reset ( )

virtual

Resets state of the animation model.

Member Data Documentation

DtSimManager* DtScriptAnimationModel::mySimManager

protected

boost::shared_ptr<DtScriptVrfObject> DtScriptAnimationModel::mySharedObject

protected

DtAnimationModel DtScriptAnimationModel::myAnimationModel

protected

std::string DtScriptAnimationModel::myAnimationModelFile

protected

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

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf4-10-branch/include/vrfobjcore/scriptAnimationModel.h

Public Member Functions

Static Public Member Functions

Protected Attributes

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation