plAnimTimeConvert Class Reference

#include <plAnimTimeConvert.h>

Inheritance diagram for plAnimTimeConvert:

Public Types
enum	plAnimTimeFlags {   kNone = 0, kStopped = 0x1, kLoop = 0x2, kBackwards = 0x4,   kWrap = 0x8, kNeedsReset = 0x10, kEasingIn = 0x20, kForcedMove = 0x40,   kNoCallbacks = 0x80, kFlagsMask = 0xFF }

Public Member Functions
	plAnimTimeConvert ()
virtual	~plAnimTimeConvert ()
virtual void	read (hsStream *S, plResManager *mgr)
virtual void	write (hsStream *S, plResManager *mgr)
unsigned int	getFlags () const
float	getBegin () const
float	getEnd () const
float	getLoopBegin () const
float	getLoopEnd () const
float	getSpeed () const
float	getCurrentAnimTime () const
double	getLastEvalWorldTime () const
plATCEaseCurve *	getEaseInCurve () const
plATCEaseCurve *	getEaseOutCurve () const
plATCEaseCurve *	getSpeedEaseCurve () const
const std::vector< float > &	getStopPoints () const
void	setFlags (unsigned int flags)
void	setRange (float begin, float end)
void	setLoop (float begin, float end)
void	setSpeed (float speed)
void	setCurrentAnimTime (float time)
void	setLastEvalWorldTime (double time)
void	setEaseInCurve (plATCEaseCurve *curve)
void	setEaseOutCurve (plATCEaseCurve *curve)
void	setSpeedEaseCurve (plATCEaseCurve *curve)
void	setStopPoints (const std::vector< float > &stops)
const std::vector < plEventCallbackMsg * > &	getCallbacks () const
std::vector < plEventCallbackMsg * > &	getCallbacks ()
void	addCallback (plEventCallbackMsg *callback)
void	delCallback (size_t idx)
void	clearCallbacks ()
Public Member Functions inherited from plCreatable
	plCreatable ()
virtual	~plCreatable ()
virtual short	ClassIndex () const =0
short	ClassIndex (PlasmaVer ver) const
virtual const char *	ClassName () const
virtual bool	ClassInstance (short) const
virtual bool	isStub () const
virtual void	prcWrite (pfPrcHelper *prc)
virtual void	prcParse (const pfPrcTag *tag, plResManager *mgr)

Protected Member Functions
virtual void	IPrcWrite (pfPrcHelper *prc)
virtual void	IPrcParse (const pfPrcTag *tag, plResManager *mgr)

Protected Attributes
unsigned int	fFlags
float	fBegin
float	fEnd
float	fLoopBegin
float	fLoopEnd
float	fSpeed
float	fCurrentAnimTime
double	fLastEvalWorldTime
std::vector< float >	fStopPoints
std::vector< plEventCallbackMsg * >	fCallbackMsgs
plATCEaseCurve *	fEaseInCurve
plATCEaseCurve *	fEaseOutCurve
plATCEaseCurve *	fSpeedEaseCurve

Member Enumeration Documentation

enum plAnimTimeConvert::plAnimTimeFlags

Enumerator:

kNone
kStopped
kLoop
kBackwards
kWrap
kNeedsReset
kEasingIn
kForcedMove
kNoCallbacks
kFlagsMask

Constructor & Destructor Documentation

plAnimTimeConvert::plAnimTimeConvert

(

)

virtual plAnimTimeConvert::~plAnimTimeConvert ( )

virtual

Member Function Documentation

void plAnimTimeConvert::addCallback

(

plEventCallbackMsg *

callback

)

void plAnimTimeConvert::clearCallbacks

(

)

void plAnimTimeConvert::delCallback

(

size_t

idx

)

float plAnimTimeConvert::getBegin

(

)

const

const std::vector<plEventCallbackMsg*>& plAnimTimeConvert::getCallbacks

(

)

const

