RVC::STYLEPATTERN_BITMAP Class Reference

Bitmap pattern class. More...

#include <rvc/stylepatternbitmap.h>

Inheritance diagram for RVC::STYLEPATTERN_BITMAP:

[legend]

List of all members.

Public Member Functions
	STYLEPATTERN_BITMAP (const STYLEPATTERN_BITMAP &rhs)
	STYLEPATTERN_BITMAP (const void *buf, INT32 NumBytes)
	STYLEPATTERN_BITMAP ()
virtual	~STYLEPATTERN_BITMAP ()
ERRVALUE	Create (INT16 xsize, INT16 ysize, bool bRGBA=false)
void	GetCell (INT16 x, INT16 y, COLOR &color) const
UINT8	GetCell (INT16 x, INT16 y) const
INT16	GetHotSpotX () const
INT16	GetHotSpotY () const
INT16	GetIntervalX () const
INT16	GetIntervalY () const
UINT8 *	GetRowData (INT16 y)
const UINT8 *	GetRowData (INT16 y) const
INT16	GetSizeX () const
INT16	GetSizeY () const
ERRVALUE	Import (SPATMOD::IMAGE::STAGE &Source)
bool	IsRGBA () const
STYLEPATTERN_BITMAP &	operator= (const STYLEPATTERN_BITMAP &rhs)
void	SetCell (INT16 x, INT16 y, const COLOR &value)
void	SetCell (INT16 x, INT16 y, UINT8 value)
void	SetHotSpotX (INT16 hotspotx)
void	SetHotSpotY (INT16 hotspoty)
void	SetIntervalX (INT16 intervalx)
void	SetIntervalY (INT16 intervaly)

---

Detailed Description

Bitmap pattern class.

---

Constructor & Destructor Documentation

RVC::STYLEPATTERN_BITMAP::STYLEPATTERN_BITMAP

(

)

[inline]

Default constructor.

RVC::STYLEPATTERN_BITMAP::STYLEPATTERN_BITMAP	(	const void *	buf,
		INT32	NumBytes
	)			[inline]

Constructor from raw pattern data.

RVC::STYLEPATTERN_BITMAP::STYLEPATTERN_BITMAP

(

const STYLEPATTERN_BITMAP &

rhs

)

[inline]

Copy constructor.

virtual RVC::STYLEPATTERN_BITMAP::~STYLEPATTERN_BITMAP

(

)

[inline, virtual]

Destructor.

---

Member Function Documentation

ERRVALUE RVC::STYLEPATTERN_BITMAP::Create	(	INT16	xsize,
		INT16	ysize,
		bool	bRGBA = false
	)

Create a bitmap pattern.

By default, bitmap patterns are 8-bit colormapped patterns. If bRGBA is true, then the pattern will be created as an RGBA pattern

void RVC::STYLEPATTERN_BITMAP::GetCell	(	INT16	x,
		INT16	y,
		COLOR &	color
	)			const [inline]

Get the value of a given cell.

Note: this assumes an RGBA pattern and will not work for 8-bit patterns

UINT8 RVC::STYLEPATTERN_BITMAP::GetCell	(	INT16	x,
		INT16	y
	)			const [inline]

Get the value of a given cell.

Note: this assumes an 8-bit colormapped pattern

INT16 RVC::STYLEPATTERN_BITMAP::GetHotSpotX

(

)

const [inline]

INT16 RVC::STYLEPATTERN_BITMAP::GetHotSpotY

(

)

const [inline]

INT16 RVC::STYLEPATTERN_BITMAP::GetIntervalX

(

)

const [inline]

INT16 RVC::STYLEPATTERN_BITMAP::GetIntervalY

(

)

const [inline]

UINT8* RVC::STYLEPATTERN_BITMAP::GetRowData

(

INT16

y

)

[inline]

Get the data for a given row.

If the pattern is RGBA, this will return a pointer to RGBA data, otherwise it will return a pointer to 8-bit colormapped data

const UINT8* RVC::STYLEPATTERN_BITMAP::GetRowData

(

INT16

y

)

const [inline]

Get the data for a given row.

If the pattern is RGBA, this will return a pointer to RGBA data, otherwise it will return a pointer to 8-bit colormapped data

INT16 RVC::STYLEPATTERN_BITMAP::GetSizeX

(

)

const [inline]

INT16 RVC::STYLEPATTERN_BITMAP::GetSizeY

(

)

const [inline]

ERRVALUE RVC::STYLEPATTERN_BITMAP::Import

(

SPATMOD::IMAGE::STAGE &

Source

)

Import a bitmap from any SPATMOD::IMAGE::STAGE.

The Source should be Initalize()ed first. The Source may not be larger than 32K by 32K. This method will not set the name of the STYLEPATTERN_BITMAP. You should do that based on the filename or user-entered name.

bool RVC::STYLEPATTERN_BITMAP::IsRGBA

(

)

const [inline]

Determine if this bitmap pattern is RGBA or 8-bit colormapped If it's RGBA, GetNumColors() will return -1.

STYLEPATTERN_BITMAP& RVC::STYLEPATTERN_BITMAP::operator=

(

const STYLEPATTERN_BITMAP &

rhs

)

[inline]

Assignment.

Reimplemented from RVC::STYLEPATTERN_BASE.

void RVC::STYLEPATTERN_BITMAP::SetCell	(	INT16	x,
		INT16	y,
		const COLOR &	value
	)			[inline]

Set the pixel value of a given cell Note: this assumes an RGBA pattern and will not work for 8-bit patterns.

void RVC::STYLEPATTERN_BITMAP::SetCell	(	INT16	x,
		INT16	y,
		UINT8	value
	)			[inline]

Set the pixel value of a given cell Note: this assumes an 8-bit colormapped pattern.

void RVC::STYLEPATTERN_BITMAP::SetHotSpotX

(

INT16

hotspotx

)

[inline]

void RVC::STYLEPATTERN_BITMAP::SetHotSpotY

(

INT16

hotspoty

)

[inline]

void RVC::STYLEPATTERN_BITMAP::SetIntervalX

(

INT16

intervalx

)

[inline]

void RVC::STYLEPATTERN_BITMAP::SetIntervalY

(

INT16

intervaly

)

[inline]

---

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

• rvc/stylepatternbitmap.h