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

#include <plStateDescriptor.h>

Public Types

enum  Type {
  kNone = 0xFF, kInt = 0, kFloat, kBool,
  kString, kKey, kStateDescriptor, kCreatable,
  kDouble, kTime, kByte, kShort,
  kAgeTimeOfDay, kVector3 = 50, kPoint3, kRGB,
  kRGBA, kQuaternion, kRGB8, kRGBA8,
  kUint, kChar, kMatrix44, kBuffer,
  kAgeTimeElapsed, kGameTimeElapsed
}
enum  Flags { kInternal = 0x1, kAlwaysNew = 0x2, kVariableLength = 0x4 }

Public Member Functions

 plVarDescriptor ()
void read (hsStream *S)
void write (hsStream *S)
plString getName () const
plString getDefault () const
plString getDisplay () const
size_t getCount () const
Type getType () const
plString getStateDescType () const
int getStateDescVer () const
plStateDescriptorgetStateDesc () const
bool isInternal () const
bool isAlwaysNew () const
bool isVariableLength () const
bool isValid () const
void setName (const plString &name)
void setDefault (const plString &def)
void setDisplay (const plString &disp)
void setCount (size_t count)
void setType (Type type)
void setStateDescType (const plString &type)
void setStateDescVer (int ver)
void setStateDesc (plStateDescriptor *desc)
void setInternal (bool internal)
void setAlwaysNew (bool alwaysNew)
void setVariableLength (bool varLength)

Static Public Member Functions

static Type GetTypeFromString (const plString &type, bool isEoa)

Protected Attributes

plString fName
plString fDefault
plString fDisplay
size_t fCount
Type fType
unsigned int fFlags
plString fStateDescType
int fStateDescVer
class plStateDescriptorfStateDesc

Member Enumeration Documentation

Enumerator:
kInternal 
kAlwaysNew 
kVariableLength 
Enumerator:
kNone 
kInt 
kFloat 
kBool 
kString 
kKey 
kStateDescriptor 
kCreatable 
kDouble 
kTime 
kByte 
kShort 
kAgeTimeOfDay 
kVector3 
kPoint3 
kRGB 
kRGBA 
kQuaternion 
kRGB8 
kRGBA8 
kUint 
kChar 
kMatrix44 
kBuffer 
kAgeTimeElapsed 
kGameTimeElapsed 

Constructor & Destructor Documentation

plVarDescriptor::plVarDescriptor ( )

Member Function Documentation

size_t plVarDescriptor::getCount ( ) const
plString plVarDescriptor::getDefault ( ) const
plString plVarDescriptor::getDisplay ( ) const
plString plVarDescriptor::getName ( ) const
plStateDescriptor* plVarDescriptor::getStateDesc ( ) const
plString plVarDescriptor::getStateDescType ( ) const
int plVarDescriptor::getStateDescVer ( ) const
Type plVarDescriptor::getType ( ) const
static Type plVarDescriptor::GetTypeFromString ( const plString type,
bool  isEoa 
)
static
bool plVarDescriptor::isAlwaysNew ( ) const
bool plVarDescriptor::isInternal ( ) const
bool plVarDescriptor::isValid ( ) const
bool plVarDescriptor::isVariableLength ( ) const
void plVarDescriptor::read ( hsStream S)
void plVarDescriptor::setAlwaysNew ( bool  alwaysNew)
void plVarDescriptor::setCount ( size_t  count)
void plVarDescriptor::setDefault ( const plString def)
void plVarDescriptor::setDisplay ( const plString disp)
void plVarDescriptor::setInternal ( bool  internal)
void plVarDescriptor::setName ( const plString name)
void plVarDescriptor::setStateDesc ( plStateDescriptor desc)
void plVarDescriptor::setStateDescType ( const plString type)
void plVarDescriptor::setStateDescVer ( int  ver)
void plVarDescriptor::setType ( Type  type)
void plVarDescriptor::setVariableLength ( bool  varLength)
void plVarDescriptor::write ( hsStream S)

Member Data Documentation

size_t plVarDescriptor::fCount
protected
plString plVarDescriptor::fDefault
protected
plString plVarDescriptor::fDisplay
protected
unsigned int plVarDescriptor::fFlags
protected
plString plVarDescriptor::fName
protected
class plStateDescriptor* plVarDescriptor::fStateDesc
protected
plString plVarDescriptor::fStateDescType
protected
int plVarDescriptor::fStateDescVer
protected
Type plVarDescriptor::fType
protected

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