Headers/Sprite.h File Reference

constants, structures, and function prototypes for sprites More...

#include <SWCommonHeaders.h>
#include <SpriteCreation.h>
#include <SpriteFrame.h>
#include "Sprite.hpp"

Classes

struct  SpriteRec
 sprite data structure More...

Typedefs

typedef void(* FrameProcPtr )(SpritePtr srcSpriteP, FramePtr curFrameP, long *frameIndex)
typedef void(* DrawProcPtr )(FramePtr srcFrameP, FramePtr dstFrameP, SWRect *srcRect, SWRect *dstRect)
typedef void(* MoveProcPtr )(SpritePtr srcSpriteP)
typedef void(* CollideProcPtr )(SpritePtr srcSpriteP, SpritePtr dstSpriteP, SWRect *sectRect)
typedef SWBoolean(* SpriteInMaskProcPtr )(SpritePtr spriteP, int testH, int testV)
typedef SWBoolean(* SpriteCollisionProcPtr )(SpritePtr srcSpriteP, SpritePtr dstSpriteP)
typedef short(* SpriteCompareProcPtr )(SpritePtr srcSpriteP, SpritePtr dstSpriteP)

Enumerations

enum  RemovalType { kSWDontRemoveSprite = 0, kSWRemoveSprite, kSWRemoveAndDisposeSprite }
enum  AdvanceType { kSWWrapAroundMode = 0, kSWPatrollingMode }

Functions

void SWRemoveSpriteFromAnimation (SpriteWorldPtr spriteWorldP, SpritePtr spriteP, SWBoolean disposeOfSprite)
void SWDisposeSprite (SpritePtr *deadSpritePP)
SWError SWAddFrame (SpritePtr srcSpriteP, FramePtr newFrameP)
SWError SWInsertFrame (SpritePtr srcSpriteP, FramePtr newFrameP, long frameIndex)
void SWRemoveFrame (SpritePtr srcSpriteP, FramePtr oldFrameP)
FramePtr SWGetNextFrame (SpritePtr spriteP, FramePtr curFrameP)
void SWStdSpriteDrawProc (FramePtr srcFrameP, FramePtr dstFrameP, SWRect *srcSWRect, SWRect *dstSWRect)
void SWLockSprite (SpritePtr srcSpriteP)
void SWUnlockSprite (SpritePtr srcSpriteP)
SWError SWSetCurrentFrame (SpritePtr srcSpriteP, FramePtr curFrameP)
SWError SWSetCurrentFrameIndex (SpritePtr srcSpriteP, long frameIndex)
void SWSetSpriteCollideProc (SpritePtr srcSpriteP, CollideProcPtr collideProc)
void SWSetSpriteColor (SpritePtr srcSpriteP, SDL_Color *color)
void SWSetSpriteFrameAdvance (SpritePtr srcSpriteP, long frameAdvance)
void SWSetSpriteFrameAdvanceMode (SpritePtr srcSpriteP, AdvanceType advanceMode)
void SWSetSpriteFrameRange (SpritePtr srcSpriteP, long firstFrameIndex, long lastFrameIndex)
void SWSetSpriteFrameTime (SpritePtr srcSpriteP, long timeInterval)
void SWSetSpriteFrameProc (SpritePtr srcSpriteP, FrameProcPtr frameProc)
void SWSetSpriteLocation (SpritePtr srcSpriteP, SWMovementType horizLoc, SWMovementType vertLoc)
void SWSetSpriteMoveBounds (SpritePtr srcSpriteP, SWRect *moveBoundsRect)
void SWSetSpriteMoveDelta (SpritePtr srcSpriteP, SWMovementType horizDelta, SWMovementType vertDelta)
void SWSetSpriteMoveTime (SpritePtr srcSpriteP, long timeInterval)
void SWSetSpritePseudoMoveTime (SpritePtr srcSpriteP, long timeInterval)
void SWSetSpriteMoveProc (SpritePtr srcSpriteP, MoveProcPtr moveProc)
SWError SWSetSpriteDrawProc (SpritePtr srcSpriteP, DrawProcPtr drawProc)
void SWSetSpriteVisible (SpritePtr srcSpriteP, SWBoolean isVisible)
void SWSetSpriteTranslucencyLevel (SpritePtr srcSpriteP, unsigned long level)
void SWSetSpriteFastMovingCheck (SpritePtr srcSpriteP, SWBoolean makeChecks)
SWMovementType SWGetSpriteVertLoc (SpritePtr srcSpriteP)
SWMovementType SWGetSpriteHorizLoc (SpritePtr srcSpriteP)
short SWGetSpriteWidth (SpritePtr srcSpriteP)
short SWGetSpriteHeight (SpritePtr srcSpriteP)
void SWMoveSprite (SpritePtr srcSpriteP, SWMovementType horizLoc, SWMovementType vertLoc)
void SWOffsetSprite (SpritePtr srcSpriteP, SWMovementType horizOffset, SWMovementType vertOffset)
void SWOffsetSpriteBasedOnTime (SpritePtr theSpriteP, SWMovementType horizOffset, SWMovementType vertOffset)
double SWConvertOffsetBasedOnTime (SpriteWorldPtr spriteWorldP, double theOffset, double framesPerSecond)
void SWResetSpriteFrameTimer (SpriteWorldPtr spriteWorldP, SpritePtr srcSpriteP)
SWBoolean SWHasMoveProcFired (SpritePtr srcSpriteP)
SWBoolean SWBounceSprite (SpritePtr srcSpriteP)
SWBoolean SWWrapSprite (SpritePtr srcSpriteP)
SWBoolean SWInRadiusMask (SpritePtr spriteP, int testPointH, int testPointV)
SWBoolean SWInPixelMask (SpritePtr spriteP, int testPointH, int testPointV)
SWBoolean SWRadiusCollision (SpritePtr srcSpriteP, SpritePtr dstSpriteP)
SWBoolean SWPixelCollision (SpritePtr srcSpriteP, SpritePtr dstSpriteP)
SWBoolean SWIsSpriteInSprite (SpritePtr srcSpriteP, SpritePtr dstSpriteP)
SWBoolean SWIsSpriteInRect (SpritePtr srcSpriteP, SWRect *testRect)
SWBoolean SWIsSpriteFullyInRect (SpritePtr srcSpriteP, SWRect *testRect)
SWBoolean SWIsPointInSprite (SpritePtr srcSpriteP, int testPointH, int testPointV)
SWBoolean SWIsPointInSpriteMask (SpritePtr srcSpriteP, int testPointH, int testPointV, SpriteInMaskProcPtr testProc)
void SWInvalidateSprite (SpritePtr srcSpriteP)
void SWTempSpriteMoveProc (SpritePtr srcSpriteP)

