Resource_BitmapStrip Class Reference
[Resources]

List of all members.

Public Member Functions
	Resource_BitmapStrip ()
	Resource_BitmapStrip (const BitmapStrip *bitmapStrip)
	Resource_BitmapStrip (const Bitmap *bitmap)
	Resource_BitmapStrip (const Filename &filename, int celCount=1)
	Resource_BitmapStrip (const char *filename, int celCount=1)
	Resource_BitmapStrip (StringId filename, int celCount=1)
	Resource_BitmapStrip (const Image &image)
	~Resource_BitmapStrip ()
	Resource_BitmapStrip (const Resource_BitmapStrip &resource)
	*** Copy Constructor ***
const Resource_BitmapStrip &	operator= (const Resource_BitmapStrip &resource)
const BitmapStrip &	GetBitmapStrip () const
const Bitmap &	GetBitmap () const
	operator const BitmapStrip & () const
	operator const Bitmap & () const
int	GetWidth (int cel=0) const
int	GetHeight (int cel=0) const
int	GetCelCount () const
const Bitmap &	GetCel (int index) const
void	Blit (Bitmap &target, int x, int y, unsigned short modulate=0xffff, unsigned char alpha=255, Bitmap::Transformation transformation=Bitmap::NoTransformation) const
void	Blit (int x1, int y1, int x2, int y2, Bitmap &target, int x, int y, unsigned short modulate=0xffff, unsigned char alpha=255, Bitmap::Transformation transformation=Bitmap::NoTransformation) const
void	Copy (Bitmap &target, int x, int y, unsigned short modulate=0xffff, Bitmap::Transformation transformation=Bitmap::NoTransformation) const
void	Copy (int x1, int y1, int x2, int y2, Bitmap &target, int x, int y, unsigned short modulate=0xffff, Bitmap::Transformation transformation=Bitmap::NoTransformation) const
void	Blit (int cel, Bitmap &target, int x, int y, unsigned short modulate=0xffff, unsigned char alpha=255, Bitmap::Transformation transformation=Bitmap::NoTransformation) const
void	Blit (int cel, int x1, int y1, int x2, int y2, Bitmap &target, int x, int y, unsigned short modulate=0xffff, unsigned char alpha=255, Bitmap::Transformation transformation=Bitmap::NoTransformation) const
void	Copy (int cel, Bitmap &target, int x, int y, unsigned short modulate=0xffff, Bitmap::Transformation transformation=Bitmap::NoTransformation) const
void	Copy (int cel, int x1, int y1, int x2, int y2, Bitmap &target, int x, int y, unsigned short modulate=0xffff, Bitmap::Transformation transformation=Bitmap::NoTransformation) const

---

Detailed Description

Author:

Mattias Gustavsson

Definition at line 25 of file Resource_BitmapStrip.h.

---

Constructor & Destructor Documentation

Resource_BitmapStrip::Resource_BitmapStrip

(

)

Definition at line 12 of file Resource_BitmapStrip.cpp.

Resource_BitmapStrip::Resource_BitmapStrip

(

const BitmapStrip *

bitmapStrip

)

Definition at line 19 of file Resource_BitmapStrip.cpp.

Resource_BitmapStrip::Resource_BitmapStrip

(

const Bitmap *

bitmap

)

Definition at line 27 of file Resource_BitmapStrip.cpp.

Resource_BitmapStrip::Resource_BitmapStrip	(	const Filename &	filename,
		int	celCount = 1
	)

Definition at line 40 of file Resource_BitmapStrip.cpp.

Resource_BitmapStrip::Resource_BitmapStrip	(	const char *	filename,
		int	celCount = 1
	)

Definition at line 53 of file Resource_BitmapStrip.cpp.

Resource_BitmapStrip::Resource_BitmapStrip	(	StringId	filename,
		int	celCount = 1
	)

Definition at line 70 of file Resource_BitmapStrip.cpp.

Resource_BitmapStrip::Resource_BitmapStrip

(

const Image &

image

)

Definition at line 84 of file Resource_BitmapStrip.cpp.

Resource_BitmapStrip::~Resource_BitmapStrip

(

)

Definition at line 97 of file Resource_BitmapStrip.cpp.

Resource_BitmapStrip::Resource_BitmapStrip

(

const Resource_BitmapStrip &

resource

)

*** Copy Constructor ***

Definition at line 108 of file Resource_BitmapStrip.cpp.

---

Member Function Documentation

const Resource_BitmapStrip & Resource_BitmapStrip::operator=

(

const Resource_BitmapStrip &

resource

)

Definition at line 120 of file Resource_BitmapStrip.cpp.

const BitmapStrip & Resource_BitmapStrip::GetBitmapStrip

(

)

const

Definition at line 137 of file Resource_BitmapStrip.cpp.

const Bitmap & Resource_BitmapStrip::GetBitmap

(

)

const

Definition at line 151 of file Resource_BitmapStrip.cpp.

Resource_BitmapStrip::operator const BitmapStrip &

(

)

const

