plAGApplicator Class Reference

#include <plAGApplicator.h>

Inheritance diagram for plAGApplicator:

Public Member Functions
	plAGApplicator ()
virtual	~plAGApplicator ()
virtual void	read (hsStream *S, plResManager *mgr)
virtual void	write (hsStream *S, plResManager *mgr)
plAGChannel *	getChannel () const
void	setChannel (plAGChannel *)
bool	isEnabled () const
plString	getChannelName () const
void	setEnabled (bool enabled)
void	setChannelName (const plString &channelName)
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
plAGChannel *	fChannel
bool	fEnabled
plString	fChannelName

Constructor & Destructor Documentation

plAGApplicator::plAGApplicator

(

)

virtual plAGApplicator::~plAGApplicator ( )

virtual

Member Function Documentation

plAGChannel* plAGApplicator::getChannel

(

)

const

plString plAGApplicator::getChannelName

(

)

const

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

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

bool plAGApplicator::isEnabled

(

)

const

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

void plAGApplicator::setChannel

(

plAGChannel *

)

void plAGApplicator::setChannelName

(

const plString &

channelName

)

void plAGApplicator::setEnabled

(

bool

enabled

)

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

Member Data Documentation

plAGChannel* plAGApplicator::fChannel

protected

plString plAGApplicator::fChannelName

protected

bool plAGApplicator::fEnabled

protected

---

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

• core/PRP/Avatar/plAGApplicator.h