libHSPlasma
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
plShader Class Reference

#include <plShader.h>

Inheritance diagram for plShader:
hsKeyedObject plCreatable

Public Types

enum  plShaderID {
  kUnregistered, vs_WaveFixedFin6, ps_WaveFixed, vs_CompCosines,
  ps_CompCosines, vs_ShoreLeave6, ps_ShoreLeave6, vs_WaveRip,
  ps_WaveRip, vs_WaveDec1Lay, vs_WaveDec2Lay11, vs_WaveDec2Lay12,
  vs_WaveDecEnv, ps_CbaseAbase, ps_CalphaAbase, ps_CalphaAMult,
  ps_CalphaAadd, ps_CaddAbase, ps_CaddAMult, ps_CaddAAdd,
  ps_CmultAbase, ps_CmultAMult, ps_CmultAAdd, ps_WaveDecEnv,
  vs_WaveGraph2, ps_WaveGraph, vs_WaveGridFin, ps_WaveGrid,
  vs_BiasNormals, ps_BiasNormals, vs_ShoreLeave7, vs_WaveRip7,
  ps_MoreCosines, vs_WaveDec1Lay_7, vs_WaveDec2Lay11_7, vs_WaveDec2Lay12_7,
  vs_WaveDecEnv_7, vs_WaveFixedFin7, vs_GrassShader, ps_GrassShader,
  kNumShaders
}

Public Member Functions

 plShader ()
virtual void read (hsStream *S, plResManager *mgr)
virtual void write (hsStream *S, plResManager *mgr)
const std::vector
< plShaderConst > & 
getConsts () const
plShaderID getID () const
unsigned char getInput () const
unsigned char getOutput () const
void setConsts (const std::vector< plShaderConst > &consts)
void setID (plShaderID id)
void setInput (unsigned char input)
void setOutput (unsigned char output)
- 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

std::vector< plShaderConstfConsts
plShaderID fID
unsigned char fInput
unsigned char fOutput

Member Enumeration Documentation

Enumerator:
kUnregistered 
vs_WaveFixedFin6 
ps_WaveFixed 
vs_CompCosines 
ps_CompCosines 
vs_ShoreLeave6 
ps_ShoreLeave6 
vs_WaveRip 
ps_WaveRip 
vs_WaveDec1Lay 
vs_WaveDec2Lay11 
vs_WaveDec2Lay12 
vs_WaveDecEnv 
ps_CbaseAbase 
ps_CalphaAbase 
ps_CalphaAMult 
ps_CalphaAadd 
ps_CaddAbase 
ps_CaddAMult 
ps_CaddAAdd 
ps_CmultAbase 
ps_CmultAMult 
ps_CmultAAdd 
ps_WaveDecEnv 
vs_WaveGraph2 
ps_WaveGraph 
vs_WaveGridFin 
ps_WaveGrid 
vs_BiasNormals 
ps_BiasNormals 
vs_ShoreLeave7 
vs_WaveRip7 
ps_MoreCosines 
vs_WaveDec1Lay_7 
vs_WaveDec2Lay11_7 
vs_WaveDec2Lay12_7 
vs_WaveDecEnv_7 
vs_WaveFixedFin7 
vs_GrassShader 
ps_GrassShader 
kNumShaders 

Constructor & Destructor Documentation

plShader::plShader ( )

Member Function Documentation

const std::vector<plShaderConst>& plShader::getConsts ( ) const
plShaderID plShader::getID ( ) const
unsigned char plShader::getInput ( ) const
unsigned char plShader::getOutput ( ) const
virtual void plShader::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 plShader::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 plShader::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 plShader::setConsts ( const std::vector< plShaderConst > &  consts)
void plShader::setID ( plShaderID  id)
void plShader::setInput ( unsigned char  input)
void plShader::setOutput ( unsigned char  output)
virtual void plShader::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<plShaderConst> plShader::fConsts
protected
plShaderID plShader::fID
protected
unsigned char plShader::fInput
protected
unsigned char plShader::fOutput
protected

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