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

#include <plPosController.h>

Inheritance diagram for plCompoundPosController:
plPosController plController plCreatable

Public Member Functions

 plCompoundPosController ()
virtual ~plCompoundPosController ()
virtual int getType () const
virtual void read (hsStream *S, plResManager *mgr)
virtual void write (hsStream *S, plResManager *mgr)
plScalarControllergetX () const
plScalarControllergetY () const
plScalarControllergetZ () const
void setX (plScalarController *controller)
void setY (plScalarController *controller)
void setZ (plScalarController *controller)

Protected Member Functions

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

Protected Attributes

plScalarControllerfXController
plScalarControllerfYController
plScalarControllerfZController

Additional Inherited Members

- Public Types inherited from plPosController
enum  { kSimple = 1, kCompound }
- Static Public Member Functions inherited from plController
static void WriteController (hsStream *S, plResManager *mgr, plController *controller)

Constructor & Destructor Documentation

plCompoundPosController::plCompoundPosController ( )
virtual plCompoundPosController::~plCompoundPosController ( )
virtual

Member Function Documentation

virtual int plCompoundPosController::getType ( ) const
virtual

Implements plPosController.

plScalarController* plCompoundPosController::getX ( ) const
plScalarController* plCompoundPosController::getY ( ) const
plScalarController* plCompoundPosController::getZ ( ) const
virtual void plCompoundPosController::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 plCompoundPosController::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 plCompoundPosController::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 plCompoundPosController::setX ( plScalarController controller)
void plCompoundPosController::setY ( plScalarController controller)
void plCompoundPosController::setZ ( plScalarController controller)
virtual void plCompoundPosController::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

plScalarController* plCompoundPosController::fXController
protected
plScalarController* plCompoundPosController::fYController
protected
plScalarController* plCompoundPosController::fZController
protected

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