std::vector<plEventCallbackMsg*>& plAnimTimeConvert::getCallbacks

(

)

float plAnimTimeConvert::getCurrentAnimTime

(

)

const

plATCEaseCurve* plAnimTimeConvert::getEaseInCurve

(

)

const

plATCEaseCurve* plAnimTimeConvert::getEaseOutCurve

(

)

const

float plAnimTimeConvert::getEnd

(

)

const

unsigned int plAnimTimeConvert::getFlags

(

)

const

double plAnimTimeConvert::getLastEvalWorldTime

(

)

const

float plAnimTimeConvert::getLoopBegin

(

)

const

float plAnimTimeConvert::getLoopEnd

(

)

const

float plAnimTimeConvert::getSpeed

(

)

const

plATCEaseCurve* plAnimTimeConvert::getSpeedEaseCurve

(

)

const

const std::vector<float>& plAnimTimeConvert::getStopPoints

(

)

const

virtual void plAnimTimeConvert::IPrcParse ( const pfPrcTag *  tag, plResManager *  mgr  )

protectedvirtual

This must be overloaded by subclasses to parse PRC data specific to the class from the PRC document. It is called once for each tag that is a child to the Creatable tag itself, so subclasses should check for each supported tag and handle it accordingly if it matches. If the tag is not recognized, it should be passed along to the parent class.

Reimplemented from plCreatable.

virtual void plAnimTimeConvert::IPrcWrite ( pfPrcHelper *  prc )

protectedvirtual

This must be overloaded by subclasses to write PRC data specific to the class to the PRC document. Do not write the top-level creatable tag, that is handled by prcWrite().

Implements plCreatable.

virtual void plAnimTimeConvert::read ( hsStream *  , plResManager *    )

virtual

Reads this creatable directly from the stream. If any keys are read, they will be added to the plResManager automatically.

Reimplemented from plCreatable.

void plAnimTimeConvert::setCurrentAnimTime

(

float

time

)

void plAnimTimeConvert::setEaseInCurve

(

plATCEaseCurve *

curve

)

void plAnimTimeConvert::setEaseOutCurve

(

plATCEaseCurve *

curve

)

void plAnimTimeConvert::setFlags

(

unsigned int

flags

)

void plAnimTimeConvert::setLastEvalWorldTime

(

double

time

)

void plAnimTimeConvert::setLoop	(	float	begin,
		float	end
	)

void plAnimTimeConvert::setRange	(	float	begin,
		float	end
	)

void plAnimTimeConvert::setSpeed

(

float

speed

)

void plAnimTimeConvert::setSpeedEaseCurve

(

plATCEaseCurve *

curve

)

void plAnimTimeConvert::setStopPoints

(

const std::vector< float > &

stops

)

virtual void plAnimTimeConvert::write ( hsStream *  , plResManager *    )

virtual

Writes this creatable directly to the stream. The plResManager is used to manage any key references written by this creatable.

Reimplemented from plCreatable.

Member Data Documentation

float plAnimTimeConvert::fBegin

protected

std::vector<plEventCallbackMsg*> plAnimTimeConvert::fCallbackMsgs

protected

float plAnimTimeConvert::fCurrentAnimTime

protected

plATCEaseCurve* plAnimTimeConvert::fEaseInCurve

protected

plATCEaseCurve* plAnimTimeConvert::fEaseOutCurve

protected

float plAnimTimeConvert::fEnd

protected

unsigned int plAnimTimeConvert::fFlags

protected

double plAnimTimeConvert::fLastEvalWorldTime

protected

float plAnimTimeConvert::fLoopBegin

protected

float plAnimTimeConvert::fLoopEnd

protected

float plAnimTimeConvert::fSpeed

protected

plATCEaseCurve* plAnimTimeConvert::fSpeedEaseCurve

protected

std::vector<float> plAnimTimeConvert::fStopPoints

protected

---

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

• core/PRP/Animation/plAnimTimeConvert.h