libHSPlasma
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
plLeafController Class Reference

#include <plLeafController.h>

Inheritance diagram for plLeafController:
plController plCreatable plEaseController plMatrix33Controller plMatrix44Controller plPoint3Controller plQuatController plScalarController plScaleValueController

Public Member Functions

 plLeafController ()
virtual ~plLeafController ()
virtual void read (hsStream *S, plResManager *mgr)
virtual void write (hsStream *S, plResManager *mgr)
plLeafControllerExpandToKeyController () const
plLeafControllerCompactToLeafController () const
bool hasKeys () const
bool hasEaseControllers () const
unsigned int getType () const
const std::vector< hsKeyFrame * > & getKeys () const
const std::vector< class
plEaseController * > & 
getEaseControllers () const
void setKeys (const std::vector< hsKeyFrame * > &keys, unsigned int type)
void setEaseControllers (const std::vector< class plEaseController * > &controllers)

Protected Member Functions

virtual void IPrcWrite (pfPrcHelper *prc)
virtual void IPrcParse (const pfPrcTag *tag, plResManager *mgr)
void AllocKeys (unsigned int numKeys, unsigned int type)
void DeallocKeys ()
void AllocControllers (unsigned int numControllers)
void DeallocControllers ()
void IReadUruController (hsStream *S)
void IWriteUruController (hsStream *S)

Protected Attributes

unsigned int fType
unsigned int fUruUnknown
std::vector< hsKeyFrame * > fKeys
std::vector< class
plEaseController * > 
fEaseControllers

Additional Inherited Members

- Static Public Member Functions inherited from plController
static void WriteController (hsStream *S, plResManager *mgr, plController *controller)

Constructor & Destructor Documentation

plLeafController::plLeafController ( )
virtual plLeafController::~plLeafController ( )
virtual

Member Function Documentation

void plLeafController::AllocControllers ( unsigned int  numControllers)
protected
void plLeafController::AllocKeys ( unsigned int  numKeys,
unsigned int  type 
)
protected
plLeafController* plLeafController::CompactToLeafController ( ) const
void plLeafController::DeallocControllers ( )
protected
void plLeafController::DeallocKeys ( )
protected
plLeafController* plLeafController::ExpandToKeyController ( ) const
const std::vector<class plEaseController*>& plLeafController::getEaseControllers ( ) const
const std::vector<hsKeyFrame*>& plLeafController::getKeys ( ) const
unsigned int plLeafController::getType ( ) const
bool plLeafController::hasEaseControllers ( ) const
bool plLeafController::hasKeys ( ) const
virtual void plLeafController::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 plLeafController::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.

void plLeafController::IReadUruController ( hsStream S)
protected
void plLeafController::IWriteUruController ( hsStream S)
protected
virtual void plLeafController::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 plLeafController::setEaseControllers ( const std::vector< class plEaseController * > &  controllers)
void plLeafController::setKeys ( const std::vector< hsKeyFrame * > &  keys,
unsigned int  type 
)
virtual void plLeafController::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

std::vector<class plEaseController*> plLeafController::fEaseControllers
protected
std::vector<hsKeyFrame*> plLeafController::fKeys
protected
unsigned int plLeafController::fType
protected
unsigned int plLeafController::fUruUnknown
protected

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