plLayerInterface Class Reference

#include <plLayerInterface.h>

Inheritance diagram for plLayerInterface:

Public Types
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 }
Public Types inherited from plSynchedObject
enum	Flags {   kDontDirty = 0x1, kSendReliably = 0x2, kHasConstantNetGroup = 0x4, kDontSynchGameMessages = 0x8,   kExcludePersistentState = 0x10, kExcludeAllPersistentState = 0x20, kLocalOnly = kExcludeAllPersistentState | kDontSynchGameMessages, kHasVolatileState = 0x40,   kAllStateIsVolatile = 0x80 }
enum	SDLSendFlags {   kBCastToClients = 0x1, kForceFullSend = 0x2, kSkipLocalOwnershipCheck = 0x4, kSendImmediately = 0x8,   kDontPersistOnServer = 0x10, kUseRelevanceRegions = 0x20, kNewState = 0x40, kIsAvatarState = 0x80 }

Public Member Functions
	plLayerInterface ()
virtual void	read (hsStream *S, plResManager *mgr)
virtual void	write (hsStream *S, plResManager *mgr)
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)
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
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

Member Enumeration Documentation

enum plLayerInterface::plLayerDirtyBits

Enumerator:

kTransform
kPreshadeColor
kAmbientColor
kOpacity
kTexture
kState
kUVWSrc
kLODBias
kSpecularColor
kSpecularPower
kRuntimeColor
kVertexShader
kPixelShader
kBumpEnvXfm
kAllDirty

enum plLayerInterface::plUVWSrcModifiers

Enumerator:

kUVWPassThru
kUVWIdxMask
kUVWNormal
kUVWPosition
kUVWReflect

Constructor & Destructor Documentation

plLayerInterface::plLayerInterface

(

)

Member Function Documentation

hsColorRGBA plLayerInterface::getAmbient

(

)

const

hsMatrix44 plLayerInterface::getBumpEnvTransform

(

)

const

float plLayerInterface::getLODBias

(

)

const

float plLayerInterface::getOpacity

(

)

const

plKey plLayerInterface::getPixelShader

(

)

const

hsColorRGBA plLayerInterface::getPreshade

(

)

const

hsColorRGBA plLayerInterface::getRuntime

(

)

const

hsColorRGBA plLayerInterface::getSpecular

(

)

const

float plLayerInterface::getSpecularPower

(

)

const

const hsGMatState& plLayerInterface::getState

(

)

const

hsGMatState& plLayerInterface::getState

(

)

plKey plLayerInterface::getTexture

(

)

const

hsMatrix44 plLayerInterface::getTransform

(

)

const

plKey plLayerInterface::getUnderLay

(

)

const

unsigned int plLayerInterface::getUVWSrc

(

)

const

plKey plLayerInterface::getVertexShader

(

)

const

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

Reimplemented in plLayerSDLAnimation, plLayerLinkAnimation, plLayerAnimation, plLayerAnimationBase, plLayerMovie, and plLayer.

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

Reimplemented in plLayerSDLAnimation, plLayerLinkAnimation, plLayerAnimation, plLayerAnimationBase, plLayerMovie, and plLayer.

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

Reimplemented in plLayerSDLAnimation, plLayerLinkAnimation, plLayerAnimation, plLayerAnimationBase, plLayerMovie, and plLayer.

void plLayerInterface::setAmbient

(

const hsColorRGBA &

color

)

void plLayerInterface::setBumpEnvTransform

(

const hsMatrix44 &

xform

)

void plLayerInterface::setLODBias

(

float

bias

)

void plLayerInterface::setOpacity

(

float

opac

)

void plLayerInterface::setPixelShader

(

plKey

shader

)

void plLayerInterface::setPreshade

(

const hsColorRGBA &

color

)

void plLayerInterface::setRuntime

(

const hsColorRGBA &

color

)

void plLayerInterface::setSpecular

(

const hsColorRGBA &

color

)

void plLayerInterface::setSpecularPower

(

float

power

)

void plLayerInterface::setTexture

(

plKey

tex

)

void plLayerInterface::setTransform

(

const hsMatrix44 &

xform

)

void plLayerInterface::setUnderLay

(

plKey

layer

)

void plLayerInterface::setUVWSrc

(

unsigned int

src

)

void plLayerInterface::setVertexShader

(

plKey

shader

)

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

Reimplemented in plLayerSDLAnimation, plLayerLinkAnimation, plLayerAnimation, plLayerAnimationBase, plLayerMovie, and plLayer.

Member Data Documentation

hsColorRGBA plLayerInterface::fAmbient

protected

hsMatrix44 plLayerInterface::fBumpEnvXfm

protected

float plLayerInterface::fLODBias

protected

float plLayerInterface::fOpacity

protected

plKey plLayerInterface::fPixelShader

protected

hsColorRGBA plLayerInterface::fPreshade

protected

hsColorRGBA plLayerInterface::fRuntime

protected

hsColorRGBA plLayerInterface::fSpecular

protected

float plLayerInterface::fSpecularPower

protected

hsGMatState plLayerInterface::fState

protected

plKey plLayerInterface::fTexture

protected

hsMatrix44 plLayerInterface::fTransform

protected

plKey plLayerInterface::fUnderLay

protected

unsigned int plLayerInterface::fUVWSrc

protected

plKey plLayerInterface::fVertexShader

protected

---

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

• core/PRP/Surface/plLayerInterface.h