Detailed Description

constants, structures, and function prototypes for sprites

Typedef Documentation

typedef void(* CollideProcPtr)(SpritePtr srcSpriteP, SpritePtr dstSpriteP, SWRect *sectRect)
 

typedef void(* DrawProcPtr)(FramePtr srcFrameP, FramePtr dstFrameP, SWRect *srcRect, SWRect *dstRect)
 

typedef void(* FrameProcPtr)(SpritePtr srcSpriteP, FramePtr curFrameP, long *frameIndex)
 

typedef void(* MoveProcPtr)(SpritePtr srcSpriteP)
 

typedef SWBoolean(* SpriteCollisionProcPtr)(SpritePtr srcSpriteP, SpritePtr dstSpriteP)
 

typedef short(* SpriteCompareProcPtr)(SpritePtr srcSpriteP, SpritePtr dstSpriteP)
 

typedef SWBoolean(* SpriteInMaskProcPtr)(SpritePtr spriteP, int testH, int testV)
 

Enumeration Type Documentation

enum AdvanceType
 

Enumerator:
kSWWrapAroundMode 
kSWPatrollingMode 

enum RemovalType
 

Enumerator:
kSWDontRemoveSprite 
kSWRemoveSprite 
kSWRemoveAndDisposeSprite 

Function Documentation

SWError SWAddFrame (  SpritePtr  srcSpriteP,
FramePtr  newFrameP
) 
 

SWBoolean SWBounceSprite (  SpritePtr  srcSpriteP  ) 
 

double SWConvertOffsetBasedOnTime (  SpriteWorldPtr  spriteWorldP,
double  theOffset,
double  framesPerSecond
) 
 

void SWDisposeSprite (  SpritePtr *  deadSpritePP  ) 
 

FramePtr SWGetNextFrame (  SpritePtr  spriteP,
FramePtr  curFrameP
) 
 

short SWGetSpriteHeight (  SpritePtr  srcSpriteP  ) 
 

SWMovementType SWGetSpriteHorizLoc (  SpritePtr  srcSpriteP  ) 
 

SWMovementType SWGetSpriteVertLoc (  SpritePtr  srcSpriteP  ) 
 

short SWGetSpriteWidth (  SpritePtr  srcSpriteP  ) 
 

SWBoolean SWHasMoveProcFired (  SpritePtr  srcSpriteP  ) 
 

SWBoolean SWInPixelMask (  SpritePtr  spriteP,
int  testPointH,
int  testPointV
) 
 

SWBoolean SWInRadiusMask (  SpritePtr  spriteP,
int  testPointH,
int  testPointV
) 
 

SWError SWInsertFrame (  SpritePtr  srcSpriteP,
FramePtr  newFrameP,
long  frameIndex
) 
 

void SWInvalidateSprite (  SpritePtr  srcSpriteP  ) 
 

SWBoolean SWIsPointInSprite (  SpritePtr  srcSpriteP,
int  testPointH,
int  testPointV
) 
 