Definition at line 165 of file Resource_BitmapStrip.cpp.

Resource_BitmapStrip::operator const Bitmap &

(

)

const

Definition at line 173 of file Resource_BitmapStrip.cpp.

int Resource_BitmapStrip::GetWidth

(

int

cel = 0

)

const

Definition at line 191 of file Resource_BitmapStrip.cpp.

int Resource_BitmapStrip::GetHeight

(

int

cel = 0

)

const

Definition at line 202 of file Resource_BitmapStrip.cpp.

int Resource_BitmapStrip::GetCelCount

(

)

const

Definition at line 178 of file Resource_BitmapStrip.cpp.

const Bitmap & Resource_BitmapStrip::GetCel

(

int

index

)

const

Definition at line 184 of file Resource_BitmapStrip.cpp.

void Resource_BitmapStrip::Blit	(	Bitmap &	target,
		int	x,
		int	y,
		unsigned short	modulate = 0xffff,
		unsigned char	alpha = 255,
		Bitmap::Transformation	transformation = Bitmap::NoTransformation
	)			const

This method will blit this bitmap onto the target bitmap at the specified coordinate. It will blit the entire bitmap onto the target, but it will perform clipping on the parts which are outside of the target.

Parameters:

	target	Target bitmap to blit this bitmap onto
	x	X-coordinate in the target bitmap. The top left corner of this bitmap will be drawn at this coordinate on the target bitmap
	y	Y-coordinate in the target bitmap. The top left corner of this bitmap will be drawn at this coordinate on the target bitmap
	modulate	16 bit color value (R5G6B5) to modulate the source pixels with before they are written.
	alpha	Level of transparency the bitmap will be written with. 0=Fully transparent, 255=Fully Opaque
	transformation	Specifies the desired transformation to use for this operation

Definition at line 213 of file Resource_BitmapStrip.cpp.

void Resource_BitmapStrip::Blit	(	int	x1,
		int	y1,
		int	x2,
		int	y2,
		Bitmap &	target,
		int	x,
		int	y,
		unsigned short	modulate = 0xffff,
		unsigned char	alpha = 255,
		Bitmap::Transformation	transformation = Bitmap::NoTransformation
	)			const

This method will blit a section of this bitmap onto the target bitmap at the specified coordinate. You specify the top-left and bottom-right coordinates of a rectangle you want to blit onto the target. Clipping will be performed on the parts which are outside of the target.

Parameters:

	x1	X-coordinate for the top-left corner of the section of this bitmap which is to be blitted onto the target
	y1	Y-coordinate for the top-left corner of the section of this bitmap which is to be blitted onto the target
	x2	X-coordinate for the bottom-right corner of the section of this bitmap which is to be blitted onto the target
	y2	Y-coordinate for the bottom-right corner of the section of this bitmap which is to be blitted onto the target
	target	Target bitmap to blit this bitmap onto
	x	X-coordinate in the target bitmap. The top left corner of the blitted section will be drawn at this coordinate on the target bitmap
	y	Y-coordinate in the target bitmap. The top left corner of the blitted section will be drawn at this coordinate on the target bitmap
	modulate	16 bit color value (R5G6B5) to modulate the source pixels with before they are written.
	alpha	Level of transparency the bitmap will be written with. 0=Fully transparent, 255=Fully Opaque
	transformation	Specifies the desired transformation to use for this operation

Definition at line 218 of file Resource_BitmapStrip.cpp.

void Resource_BitmapStrip::Copy	(	Bitmap &	target,
		int	x,
		int	y,
		unsigned short	modulate = 0xffff,
		Bitmap::Transformation	transformation = Bitmap::NoTransformation
	)			const

Parameters:

	target	Target bitmap to blit this bitmap onto
	x	X-coordinate in the target bitmap. The top left corner of this bitmap will be drawn at this coordinate on the target bitmap
	y	Y-coordinate in the target bitmap. The top left corner of this bitmap will be drawn at this coordinate on the target bitmap
	modulate	16 bit color value (R5G6B5) to modulate the source pixels with before they are written.
	transformation	Specifies the desired transformation to use for this operation

Definition at line 223 of file Resource_BitmapStrip.cpp.

void Resource_BitmapStrip::Copy	(	int	x1,
		int	y1,
		int	x2,
		int	y2,
		Bitmap &	target,
		int	x,
		int	y,
		unsigned short	modulate = 0xffff,
		Bitmap::Transformation	transformation = Bitmap::NoTransformation
	)			const

Parameters:

	x1	X-coordinate for the top-left corner of the section of this bitmap which is to be blitted onto the target
	y1	Y-coordinate for the top-left corner of the section of this bitmap which is to be blitted onto the target
	x2	X-coordinate for the bottom-right corner of the section of this bitmap which is to be blitted onto the target
	y2	Y-coordinate for the bottom-right corner of the section of this bitmap which is to be blitted onto the target
	target	Target bitmap to blit this bitmap onto
	x	X-coordinate in the target bitmap. The top left corner of the blitted section will be drawn at this coordinate on the target bitmap
	y	Y-coordinate in the target bitmap. The top left corner of the blitted section will be drawn at this coordinate on the target bitmap
	modulate	16 bit color value (R5G6B5) to modulate the source pixels with before they are written.
	transformation	Specifies the desired transformation to use for this operation

