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

#include <plAGChannel.h>

Inheritance diagram for plAGChannel:
plCreatable plMatrixChannel plPointChannel plQuatChannel plScalarChannel plMatrixBlend plMatrixConstant plMatrixControllerCacheChannel plMatrixControllerChannel plMatrixTimeScale plQuatPointCombine plPointBlend plPointConstant plPointControllerCacheChannel plPointControllerChannel plPointTimeScale plQuatBlend plQuatConstant plQuatTimeScale plATCChannel plScalarBlend plScalarConstant plScalarControllerCacheChannel plScalarControllerChannel plScalarSDLChannel plScalarTimeScale

Public Member Functions

virtual void read (hsStream *S, plResManager *mgr)
virtual void write (hsStream *S, plResManager *mgr)
plString getName () const
void setName (const plString &name)
- 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

plString fName

Member Function Documentation

plString plAGChannel::getName ( ) const
virtual void plAGChannel::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.

Reimplemented in plMatrixControllerChannel, plScalarControllerChannel, plPointControllerChannel, plMatrixConstant, plPointConstant, plQuatConstant, and plScalarConstant.

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

Reimplemented in plMatrixControllerChannel, plScalarControllerChannel, plPointControllerChannel, plMatrixConstant, plPointConstant, plQuatConstant, and plScalarConstant.

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

Reimplemented in plMatrixControllerChannel, plScalarControllerChannel, plPointControllerChannel, plMatrixConstant, plPointConstant, plQuatConstant, and plScalarConstant.

void plAGChannel::setName ( const plString name)
virtual void plAGChannel::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.

Reimplemented in plMatrixControllerChannel, plScalarControllerChannel, plPointControllerChannel, plMatrixConstant, plPointConstant, plQuatConstant, and plScalarConstant.

Member Data Documentation

plString plAGChannel::fName
protected

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