hsKeyedObjectStub Class Reference

Stores the stub of an hsKeyedObject class. More...

#include <hsKeyedObject.h>

Inheritance diagram for hsKeyedObjectStub:

Public Member Functions
	hsKeyedObjectStub ()
virtual	~hsKeyedObjectStub ()
virtual short	ClassIndex () const
virtual const char *	ClassName () const
virtual void	write (hsStream *S, plResManager *mgr)
const plCreatableStub *	getStub () const
void	setStub (plCreatableStub *stub)
Public Member Functions inherited from hsKeyedObject
void	init (const plString &name)
virtual void	read (hsStream *S, plResManager *mgr)
plKey	getKey () const
void	setKey (plKey key)
Public Member Functions inherited from plCreatable
	plCreatable ()
virtual	~plCreatable ()
short	ClassIndex (PlasmaVer ver) 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)

Detailed Description

Stores the stub of an hsKeyedObject class.

Like plCreatableStub, this class stores a data buffer containing the contents of an unparsed Creatable. hsKeyedObjectStub is actually just a convenience class to provide the hsKeyedObject interface to the plCreatableStub, specifically, being able to access the object's key. If your stub is an hsKeyedObject-derived class, it's very highly recommended you use this instead of a normal plCreatableStub!

See Also

plCreatableStub

Constructor & Destructor Documentation

hsKeyedObjectStub::hsKeyedObjectStub

(

)

virtual hsKeyedObjectStub::~hsKeyedObjectStub ( )

virtual

Member Function Documentation

virtual short hsKeyedObjectStub::ClassIndex ( ) const

virtual

Returns the Creatable Class ID for this Creatable. Use the CREATABLE macro to set this automatically in subclasses.

Implements plCreatable.

virtual const char* hsKeyedObjectStub::ClassName ( ) const

virtual

Returns a string of the creatable's class name. Use the CREATABLE macro to set this automatically in subclasses.

Reimplemented from plCreatable.

const plCreatableStub* hsKeyedObjectStub::getStub

(

)

const

Returns the underlying plCreatableStub object of this stub

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

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

void hsKeyedObjectStub::setStub

(

plCreatableStub *

stub

)

Sets the underlying plCreatableStub object of this stub

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

---

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

• core/PRP/KeyedObject/hsKeyedObject.h