SWBoolean SWIsPointInSpriteMask (  SpritePtr  srcSpriteP,
int  testPointH,
int  testPointV,
SpriteInMaskProcPtr  testProc
) 
 

SWBoolean SWIsSpriteFullyInRect (  SpritePtr  srcSpriteP,
SWRect *  testRect
) 
 

SWBoolean SWIsSpriteInRect (  SpritePtr  srcSpriteP,
SWRect *  testRect
) 
 

SWBoolean SWIsSpriteInSprite (  SpritePtr  srcSpriteP,
SpritePtr  dstSpriteP
) 
 

void SWLockSprite (  SpritePtr  srcSpriteP  ) 
 

void SWMoveSprite (  SpritePtr  srcSpriteP,
SWMovementType  horizLoc,
SWMovementType  vertLoc
) 
 

void SWOffsetSprite (  SpritePtr  srcSpriteP,
SWMovementType  horizOffset,
SWMovementType  vertOffset
) 
 

void SWOffsetSpriteBasedOnTime (  SpritePtr  theSpriteP,
SWMovementType  horizOffset,
SWMovementType  vertOffset
) 
 

SWBoolean SWPixelCollision (  SpritePtr  srcSpriteP,
SpritePtr  dstSpriteP
) 
 

SWBoolean SWRadiusCollision (  SpritePtr  srcSpriteP,
SpritePtr  dstSpriteP
) 
 

void SWRemoveFrame (  SpritePtr  srcSpriteP,
FramePtr  oldFrameP
) 
 

void SWRemoveSpriteFromAnimation (  SpriteWorldPtr  spriteWorldP,
SpritePtr  spriteP,
SWBoolean  disposeOfSprite
) 
 

void SWResetSpriteFrameTimer (  SpriteWorldPtr  spriteWorldP,
SpritePtr  srcSpriteP
) 
 

SWError SWSetCurrentFrame (  SpritePtr  srcSpriteP,
FramePtr  curFrameP
) 
 

SWError SWSetCurrentFrameIndex (  SpritePtr  srcSpriteP,
long  frameIndex
) 
 

void SWSetSpriteCollideProc (  SpritePtr  srcSpriteP,
CollideProcPtr  collideProc
) 
 

void SWSetSpriteColor (  SpritePtr  srcSpriteP,
SDL_Color *  color
) 
 

SWError SWSetSpriteDrawProc (  SpritePtr  srcSpriteP,
DrawProcPtr  drawProc
) 
 

void SWSetSpriteFastMovingCheck (  SpritePtr  srcSpriteP,
SWBoolean  makeChecks
) 
 

void SWSetSpriteFrameAdvance (  SpritePtr  srcSpriteP,
long  frameAdvance
) 
 

void SWSetSpriteFrameAdvanceMode (  SpritePtr  srcSpriteP,
AdvanceType  advanceMode
) 
 

void SWSetSpriteFrameProc (  SpritePtr  srcSpriteP,
FrameProcPtr  frameProc
) 
 

void SWSetSpriteFrameRange (  SpritePtr  srcSpriteP,
long  firstFrameIndex,
long  lastFrameIndex
) 
 

void SWSetSpriteFrameTime (  SpritePtr  srcSpriteP,
long  timeInterval
) 
 

void SWSetSpriteLocation (  SpritePtr  srcSpriteP,
SWMovementType  horizLoc,
SWMovementType  vertLoc
) 
 

void SWSetSpriteMoveBounds (  SpritePtr  srcSpriteP,
SWRect *  moveBoundsRect
) 
 

void SWSetSpriteMoveDelta (  SpritePtr  srcSpriteP,
SWMovementType  horizDelta,
SWMovementType  vertDelta
) 
 

void SWSetSpriteMoveProc (  SpritePtr  srcSpriteP,
MoveProcPtr  moveProc
) 
 

void SWSetSpriteMoveTime (  SpritePtr  srcSpriteP,
long  timeInterval
) 
 

void SWSetSpritePseudoMoveTime (  SpritePtr  srcSpriteP,
long  timeInterval
) 
 

void SWSetSpriteTranslucencyLevel (  SpritePtr  srcSpriteP,
unsigned long  level
) 
 

void SWSetSpriteVisible (  SpritePtr  srcSpriteP,
SWBoolean  isVisible
) 
 

void SWStdSpriteDrawProc (  FramePtr  srcFrameP,
FramePtr  dstFrameP,
SWRect *  srcSWRect,
SWRect *  dstSWRect
) 
 

void SWTempSpriteMoveProc (  SpritePtr  srcSpriteP  ) 
 

void SWUnlockSprite (  SpritePtr  srcSpriteP  ) 
 

SWBoolean SWWrapSprite (  SpritePtr  srcSpriteP  ) 
 

Generated on Sun Jun 18 14:11:03 2006 for SpriteWorld X by  doxygen 1.4.6