plLayerAnimationBase Class Reference

#include <plLayerAnimation.h>

Inheritance diagram for plLayerAnimationBase:

Public Member Functions
	plLayerAnimationBase ()
virtual	~plLayerAnimationBase ()
virtual void	read (hsStream *S, plResManager *mgr)
virtual void	write (hsStream *S, plResManager *mgr)
virtual void	prcParse (const pfPrcTag *tag, plResManager *mgr)
plController *	getPreshadeCtl () const
plController *	getRuntimeCtl () const
plController *	getAmbientCtl () const
plController *	getSpecularCtl () const
plController *	getOpacityCtl () const
plController *	getTransformCtl () const
void	setPreshadeCtl (plController *ctrl)
void	setRuntimeCtl (plController *ctrl)
void	setAmbientCtl (plController *ctrl)
void	setSpecularCtl (plController *ctrl)
void	setOpacityCtl (plController *ctrl)
void	setTransformCtl (plController *ctrl)
Public Member Functions inherited from plLayerInterface
	plLayerInterface ()
plKey	getUnderLay () const
plKey	getTexture () const
plKey	getVertexShader () const
plKey	getPixelShader () const
void	setUnderLay (plKey layer)
void	setTexture (plKey tex)
void	setVertexShader (plKey shader)
void	setPixelShader (plKey shader)
hsMatrix44	getTransform () const
hsMatrix44	getBumpEnvTransform () const
void	setTransform (const hsMatrix44 &xform)
void	setBumpEnvTransform (const hsMatrix44 &xform)
hsColorRGBA	getPreshade () const
hsColorRGBA	getRuntime () const
hsColorRGBA	getAmbient () const
hsColorRGBA	getSpecular () const
void	setPreshade (const hsColorRGBA &color)
void	setRuntime (const hsColorRGBA &color)
void	setAmbient (const hsColorRGBA &color)
void	setSpecular (const hsColorRGBA &color)
float	getOpacity () const
unsigned int	getUVWSrc () const
float	getLODBias () const
float	getSpecularPower () const
void	setOpacity (float opac)
void	setUVWSrc (unsigned int src)
void	setLODBias (float bias)
void	setSpecularPower (float power)
const hsGMatState &	getState () const
hsGMatState &	getState ()
Public Member Functions inherited from plSynchedObject
	plSynchedObject ()
int	getFlags () const
void	setFlags (int flags)
const std::vector< plString > &	getExcludes () const
const std::vector< plString > &	getVolatiles () const
void	setExclude (const plString &sdl)
void	setVolatile (const plString &sdl)
void	clearExcludes ()
void	clearVolatiles ()
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)

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

Protected Attributes
plController *	fPreshadeColorCtl
plController *	fRuntimeColorCtl
plController *	fAmbientColorCtl
plController *	fSpecularColorCtl
plController *	fOpacityCtl
plController *	fTransformCtl
Protected Attributes inherited from plLayerInterface
plKey	fUnderLay
hsMatrix44	fTransform
hsColorRGBA	fPreshade
hsColorRGBA	fRuntime
hsColorRGBA	fAmbient
hsColorRGBA	fSpecular
float	fOpacity
unsigned int	fUVWSrc
float	fLODBias
float	fSpecularPower
plKey	fTexture
plKey	fVertexShader
plKey	fPixelShader
hsMatrix44	fBumpEnvXfm
hsGMatState	fState
Protected Attributes inherited from plSynchedObject
unsigned int	fSynchFlags
std::vector< plString >	fSDLExcludeList
std::vector< plString >	fSDLVolatileList

Additional Inherited Members
Public Types inherited from plLayerInterface
enum	plLayerDirtyBits {   kTransform = 0x1, kPreshadeColor = 0x2, kAmbientColor = 0x4, kOpacity = 0x8,   kTexture = 0x10, kState = 0x20, kUVWSrc = 0x40, kLODBias = 0x80,   kSpecularColor = 0x100, kSpecularPower = 0x200, kRuntimeColor = 0x400, kVertexShader = 0x800,   kPixelShader = 0x1000, kBumpEnvXfm = 0x2000, kAllDirty = 0xFFFFFFFF }
enum	plUVWSrcModifiers {   kUVWPassThru = 0, kUVWIdxMask = 0xFFFF, kUVWNormal = 0x10000, kUVWPosition = 0x20000,   kUVWReflect = 0x30000 }

Constructor & Destructor Documentation

plLayerAnimationBase::plLayerAnimationBase

(

)

virtual plLayerAnimationBase::~plLayerAnimationBase ( )

virtual

Member Function Documentation

plController* plLayerAnimationBase::getAmbientCtl

(

)

const

plController* plLayerAnimationBase::getOpacityCtl

(

)

const

plController* plLayerAnimationBase::getPreshadeCtl

(

)

const

plController* plLayerAnimationBase::getRuntimeCtl

(

)

const

plController* plLayerAnimationBase::getSpecularCtl

(

)

const

plController* plLayerAnimationBase::getTransformCtl

(

)

const

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

Reimplemented in plLayerSDLAnimation, plLayerLinkAnimation, plLayerAnimation, and plLayerMovie.

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

Reimplemented in plLayerSDLAnimation, plLayerLinkAnimation, plLayerAnimation, and plLayerMovie.

virtual void plLayerAnimationBase::prcParse ( const pfPrcTag *  tag, plResManager *  mgr  )

virtual

Read this creatable from a PRC tag. If any keys are parsed, they will be added to the plResManager automatically.

Reimplemented from plCreatable.

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

Reimplemented in plLayerSDLAnimation, plLayerLinkAnimation, plLayerAnimation, and plLayerMovie.

void plLayerAnimationBase::setAmbientCtl

(

plController *

ctrl

)

void plLayerAnimationBase::setOpacityCtl

(

plController *

ctrl

)

void plLayerAnimationBase::setPreshadeCtl

(

plController *

ctrl

)

void plLayerAnimationBase::setRuntimeCtl

(

plController *

ctrl

)

void plLayerAnimationBase::setSpecularCtl

(

plController *

ctrl

)

void plLayerAnimationBase::setTransformCtl

(

plController *

ctrl

)

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

Reimplemented in plLayerSDLAnimation, plLayerLinkAnimation, plLayerAnimation, and plLayerMovie.

Member Data Documentation

plController* plLayerAnimationBase::fAmbientColorCtl

protected

plController* plLayerAnimationBase::fOpacityCtl

protected

plController* plLayerAnimationBase::fPreshadeColorCtl

protected

plController* plLayerAnimationBase::fRuntimeColorCtl

protected

plController* plLayerAnimationBase::fSpecularColorCtl

protected

plController* plLayerAnimationBase::fTransformCtl

protected

---

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

• core/PRP/Surface/plLayerAnimation.h