plDynamicEnvMap Class Reference

#include <plDynamicEnvMap.h>

Inheritance diagram for plDynamicEnvMap:

Public Member Functions
	plDynamicEnvMap ()
virtual void	read (hsStream *S, plResManager *mgr)
virtual void	write (hsStream *S, plResManager *mgr)
Public Member Functions inherited from plCubicRenderTarget
plRenderTarget *	getFace (size_t which)
Public Member Functions inherited from plRenderTarget
	plRenderTarget ()
void	readData (hsStream *S)
void	writeData (hsStream *S)
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)

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

Protected Attributes
plKey	fRootNode
hsVector3	fPos
float	fHither
float	fYon
float	fFogStart
hsColorRGBA	fColor
float	fRefreshRate
std::vector< plKey >	fVisRegions
std::vector< plString >	fVisRegionNames
int	fIncCharacters
Protected Attributes inherited from plCubicRenderTarget
plRenderTarget	fFaces [6]
Protected Attributes inherited from plRenderTarget
unsigned short	fWidth
unsigned short	fHeight
union {
struct {
unsigned short   fLeft
unsigned short   fTop
unsigned short   fRight
unsigned short   fBottom
}   fAbsolute
struct {
float   fLeft
float   fTop
float   fRight
float   fBottom
}   fProportional
}	fViewport
bool	fProportionalViewport
unsigned char	fZDepth
unsigned char	fStencilDepth
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

Additional Inherited Members
Public Types inherited from plCubicRenderTarget
enum	Faces {   kLeftFace, kRightFace, kFrontFace, kBackFace,   kTopFace, kBottomFace }
Static Public Attributes inherited from plBitmap
static const char *	kCompressionTypeNames []
static const char *	kSpaceNames []
static const char *	kUncompressedTypeNames []
static const char *	kCompressedTypeNames []

Constructor & Destructor Documentation

plDynamicEnvMap::plDynamicEnvMap

(

)

Member Function Documentation

virtual void plDynamicEnvMap::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 plCubicRenderTarget.

virtual void plDynamicEnvMap::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 plCubicRenderTarget.

virtual void plDynamicEnvMap::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 plCubicRenderTarget.

virtual void plDynamicEnvMap::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 plCubicRenderTarget.

Member Data Documentation

hsColorRGBA plDynamicEnvMap::fColor

protected

float plDynamicEnvMap::fFogStart

protected

float plDynamicEnvMap::fHither

protected

int plDynamicEnvMap::fIncCharacters

protected

hsVector3 plDynamicEnvMap::fPos

protected

float plDynamicEnvMap::fRefreshRate

protected

plKey plDynamicEnvMap::fRootNode

protected

std::vector<plString> plDynamicEnvMap::fVisRegionNames

protected

std::vector<plKey> plDynamicEnvMap::fVisRegions

protected

float plDynamicEnvMap::fYon

protected

---

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

• core/PRP/Surface/plDynamicEnvMap.h