plATCAnim Class Reference

#include <plATCAnim.h>

Inheritance diagram for plATCAnim:

Public Types
typedef std::map< plString, float >	marker_t
typedef std::map< plString, std::pair< float, float > >	loop_t
Public Types inherited from plAGAnim
enum	BodyUsage {   kBodyUnknown, kBodyUpper, kBodyFull, kBodyLower,   kBodyMax }
Public Types inherited from plSynchedObject
enum	Flags {   kDontDirty = 0x1, kSendReliably = 0x2, kHasConstantNetGroup = 0x4, kDontSynchGameMessages = 0x8,   kExcludePersistentState = 0x10, kExcludeAllPersistentState = 0x20, kLocalOnly = kExcludeAllPersistentState | kDontSynchGameMessages, kHasVolatileState = 0x40,   kAllStateIsVolatile = 0x80 }
enum	SDLSendFlags {   kBCastToClients = 0x1, kForceFullSend = 0x2, kSkipLocalOwnershipCheck = 0x4, kSendImmediately = 0x8,   kDontPersistOnServer = 0x10, kUseRelevanceRegions = 0x20, kNewState = 0x40, kIsAvatarState = 0x80 }

Public Member Functions
	plATCAnim ()
virtual void	read (hsStream *S, plResManager *mgr)
virtual void	write (hsStream *S, plResManager *mgr)
const marker_t &	getMarkers () const
marker_t &	getMarkers ()
const loop_t &	getLoops () const
loop_t &	getLoops ()
float	getInitial () const
float	getLoopStart () const
float	getLoopEnd () const
bool	getAutoStart () const
bool	getDoLoop () const
unsigned char	getEaseInType () const
unsigned char	getEaseOutType () const
float	getEaseInLength () const
float	getEaseInMin () const
float	getEaseInMax () const
float	getEaseOutLength () const
float	getEaseOutMin () const
float	getEaseOutMax () const
float	getMarker (const plString &key) const
std::pair< float, float >	getLoop (const plString &key) const
const std::vector< float > &	getStops () const
void	setInitial (float init)
void	setLoopStart (float start)
void	setLoopEnd (float end)
void	setAutoStart (bool autoStart)
void	setDoLoop (bool loop)
void	setEaseInType (unsigned char type)
void	setEaseOutType (unsigned char type)
void	setEaseInParams (float length, float min, float max)
void	setEaseOutParams (float length, float min, float max)
void	setMarker (const plString &key, float value)
void	setLoop (const plString &key, float start, float end)
void	setStops (const std::vector< float > &stops)
Public Member Functions inherited from plAGAnim
	plAGAnim ()
virtual	~plAGAnim ()
const std::vector < plAGApplicator * > &	getApplicators () const
std::vector< plAGApplicator * > &	getApplicators ()
void	addApplicator (plAGApplicator *app)
void	delApplicator (size_t idx)
void	clearApplicators ()
float	getBlend () const
float	getStart () const
float	getEnd () const
plString	getName () const
void	setBlend (float blend)
void	setStart (float start)
void	setEnd (float end)
void	setName (const plString &name)
Public Member Functions inherited from plSynchedObject
	plSynchedObject ()
int	getFlags () const
void	setFlags (int flags)
const std::vector< plString > &	getExcludes () const
const std::vector< plString > &	getVolatiles () const
void	setExclude (const plString &sdl)
void	setVolatile (const plString &sdl)
void	clearExcludes ()
void	clearVolatiles ()
Public Member Functions inherited from hsKeyedObject
void	init (const plString &name)
plKey	getKey () const
void	setKey (plKey key)
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
float	fInitial
float	fLoopStart
float	fLoopEnd
bool	fAutoStart
bool	fLoop
unsigned char	fEaseInType
unsigned char	fEaseOutType
float	fEaseInLength
float	fEaseInMin
float	fEaseInMax
float	fEaseOutLength
float	fEaseOutMin
float	fEaseOutMax
marker_t	fMarkers
loop_t	fLoops
std::vector< float >	fStopPoints
Protected Attributes inherited from plAGAnim
std::vector< plAGApplicator * >	fApps
float	fBlend
float	fStart
float	fEnd
plString	fName
unsigned char	fEoaFlag
Protected Attributes inherited from plSynchedObject
unsigned int	fSynchFlags
std::vector< plString >	fSDLExcludeList
std::vector< plString >	fSDLVolatileList

