SpriteRec Struct Reference

sprite data structure More...

#include <Sprite.h>

List of all members.

Public Attributes
SpriteLayerPtr	parentSpriteLayerP
	the sprite layer this sprite is currently in
SpritePtr	nextSpriteP
	next sprite in that layer
SpritePtr	prevSpriteP
	previous sprite in that layer
SpritePtr	nextActiveSpriteP
	next active sprite in the SpriteWorld
SpritePtr	nextIdleSpriteP
	next idle sprite in the SpriteWorld
SWBoolean	isVisible
	draw the sprite?
SWBoolean	needsToBeDrawn
	sprite has changed, needs to be drawn
SWBoolean	needsToBeErased
	sprite needs to be erased onscreen
SWBoolean	doFastMovingCheck
	used by SWAnimateSpriteWorld
SWRect	destFrameRect
	frame destination rectangle
SWRect	oldFrameRect
	last frame destination rectangle
SWRect	deltaFrameRect
	union of the sprite's lastRect and curRect
short	tileDepth
	the tile layers this sprite is under
DrawProcPtr	frameDrawProc
	callback to draw sprite normally
SWBoolean	destRectIsVisible
	is destOffscreenRect visible on screen?
SWBoolean	oldRectIsVisible
	was any part of the Sprite on the screen last frame?
SWRect	clippedSourceRect
	source sprite frame rect after clipping
SWRect	destOffscreenRect
	sprite's dest rect after clipping and offset frame fields
FramePtr *	frameArray
	array of frames
FramePtr	curFrameP
	current frame
long	numFrames
	number of frames
long	maxFrames
	maximum number of frames
long	frameTimeInterval
	time interval to advance frame
unsigned long	timeOfLastFrameChange
	time (from runningTimeCount) frame was last changed
long	frameAdvance
	amount to adjust frame index
long	curFrameIndex
	current frame index
long	firstFrameIndex
	first frame to advance
long	lastFrameIndex
	last frame to advance
FrameProcPtr	frameChangeProc
	callback to change frames
long	moveTimeInterval
	time interval to move sprite
unsigned long	timeOfLastMove
	time (from runningTimeCount) sprite was last moved
double	pseudoMoveTimeInterval
	used for time-based animation
double	moveTimeAccum
	used to set the moveProcHasFired variable.
SWBoolean	moveProcHasFired
	used in time-based animations.
SWRect	moveBoundsRect
	bounds of the sprite's movement
MoveProcPtr	spriteMoveProc
	callback to handle movement
MoveProcPtr	realSpriteMoveProc
	see SWTempSpriteMoveProc for more info.
CollideProcPtr	spriteCollideProc
	callback to handle collisions
AdvanceType	frameAdvanceMode
	mode of automatic frame advancement
RemovalType	spriteRemoval
	whether to remove sprite, and if so, how.
SDL_Surface *	sharedSurface
	if common surface is used for frames, here it is
DrawDataPtr	drawData
	has various drawing style attributes
long	userData
	reserved for user

---

Detailed Description

sprite data structure

---

Member Data Documentation

SWRect SpriteRec::clippedSourceRect

source sprite frame rect after clipping

long SpriteRec::curFrameIndex

current frame index

FramePtr SpriteRec::curFrameP

current frame

SWRect SpriteRec::deltaFrameRect

union of the sprite's lastRect and curRect

SWRect SpriteRec::destFrameRect

frame destination rectangle

SWRect SpriteRec::destOffscreenRect

sprite's dest rect after clipping and offset frame fields

SWBoolean SpriteRec::destRectIsVisible

is destOffscreenRect visible on screen?

SWBoolean SpriteRec::doFastMovingCheck

used by SWAnimateSpriteWorld

DrawDataPtr SpriteRec::drawData

has various drawing style attributes

long SpriteRec::firstFrameIndex

first frame to advance

long SpriteRec::frameAdvance

amount to adjust frame index

AdvanceType SpriteRec::frameAdvanceMode

mode of automatic frame advancement

FramePtr* SpriteRec::frameArray

array of frames

FrameProcPtr SpriteRec::frameChangeProc

callback to change frames

DrawProcPtr SpriteRec::frameDrawProc

callback to draw sprite normally

long SpriteRec::frameTimeInterval

time interval to advance frame

SWBoolean SpriteRec::isVisible

draw the sprite?

long SpriteRec::lastFrameIndex

last frame to advance

long SpriteRec::maxFrames

maximum number of frames

SWRect SpriteRec::moveBoundsRect

bounds of the sprite's movement

SWBoolean SpriteRec::moveProcHasFired

used in time-based animations.

double SpriteRec::moveTimeAccum

used to set the moveProcHasFired variable.

long SpriteRec::moveTimeInterval

time interval to move sprite

SWBoolean SpriteRec::needsToBeDrawn

sprite has changed, needs to be drawn

SWBoolean SpriteRec::needsToBeErased

sprite needs to be erased onscreen

SpritePtr SpriteRec::nextActiveSpriteP

next active sprite in the SpriteWorld

SpritePtr SpriteRec::nextIdleSpriteP

next idle sprite in the SpriteWorld

SpritePtr SpriteRec::nextSpriteP

next sprite in that layer

long SpriteRec::numFrames

number of frames

SWRect SpriteRec::oldFrameRect

last frame destination rectangle

SWBoolean SpriteRec::oldRectIsVisible

was any part of the Sprite on the screen last frame?

SpriteLayerPtr SpriteRec::parentSpriteLayerP

the sprite layer this sprite is currently in

SpritePtr SpriteRec::prevSpriteP

previous sprite in that layer

double SpriteRec::pseudoMoveTimeInterval

used for time-based animation

MoveProcPtr SpriteRec::realSpriteMoveProc

see SWTempSpriteMoveProc for more info.

SDL_Surface* SpriteRec::sharedSurface

if common surface is used for frames, here it is

CollideProcPtr SpriteRec::spriteCollideProc

callback to handle collisions

MoveProcPtr SpriteRec::spriteMoveProc

callback to handle movement

RemovalType SpriteRec::spriteRemoval

whether to remove sprite, and if so, how.

short SpriteRec::tileDepth

the tile layers this sprite is under

unsigned long SpriteRec::timeOfLastFrameChange

time (from runningTimeCount) frame was last changed

unsigned long SpriteRec::timeOfLastMove

time (from runningTimeCount) sprite was last moved

long SpriteRec::userData

reserved for user

---