plConditionalObject Class Reference

#include <plConditionalObject.h>

Inheritance diagram for plConditionalObject:

Public Member Functions
	plConditionalObject ()
virtual void	read (hsStream *S, plResManager *mgr)
virtual void	write (hsStream *S, plResManager *mgr)
Public Member Functions inherited from hsKeyedObject
void	init (const plString &name)
plKey	getKey () const
void	setKey (plKey key)
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
bool	fSatisfied
bool	fToggle

Constructor & Destructor Documentation

plConditionalObject::plConditionalObject

(

)

Member Function Documentation

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

Reimplemented in plORConditionalObject, plVolumeSensorConditionalObject, plAnimationEventConditionalObject, plControlEventConditionalObject, plFacingConditionalObject, plKeyPressConditionalObject, plActivatorConditionalObject, and plANDConditionalObject.

virtual void plConditionalObject::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().

Reimplemented from hsKeyedObject.

Reimplemented in plORConditionalObject, plVolumeSensorConditionalObject, plAnimationEventConditionalObject, plControlEventConditionalObject, plFacingConditionalObject, plKeyPressConditionalObject, plActivatorConditionalObject, and plANDConditionalObject.

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

Reimplemented in plORConditionalObject, plVolumeSensorConditionalObject, plAnimationEventConditionalObject, plControlEventConditionalObject, plFacingConditionalObject, plKeyPressConditionalObject, plActivatorConditionalObject, and plANDConditionalObject.

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

Reimplemented in plORConditionalObject, plVolumeSensorConditionalObject, plAnimationEventConditionalObject, plControlEventConditionalObject, plFacingConditionalObject, plKeyPressConditionalObject, plActivatorConditionalObject, and plANDConditionalObject.

Member Data Documentation

bool plConditionalObject::fSatisfied

protected

bool plConditionalObject::fToggle

protected

---

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

• core/PRP/ConditionalObject/plConditionalObject.h