Member Typedef Documentation

typedef std::map<plString, std::pair<float, float> > plATCAnim::loop_t

typedef std::map<plString, float> plATCAnim::marker_t

Constructor & Destructor Documentation

plATCAnim::plATCAnim

(

)

Member Function Documentation

bool plATCAnim::getAutoStart

(

)

const

bool plATCAnim::getDoLoop

(

)

const

float plATCAnim::getEaseInLength

(

)

const

float plATCAnim::getEaseInMax

(

)

const

float plATCAnim::getEaseInMin

(

)

const

unsigned char plATCAnim::getEaseInType

(

)

const

float plATCAnim::getEaseOutLength

(

)

const

float plATCAnim::getEaseOutMax

(

)

const

float plATCAnim::getEaseOutMin

(

)

const

unsigned char plATCAnim::getEaseOutType

(

)

const

float plATCAnim::getInitial

(

)

const

std::pair<float, float> plATCAnim::getLoop

(

const plString &

key

)

const

float plATCAnim::getLoopEnd

(

)

const

const loop_t& plATCAnim::getLoops

(

)

const

loop_t& plATCAnim::getLoops

(

)

float plATCAnim::getLoopStart

(

)

const

float plATCAnim::getMarker

(

const plString &

key

)

const

const marker_t& plATCAnim::getMarkers

(

)

const

marker_t& plATCAnim::getMarkers

(

)

const std::vector<float>& plATCAnim::getStops

(

)

const

virtual void plATCAnim::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 plAGAnim.

Reimplemented in plAGAnimBink, and plEmoteAnim.

virtual void plATCAnim::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().

Reimplemented from plAGAnim.

Reimplemented in plAGAnimBink, and plEmoteAnim.

virtual void plATCAnim::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 plAGAnim.

Reimplemented in plAGAnimBink, and plEmoteAnim.

void plATCAnim::setAutoStart

(

bool

autoStart

)

void plATCAnim::setDoLoop

(

bool

loop

)

void plATCAnim::setEaseInParams	(	float	length,
		float	min,
		float	max
	)

void plATCAnim::setEaseInType

(

unsigned char

type

)

void plATCAnim::setEaseOutParams	(	float	length,
		float	min,
		float	max
	)

void plATCAnim::setEaseOutType

(

unsigned char

type

)

void plATCAnim::setInitial

(

float

init

)

void plATCAnim::setLoop	(	const plString &	key,
		float	start,
		float	end
	)

void plATCAnim::setLoopEnd

(

float

end

)

void plATCAnim::setLoopStart

(

float

start

)

void plATCAnim::setMarker	(	const plString &	key,
		float	value
	)

void plATCAnim::setStops

(

const std::vector< float > &

stops

)

virtual void plATCAnim::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 plAGAnim.

Reimplemented in plAGAnimBink, and plEmoteAnim.

Member Data Documentation

bool plATCAnim::fAutoStart

protected

float plATCAnim::fEaseInLength

protected

float plATCAnim::fEaseInMax

protected

float plATCAnim::fEaseInMin

protected

unsigned char plATCAnim::fEaseInType

protected

float plATCAnim::fEaseOutLength

protected

float plATCAnim::fEaseOutMax

protected

float plATCAnim::fEaseOutMin

protected

unsigned char plATCAnim::fEaseOutType

protected

float plATCAnim::fInitial

protected

bool plATCAnim::fLoop

protected

float plATCAnim::fLoopEnd

protected

loop_t plATCAnim::fLoops

protected

float plATCAnim::fLoopStart

protected

marker_t plATCAnim::fMarkers

protected

std::vector<float> plATCAnim::fStopPoints

protected

---

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

• core/PRP/Avatar/plATCAnim.h