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

#include <plCubicEnvironmap.h>

Inheritance diagram for plCubicEnvironmap:
plBitmap hsKeyedObject plCreatable

Public Types

enum  Faces {
  kLeftFace, kRightFace, kFrontFace, kBackFace,
  kTopFace, kBottomFace, kNumFaces
}
- Public Types inherited from plBitmap
enum  Flags {
  kAlphaChannelFlag = 0x1, kAlphaBitFlag = 0x2, kBumpEnvMap = 0x4, kForce32Bit = 0x8,
  kDontThrowAwayImage = 0x10, kForceOneMipLevel = 0x20, kNoMaxSize = 0x40, kIntensityMap = 0x80,
  kHalfSize = 0x100, kUserOwnsBitmap = 0x200, kForceRewrite = 0x400, kForceNonCompressed = 0x800,
  kIsTexture = 0x1000, kIsOffscreen = 0x2000, kIsProjected = 0x4000, kIsOrtho = 0x8000
}
enum  CompressionType { kUncompressed, kDirectXCompression, kJPEGCompression }
enum  ColorSpace { kNoSpace, kDirectSpace, kGraySpace, kIndexSpace }
enum  DxtType {
  kDXTError, kDXT1, kDXT2_UNUSED, kDXT3,
  kDXT4_UNUSED, kDXT5
}
enum  ColorFormat {
  kRGB8888, kRGB4444, kRGB1555, kInten8,
  kAInten88
}

Public Member Functions

virtual void read (hsStream *S, plResManager *mgr)
virtual void write (hsStream *S, plResManager *mgr)
plMipmapgetFace (size_t idx)
- Public Member Functions inherited from plBitmap
 plBitmap ()
void setConfig (ColorFormat format)
unsigned char getBPP () const
unsigned char getSpace () const
unsigned short getFlags () const
unsigned char getCompressionType () const
unsigned char getDXCompression () const
unsigned char getDXBlockSize () const
unsigned char getARGBType () const
unsigned int getLowModTime () const
unsigned int getHighModTime () const
void setBPP (unsigned char bpp)
void setSpace (unsigned char space)
void setFlags (unsigned short flags)
void setCompressionType (unsigned char type)
void setDXCompression (unsigned char type)
void setDXBlockSize (unsigned char size)
void setARGBType (unsigned char type)
void setModTime (unsigned int low, unsigned int high)
- 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)

Static Public Attributes

static const char * kFaceNames [kNumFaces]
- Static Public Attributes inherited from plBitmap
static const char * kCompressionTypeNames []
static const char * kSpaceNames []
static const char * kUncompressedTypeNames []
static const char * kCompressedTypeNames []

Protected Member Functions

virtual void IPrcWrite (pfPrcHelper *prc)
virtual void IPrcParse (const pfPrcTag *tag, plResManager *mgr)
- Protected Member Functions inherited from plBitmap
void IRead (hsStream *S)
void IWrite (hsStream *S)

Protected Attributes

plMipmap fFaces [kNumFaces]
- Protected Attributes inherited from plBitmap
unsigned char fPixelSize
unsigned char fSpace
unsigned short fFlags
unsigned char fCompressionType
union {
   DirectXInfo   fDXInfo
   UncompressedInfo   fUncompressedInfo
}; 
unsigned int fLowModTime
unsigned int fHighModTime

Member Enumeration Documentation

Enumerator:
kLeftFace 
kRightFace 
kFrontFace 
kBackFace 
kTopFace 
kBottomFace 
kNumFaces 

Member Function Documentation

plMipmap* plCubicEnvironmap::getFace ( size_t  idx)
virtual void plCubicEnvironmap::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 plBitmap.

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

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

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

Member Data Documentation

plMipmap plCubicEnvironmap::fFaces[kNumFaces]
protected
const char* plCubicEnvironmap::kFaceNames[kNumFaces]
static

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