Definition at line 228 of file Resource_BitmapStrip.cpp.

void Resource_BitmapStrip::Blit	(	int	cel,
		Bitmap &	target,
		int	x,
		int	y,
		unsigned short	modulate = 0xffff,
		unsigned char	alpha = 255,
		Bitmap::Transformation	transformation = Bitmap::NoTransformation
	)			const

This method will blit this bitmap onto the target bitmap at the specified coordinate. It will blit the entire bitmap onto the target, but it will perform clipping on the parts which are outside of the target.

Parameters:

	target	Target bitmap to blit this bitmap onto
	x	X-coordinate in the target bitmap. The top left corner of this bitmap will be drawn at this coordinate on the target bitmap
	y	Y-coordinate in the target bitmap. The top left corner of this bitmap will be drawn at this coordinate on the target bitmap
	modulate	16 bit color value (R5G6B5) to modulate the source pixels with before they are written.
	alpha	Level of transparency the bitmap will be written with. 0=Fully transparent, 255=Fully Opaque
	transformation	Specifies the desired transformation to use for this operation

Definition at line 234 of file Resource_BitmapStrip.cpp.

void Resource_BitmapStrip::Blit	(	int	cel,
		int	x1,
		int	y1,
		int	x2,
		int	y2,
		Bitmap &	target,
		int	x,
		int	y,
		unsigned short	modulate = 0xffff,
		unsigned char	alpha = 255,
		Bitmap::Transformation	transformation = Bitmap::NoTransformation
	)			const

This method will blit a section of this bitmap onto the target bitmap at the specified coordinate. You specify the top-left and bottom-right coordinates of a rectangle you want to blit onto the target. Clipping will be performed on the parts which are outside of the target.

Parameters:

	x1	X-coordinate for the top-left corner of the section of this bitmap which is to be blitted onto the target
	y1	Y-coordinate for the top-left corner of the section of this bitmap which is to be blitted onto the target
	x2	X-coordinate for the bottom-right corner of the section of this bitmap which is to be blitted onto the target
	y2	Y-coordinate for the bottom-right corner of the section of this bitmap which is to be blitted onto the target
	target	Target bitmap to blit this bitmap onto
	x	X-coordinate in the target bitmap. The top left corner of the blitted section will be drawn at this coordinate on the target bitmap
	y	Y-coordinate in the target bitmap. The top left corner of the blitted section will be drawn at this coordinate on the target bitmap
	modulate	16 bit color value (R5G6B5) to modulate the source pixels with before they are written.
	alpha	Level of transparency the bitmap will be written with. 0=Fully transparent, 255=Fully Opaque
	transformation	Specifies the desired transformation to use for this operation

Definition at line 244 of file Resource_BitmapStrip.cpp.

void Resource_BitmapStrip::Copy	(	int	cel,
		Bitmap &	target,
		int	x,
		int	y,
		unsigned short	modulate = 0xffff,
		Bitmap::Transformation	transformation = Bitmap::NoTransformation
	)			const

Parameters:

	target	Target bitmap to blit this bitmap onto
	x	X-coordinate in the target bitmap. The top left corner of this bitmap will be drawn at this coordinate on the target bitmap
	y	Y-coordinate in the target bitmap. The top left corner of this bitmap will be drawn at this coordinate on the target bitmap
	modulate	16 bit color value (R5G6B5) to modulate the source pixels with before they are written.
	transformation	Specifies the desired transformation to use for this operation

Definition at line 254 of file Resource_BitmapStrip.cpp.

void Resource_BitmapStrip::Copy	(	int	cel,
		int	x1,
		int	y1,
		int	x2,
		int	y2,
		Bitmap &	target,
		int	x,
		int	y,
		unsigned short	modulate = 0xffff,
		Bitmap::Transformation	transformation = Bitmap::NoTransformation
	)			const

Parameters:

	x1	X-coordinate for the top-left corner of the section of this bitmap which is to be blitted onto the target
	y1	Y-coordinate for the top-left corner of the section of this bitmap which is to be blitted onto the target
	x2	X-coordinate for the bottom-right corner of the section of this bitmap which is to be blitted onto the target
	y2	Y-coordinate for the bottom-right corner of the section of this bitmap which is to be blitted onto the target
	target	Target bitmap to blit this bitmap onto
	x	X-coordinate in the target bitmap. The top left corner of the blitted section will be drawn at this coordinate on the target bitmap
	y	Y-coordinate in the target bitmap. The top left corner of the blitted section will be drawn at this coordinate on the target bitmap
	modulate	16 bit color value (R5G6B5) to modulate the source pixels with before they are written.
	transformation	Specifies the desired transformation to use for this operation

Definition at line 264 of file Resource_BitmapStrip.cpp.