#include <plDynamicTextMap.h>

Inheritance diagram for plDynamicTextMap:

Public Types
enum	Justify { kLeftJustify, kCenter, kRightJustify }
enum	DrawMethods { kImgNoAlpha, kImgBlend, kImgSprite }
enum	FontFlags { kFontBold = 0x1, kFontItalic = 0x2, kFontShadowed = 0x4 }
Public Types inherited from plMipmap
enum	{ kColorDataRLE = 0x1, kAlphaDataRLE = 0x2 }
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
	plDynamicTextMap ()
virtual	~plDynamicTextMap ()
void	Create (unsigned int width, unsigned int height, bool hasAlpha, unsigned int extraWidth, unsigned int extraHeight)
virtual void	read (hsStream S, plResManager mgr)
virtual void	write (hsStream S, plResManager mgr)
unsigned int	getVisWidth () const
unsigned int	getVisHeight () const
bool	hasAlpha () const
size_t	getInitBufferSize () const
const unsigned int *	getInitBuffer () const
void	setVisWidth (unsigned int width)
void	setVisHeight (unsigned int height)
void	setHasAlpha (bool hasAlpha)
void	setInitBuffer (const unsigned int *buffer, size_t size)
Public Member Functions inherited from plMipmap
	plMipmap ()
	plMipmap (unsigned int width, unsigned int height, unsigned char numLevels, unsigned char compType, ColorFormat format, unsigned char dxtLevel=kDXTError)
virtual	~plMipmap ()
void	Create (unsigned int width, unsigned int height, unsigned char numLevels, unsigned char compType, ColorFormat format, unsigned char dxtLevel=kDXTError)
void	CopyFrom (plMipmap *src)
void	readData (hsStream *S)
void	writeData (hsStream *S)
unsigned int	getWidth () const
unsigned int	getHeight () const
const void *	getImageData () const
size_t	getTotalSize () const
size_t	getNumLevels () const
unsigned int	getLevelSize (size_t idx) const
unsigned int	getLevelWidth (size_t idx) const
unsigned int	getLevelHeight (size_t idx) const
const void *	getLevelData (size_t idx) const
size_t	getJpegSize () const
size_t	getJpegAlphaSize () const
const void *	getJpegImage () const
const void *	getJpegAlpha () const
void	setImageData (const void *data, size_t size)
void	setLevelData (size_t idx, const void *data, size_t size)
void	setImageJPEG (const void *data, size_t size)
void	setAlphaJPEG (const void *data, size_t size)
void	setColorData (const void *data, size_t size)
void	setAlphaData (const void *alpha, size_t size)
void	extractColorData (void *buffer, size_t size) const
void	extractAlphaData (void *buffer, size_t size) const
bool	isImageJPEG () const
bool	isAlphaJPEG () const
size_t	GetUncompressedSize (size_t level) const
void	DecompressImage (size_t level, void *dest, size_t size)
void	CompressImage (size_t level, void *src, size_t size)
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 Member Functions inherited from plMipmap
void	IRead (hsStream *S)
void	IWrite (hsStream *S)
size_t	IBuildLevelSizes ()
void	IReadJPEGImage (hsStream *S)
void	IReadRawImage (hsStream *S)
void	IReadRLEImage (hsStream *S, bool alpha)
void	IWriteJPEGImage (hsStream *S)
void	IWriteRawImage (hsStream *S)
void	IWriteRLEImage (hsStream *S, bool alpha)

Protected Attributes
unsigned int	fVisWidth
unsigned int	fVisHeight
bool	fHasAlpha
bool	fHasBeenCreated
unsigned int *	fInitBuffer
size_t	fInitBufferLen
Protected Attributes inherited from plMipmap
unsigned char *	fImageData
size_t	fTotalSize
unsigned char *	fJPEGData
size_t	fJPEGSize
unsigned char *	fJAlphaData
size_t	fJAlphaSize
unsigned int	fWidth
unsigned int	fHeight
unsigned int	fStride
std::vector< LevelData >	fLevelData
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
Static Public Attributes inherited from plBitmap
static const char *	kCompressionTypeNames []
static const char *	kSpaceNames []
static const char *	kUncompressedTypeNames []
static const char *	kCompressedTypeNames []

Member Enumeration Documentation

enum plDynamicTextMap::DrawMethods

Enumerator:

kImgNoAlpha
kImgBlend
kImgSprite

enum plDynamicTextMap::FontFlags

Enumerator:

kFontBold
kFontItalic
kFontShadowed

enum plDynamicTextMap::Justify

Enumerator:

kLeftJustify
kCenter
kRightJustify

Constructor & Destructor Documentation

plDynamicTextMap::plDynamicTextMap ( )

virtual plDynamicTextMap::~plDynamicTextMap ( )

virtual

Member Function Documentation

void plDynamicTextMap::Create	(	unsigned int	width,
		unsigned int	height,
		bool	hasAlpha,
		unsigned int	extraWidth,
		unsigned int	extraHeight
	)

const unsigned int* plDynamicTextMap::getInitBuffer ( ) const

size_t plDynamicTextMap::getInitBufferSize ( ) const

unsigned int plDynamicTextMap::getVisHeight ( ) const

unsigned int plDynamicTextMap::getVisWidth ( ) const

bool plDynamicTextMap::hasAlpha ( ) const

virtual void plDynamicTextMap::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 plMipmap.

virtual void plDynamicTextMap::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 plMipmap.

virtual void plDynamicTextMap::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 plMipmap.

void plDynamicTextMap::setHasAlpha ( bool hasAlpha )

void plDynamicTextMap::setInitBuffer	(	const unsigned int *	buffer,
		size_t	size
	)

void plDynamicTextMap::setVisHeight ( unsigned int height )

void plDynamicTextMap::setVisWidth ( unsigned int width )

virtual void plDynamicTextMap::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 plMipmap.

Member Data Documentation

bool plDynamicTextMap::fHasAlpha

protected

bool plDynamicTextMap::fHasBeenCreated

protected

unsigned int* plDynamicTextMap::fInitBuffer

protected

size_t plDynamicTextMap::fInitBufferLen

protected

unsigned int plDynamicTextMap::fVisHeight

protected

unsigned int plDynamicTextMap::fVisWidth

protected

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

core/PRP/Surface/plDynamicTextMap.h

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation