DtScriptAnimationModel Class Reference

Inheritance diagram for DtScriptAnimationModel:

Public Member Functions
	DtScriptAnimationModel (DtScriptOwnshipObject *vrfObject)
	DtScriptAnimationModel (const DtScriptAnimationModel &orig)
DtScriptAnimationModel &	operator= (const DtScriptAnimationModel &orig)
virtual	~DtScriptAnimationModel () override
bool	operator== (const DtScriptAnimationModel &orig)
virtual const DtAnimationModel &	animationModel () const
virtual DtString	serialize () override
virtual bool	deserialize (const DtString &data) override
virtual DtString	objectType () const override
virtual void	reset ()
virtual void	setAnimationModelFile (const std::string &)
virtual const std::string &	animationModelFile () const
virtual void	setTimeScale (double)
virtual double	timeScale () const
virtual void	setFrameTime (double)
virtual double	frameTime () const
virtual int	numAnimationFrames () const
virtual void	setClampType (int)
virtual int	clampType () const
virtual void	setCompletionRule (int)
virtual int	completionRule () const
virtual void	setSpeedNegated (bool negateSpeeds)
virtual bool	isSpeedNegated () const
virtual void	init (void *userData) override
virtual void	setEntity (DtLocalObject *)
virtual void	setTimeDeltaFromPreviousRow (int forRow, double timeDelta)
virtual void	setTransitionSpeed (double)
virtual double	transitionSpeed () const
virtual void	setAnimationFrame (int)
virtual int	animationFrame () const
std::shared_ptr < DtScriptOwnshipObject >	ownshipObject () const
virtual double	elapsedAnimationTime () const
virtual bool	isFinished () const
virtual int	addAnimationRow (double deltaTime, double lateral, double range, double altitude, double headingOffset=0, double pitchOffset=0, double rollOffset=0)
virtual double	speed (int) const
virtual DtLocation3D	location (int) const
virtual void	orientation (int frame, double &heading, double &pitch, double &roll) const
virtual DtVector3D	rotationalVelocity (int) const
virtual DtVector3D	acceleration (int) const
virtual DtVector3D	velocity (int) const
Public Member Functions inherited from DtAsciiSerializable
	DtAsciiSerializable ()
	DtAsciiSerializable (const DtAsciiSerializable &orig)
virtual	~DtAsciiSerializable ()
virtual std::string	objectTypeC () const

Static Public Member Functions
static DtAsciiSerializable *	creator ()

Protected Attributes
const DtSimulationServices *	mySimulationServices
std::shared_ptr < DtScriptOwnshipObject >	mySharedObject
DtAnimationModel	myAnimationModel
std::string	myAnimationModelFile

Constructor & Destructor Documentation

DtScriptAnimationModel::DtScriptAnimationModel

(

DtScriptOwnshipObject *

vrfObject

)

DtScriptAnimationModel::DtScriptAnimationModel

(

const DtScriptAnimationModel &

orig

)

virtual DtScriptAnimationModel::~DtScriptAnimationModel ( )

overridevirtual

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

Script API functions. ////////////////////////////////////!

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

virtual void DtScriptAnimationModel::setTimeScale ( double  )

virtual

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

virtual double DtScriptAnimationModel::timeScale ( ) const

virtual

Script API functions. ////////////////////////////////////!

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

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

Script API functions. ////////////////////////////////////!

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

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

Script API functions. ////////////////////////////////////!

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

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

Script API functions. ////////////////////////////////////!

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

virtual void DtScriptAnimationModel::setSpeedNegated ( bool  negateSpeeds )

virtual

Sets whether the speed calculated from the velocity should be considered negative.

Indicates whether the speed values computed from the animation should be negated before use. Speeds computed in ::simulate() are always positive, but for certain types of movement (eg. climbing down a ladder), the speed value should be negated so it can be handled correctly. This flag allows scripts to indicate to the sim that this negation should take place.

virtual bool DtScriptAnimationModel::isSpeedNegated ( ) const

virtual

Script API functions. ////////////////////////////////////!

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

virtual void DtScriptAnimationModel::init ( void *  userData )

overridevirtual

Save as sim manager.

Reimplemented from DtAsciiSerializable.

virtual void DtScriptAnimationModel::setEntity ( DtLocalObject *  )

virtual

Called during deserialization, sets the entity that owns this object.

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.

std::shared_ptr<DtScriptOwnshipObject> DtScriptAnimationModel::ownshipObject ( ) const

inline

Script API functions. ////////////////////////////////////!

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

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

overridevirtual

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

Implements DtAsciiSerializable.

virtual bool DtScriptAnimationModel::deserialize ( const DtString &  data )

overridevirtual

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

overridevirtual

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.

virtual void DtScriptAnimationModel::reset ( )

virtual

Resets state of the animation model.

Member Data Documentation

const DtSimulationServices* DtScriptAnimationModel::mySimulationServices

protected

std::shared_ptr<DtScriptOwnshipObject> 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.vrf5-2-branch/include/vrfobjcore/scriptAnimationModel.h