Sprite Class Reference
[Game Objects and Event Loop]

The basic Sprite class itself. More...

#include <sprite.h>

Inheritance diagram for Sprite:

[legend]Collaboration diagram for Sprite:


Public Member Functions
	Sprite ()
	Default constructor.
virtual	~Sprite ()
	Destructor, frees any owned data.
Overloadable virtual functions
Overload these functions to get non-default behaviors upon update, collision, frame advance, and SDL_USEREVENTs. If you don't overload Clone(), the copy it produces won't have any data other than that handled by Sprite, and none of the custom behavior of the parent.
virtual void	Update (Sint32 dtick)
	Calculates movement for the # of milliseconds.
virtual void	OnCollide (const Sprite *spr, ColType index)
	Called upon collision with another sprite.
virtual int	GetFrame ()
	Returns the current frame number.
virtual Sprite *	Clone ()
	Returns a clone of the current sprite.
virtual void	Event (int code, void data1=NULL, void data2=NULL)
	Called for SDL_USEREVENTs.
Position-related accessors
Position and velocity read and set operators.
SfxpCoord	Pos () const
	Current fixed point position coordinates.
SfxpCoord	Vel () const
	Current fixed point velocity vector.
void	ReverseXVelocity ()
	Completely reverses X direction.
void	ReverseYVelocity ()
	Completely reverses Y direction.
void	Preserve ()
	Saves previous fixed point coordinates.
void	MoveTo (Sfxp x, Sfxp y)
	Moves the sprite to a different position.
void	SetVel (SfxpCoord velin)
	Sets the sprite's velocity.
Rect	PrevRect () const
	Returns last frame's position rect.
Rect	CurRect () const
	Returns current frame's position rect.
Sfxp	VXfxp () const
	Returns fixed-point x velocity.
Sfxp	VYfxp () const
	Returns fixed-point y velicity.
Sfxp	Xfxp () const
	Returns fixed-point X position.
Sfxp	Yfxp () const
	Returns fixed-point Y position.
Flag-related accessor functions
Read and set sprite's flags.
void	Remove ()
	Marks a sprite as expired.
void	Tag ()
	Marks a sprite as moved.
int	OwnSurface () const
	Returns true if the sprite can free it's surface.
int	OwnBitmask () const
	Returns true if the sprite can free it's collision bitmasks.
SpriteFlag	SetFlags (const SpriteFlag flags)
	Sets flags in sprite.
int	Deleteable () const
	this is true when the sprite is deleteable
int	New () const
	This is true when the sprite is newly created, not having been drawn.
int	Moved () const
	Returns whether movement flag's been set.
void	Expire ()
	Marks the sprite as removable from a list.
int	Expired () const
	Returns true if the sprite is removable from a list.
const SpriteFlag	ClearFlags (const SpriteFlag flags)
	Clears flags in sprite.
const SpriteFlag	GetFlags () const
	Returns flags in sprite.
Collision-related accessors
Functions to check collisions and collision masks etc.
bool	CanCollide (Sprite *spr)
	Returns true if the 2 sprites collide, false otherwise.
bitmask *	GetBitmask ()
	Returns the current collision bitmask.
Uint8 const	GetColIndex ()
	Returns the collision index mask.
ColType const	GetColLayer ()
	Returns the collision layer mask.
Graphics-related accessors
Functions for framerate, drawing layers, source rectangles, etc
void	SetFrameRate (Sfxp frate)
	Sets the frame rate.
Sint16	DrawLayer () const
	Returns the sprite's drawing layer.
void	CalcFrame ()
	Calculate the source-rect for the current frame #.
Sprite data initialization functions
Functions that SpriteLoader uses to initialize sprite data after the constructor is called.
void	Draw (SDL_Surface *screen)
	Draws the sprite on the screen.
void	Draw (SDL_Surface *screen, Rect portion)
	Draws part of a sprite on the screen.
void	Init_Surface (SDL_Surface *surface=NULL, bool os_in=false)
	Initializes the sprite's surface member.
void	Init_Layers (Sint16 layer=0)
	Initializes the sprite's drawing layer.
void	Init_List (Sprite previn=NULL, Sprite nextin=NULL)
	Initializes the sprite's linked-list members.
void	Init_Flags (SpriteFlag flags=0)
	Initializes the sprite's status flags.
void	Init_Frames (int xframes=-1, int yframes=-1)
	Initializes the sprite's animation frames.
void	Init_Collision (ColType c_index=0, ColType c_layer=0)
	Initializes the sprite's collision masks.
void	Init_Bitmask (bool enable=false, bitmask **bmask_in=NULL)
	Initializes the sprite's collision masks.
Protected Attributes
SpriteFlag	flag
	Status flags.
Collision attributes
Here's how collision layers work. When two sprite's areas of draw overlap, it checks if (spr1->clayer&spr2->cindex) is nonzero and if (spr2->clayer&spr1->cindex) is nonzero. If so, it checks the collision bitmask if any.
bitmask **	bmask
	Collision bitmasks.
ColType	clayer
	Collision layer mask, the layers it can collide with.
ColType	cindex
	Collision layer index, the collision layer inhabited.
Image Attributes
The attributes that describe the sprite's image, framerate, drawing order, and current frame.
Sfxp	frame
	Current frame # in fixed point.
Sfxp	framerate
	Current framerate in fixed point.
Rect	frames
	x - x frames, y - y frames
SDL_Surface *	surface
	Image surface.
Rect	srcrect
	Source rectangle.
Sint16	drawlayer
	Higher #s get drawn first.
Motion attributes
Describes the sprite's current position, previous position, and current velocity.
SfxpCoord	pos
	Current position coordinates.
SfxpCoord	prevpos
	Previous position coordinates.
SfxpCoord	vel
	Velocity vector.
Linked-list attributes
Used by SpriteList
Sprite *	prev
	Linked-list prev/next pointers.
Sprite *	next
	Linked-list prev/next pointers.
Friends
class	SpriteList
	SpriteList has access to Sprite's private members.
class	SpriteManager
	SpriteManager has access to Sprite's private members.

Detailed Description

Don't be intimidated. Sure, it looks really complicated, but it's not. The vast majority of the functions contained herein are simple convenience functions for accessing the sprite's internal data.

Here's how it works. Each sprite has a set of collision attributes, image attributes, and motion attributes. Collision attributes determine what other sprites it can collide with, image attributes determine the image frames and framerate, and motion attributes describe it's current position and velocity. The member variable definitions describe what they do in good detail.

Definition at line 116 of file sprite.h.