plClusterGroup Class Reference

#include <plClusterGroup.h>

Inheritance diagram for plClusterGroup:

Public Member Functions
	plClusterGroup ()
virtual	~plClusterGroup ()
virtual void	read (hsStream *S, plResManager *mgr)
virtual void	write (hsStream *S, plResManager *mgr)
const plLODDist &	getLOD () const
plLODDist &	getLOD ()
const plSpanTemplate &	getTemplate () const
plSpanTemplate &	getTemplate ()
plKey	getMaterial () const
plKey	getSceneNode () const
plKey	getDrawable () const
unsigned int	getRenderLevel () const
void	setMaterial (plKey mat)
void	setSceneNode (plKey node)
void	setDrawable (plKey draw)
void	setRenderLevel (unsigned int level)
const std::vector< plCluster * > &	getClusters () const
std::vector< plCluster * > &	getClusters ()
void	addCluster (plCluster *cluster)
void	delCluster (size_t idx)
void	clearClusters ()
const std::vector< plKey > &	getRegions () const
std::vector< plKey > &	getRegions ()
void	addRegion (plKey region)
void	delRegion (size_t idx)
void	clearRegions ()
const std::vector< plKey > &	getLights () const
std::vector< plKey > &	getLights ()
void	addLight (plKey light)
void	delLight (size_t idx)
void	clearLights ()
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
plSpanTemplate	fTemplate
plKey	fMaterial
std::vector< plCluster * >	fClusters
std::vector< plKey >	fRegions
std::vector< plKey >	fLights
plLODDist	fLOD
plKey	fSceneNode
plKey	fDrawable
unsigned int	fRenderLevel

Constructor & Destructor Documentation

plClusterGroup::plClusterGroup

(

)

virtual plClusterGroup::~plClusterGroup ( )

virtual

Member Function Documentation

void plClusterGroup::addCluster

(

plCluster *

cluster

)

void plClusterGroup::addLight

(

plKey

light

)

void plClusterGroup::addRegion

(

plKey

region

)

void plClusterGroup::clearClusters

(

)

void plClusterGroup::clearLights

(

)

void plClusterGroup::clearRegions

(

)

void plClusterGroup::delCluster

(

size_t

idx

)

void plClusterGroup::delLight

(

size_t

idx

)

void plClusterGroup::delRegion

(

size_t

idx

)

const std::vector<plCluster*>& plClusterGroup::getClusters

(

)

const

std::vector<plCluster*>& plClusterGroup::getClusters

(

)

plKey plClusterGroup::getDrawable

(

)

const

const std::vector<plKey>& plClusterGroup::getLights

(

)

const

std::vector<plKey>& plClusterGroup::getLights

(

)

const plLODDist& plClusterGroup::getLOD

(

)

const

plLODDist& plClusterGroup::getLOD

(

)

plKey plClusterGroup::getMaterial

(

)

const

const std::vector<plKey>& plClusterGroup::getRegions

(

)

const

std::vector<plKey>& plClusterGroup::getRegions

(

)

unsigned int plClusterGroup::getRenderLevel

(

)

const

plKey plClusterGroup::getSceneNode

(

)

const

const plSpanTemplate& plClusterGroup::getTemplate

(

)

const

plSpanTemplate& plClusterGroup::getTemplate

(

)

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

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

void plClusterGroup::setDrawable

(

plKey

draw

)

void plClusterGroup::setMaterial

(

plKey

mat

)

void plClusterGroup::setRenderLevel

(

unsigned int

level

)

void plClusterGroup::setSceneNode

(

plKey

node

)

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

Member Data Documentation

std::vector<plCluster*> plClusterGroup::fClusters

protected

plKey plClusterGroup::fDrawable

protected

std::vector<plKey> plClusterGroup::fLights

protected

plLODDist plClusterGroup::fLOD

protected

plKey plClusterGroup::fMaterial

protected

std::vector<plKey> plClusterGroup::fRegions

protected

unsigned int plClusterGroup::fRenderLevel

protected

plKey plClusterGroup::fSceneNode

protected

plSpanTemplate plClusterGroup::fTemplate

protected

---

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

• core/PRP/Geometry/plClusterGroup.h