plAnimPath Class Reference

#include <plAnimPath.h>

Inheritance diagram for plAnimPath:

Public Types
enum	Flags {   kNone = 0, kFavorFwdSearch = 0x1, kFavorBwdSearch = 0x2, kCalcPosOnly = 0x4,   kFarthest = 0x8, kWrap = 0x10, kIncrement = 0x20 }

Public Member Functions
	plAnimPath ()
virtual	~plAnimPath ()
virtual void	read (hsStream *S, plResManager *mgr)
virtual void	write (hsStream *S, plResManager *mgr)
unsigned int	getFlags () const
float	getMinDistSq () const
float	getLength () const
const hsMatrix44 &	getLocalToWorld () const
const hsMatrix44 &	getWorldToLocal () const
plCompoundController *	getController () const
plTMController *	getTMController () const
const hsAffineParts &	getAffineParts () const
void	setFlags (unsigned int flags)
void	setMinDistSq (float dist)
void	setLength (float length)
void	setLocalToWorld (const hsMatrix44 &l2w)
void	setWorldToLocal (const hsMatrix44 &w2l)
void	setAffineParts (const hsAffineParts &parts)
void	setController (plCompoundController *controller)
void	setTMController (plTMController *controller)
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	fAnimPathFlags
float	fMinDistSq
float	fLength
hsMatrix44	fLocalToWorld
hsMatrix44	fWorldToLocal
plCompoundController *	fController
plTMController *	fTMController
hsAffineParts	fParts

Member Enumeration Documentation

enum plAnimPath::Flags

Enumerator:

kNone
kFavorFwdSearch
kFavorBwdSearch
kCalcPosOnly
kFarthest
kWrap
kIncrement

Constructor & Destructor Documentation

plAnimPath::plAnimPath

(

)

virtual plAnimPath::~plAnimPath ( )

virtual

Member Function Documentation

const hsAffineParts& plAnimPath::getAffineParts

(

)

const

plCompoundController* plAnimPath::getController

(

)

const

unsigned int plAnimPath::getFlags

(

)

const

float plAnimPath::getLength

(

)

const

const hsMatrix44& plAnimPath::getLocalToWorld

(

)

const

float plAnimPath::getMinDistSq

(

)

const

plTMController* plAnimPath::getTMController

(

)

const

const hsMatrix44& plAnimPath::getWorldToLocal

(

)

const

virtual void plAnimPath::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 plAnimPath::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 plAnimPath::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 plAnimPath::setAffineParts

(

const hsAffineParts &

parts

)

void plAnimPath::setController

(

plCompoundController *

controller

)

void plAnimPath::setFlags

(

unsigned int

flags

)

void plAnimPath::setLength

(

float

length

)

void plAnimPath::setLocalToWorld

(

const hsMatrix44 &

l2w

)

void plAnimPath::setMinDistSq

(

float

dist

)

void plAnimPath::setTMController

(

plTMController *

controller

)

void plAnimPath::setWorldToLocal

(

const hsMatrix44 &

w2l

)

virtual void plAnimPath::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

unsigned int plAnimPath::fAnimPathFlags

protected

plCompoundController* plAnimPath::fController

protected

float plAnimPath::fLength

protected

hsMatrix44 plAnimPath::fLocalToWorld

protected

float plAnimPath::fMinDistSq

protected

hsAffineParts plAnimPath::fParts

protected

plTMController* plAnimPath::fTMController

protected

hsMatrix44 plAnimPath::fWorldToLocal

protected

---

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

• core/PRP/Animation/plAnimPath.h