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

#include <plController.h>

Inheritance diagram for plCompoundController:
plController plCreatable

Public Member Functions

 plCompoundController ()
virtual ~plCompoundController ()
virtual void read (hsStream *S, plResManager *mgr)
virtual void write (hsStream *S, plResManager *mgr)
class plTMControllerconvertToTMController ()
plControllergetXController () const
plControllergetYController () const
plControllergetZController () const
void setXController (plController *controller)
void setYController (plController *controller)
void setZController (plController *controller)

Protected Member Functions

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

Protected Attributes

plControllerfXController
plControllerfYController
plControllerfZController

Additional Inherited Members

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

Constructor & Destructor Documentation

plCompoundController::plCompoundController ( )
virtual plCompoundController::~plCompoundController ( )
virtual

Member Function Documentation

class plTMController* plCompoundController::convertToTMController ( )
plController* plCompoundController::getXController ( ) const
plController* plCompoundController::getYController ( ) const
plController* plCompoundController::getZController ( ) const
virtual void plCompoundController::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 plCompoundController::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 plCompoundController::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 plCompoundController::setXController ( plController controller)
void plCompoundController::setYController ( plController controller)
void plCompoundController::setZController ( plController controller)
virtual void plCompoundController::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

plController* plCompoundController::fXController
protected
plController* plCompoundController::fYController
protected
plController* plCompoundController::fZController
protected

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