Sprite Class Reference

Inheritance diagram for Sprite:

Collaboration diagram for Sprite:

Public Types
enum	{   animate_StartToEnd = 0,   animate_EndToStart = 1,   animate_Unidirectional = 0,   animate_Bidirectional = 2,   animate_NoLooping = 0,   animate_Looping = 4,   start_FromFirstFrame = -1,   start_FromLastFrame = -2,   all_Frames = 0,   action_CollideSprite = 0,   action_CollideWall = 1,   action_Offscreen = 2,   action_Onscreen = 3,   action_ExitLayer = 4,   action_AnimationLoop = 8,   action_AnimationEnd = 9,   action_FadeComplete = 10,   action_FadeInComplete = 11,   action_FadeOutComplete = 12,   action_JointBreak = 13,   touch_MouseEnter = 20,   touch_MouseLeave = 21,   touch_MouseDown = 22,   touch_MouseUp = 23,   touch_MouseClick = 24,   collide_None = 0,   collide_Point = 1,   collide_BoundingBox = 2,   collide_CollisionRadius = 3,   collide_AlphaChannel = 4,   collide_Last = collide_AlphaChannel }
Public Types inherited from Animated
enum	{   duration_Constant = -1,   duration_Instantaneous = 0 }

Public Member Functions
	SERIALIZABLE_TAG (CLASSTAG_SPRITE)
	SERIALIZABLE_METHODS ()
RotatedRect	getFrameRotatedBounds (int frameNum=-1)
Sprite &	setFrame (int frame)
int	getCurrentFrame ()
int	getFrameCount ()
void	startFrameAnimation (float fps, int startingFrame=start_FromFirstFrame, int numFrames=all_Frames, int animateFlags=animate_Looping)
void	stopFrameAnimation ()
bool	getWantsAnimLoopEvents ()
bool	getWantsAnimEndEvents ()
Sprite &	setWantsAnimLoopEvents (bool wantsThem=true)
Sprite &	setWantsAnimEndEvents (bool wantsThem=true)
void	addFramesImage (Image *image, int startingFrame=start_FromFirstFrame, int numFrames=all_Frames)
void	setDrawHelper (ISpriteDrawHelper *helper)
void	setPostDrawHelper (ISpriteDrawHelper *helper)
void	changeFramesImage (Image *oldImage, Image *newImage)
void	offsetFrameCenters (int offsetX, int offsetY, Image *image=0, int startingFrame=start_FromFirstFrame, int numFrames=all_Frames)
Offset	getFrameCenterOffset (Image *image=0, int frameNum=0)
Sprite &	setOpacity (float opacity)
float	getOpacity ()
void	fadeTo (float targetOpacity, ms_delta msDuration, EasingFunc easing=linearTween)
void	fadeIn (ms_delta msDuration, EasingFunc easing=linearTween)
void	fadeOut (ms_delta msDuration, EasingFunc easing=linearTween)
Sprite &	moveBehind (Sprite *sprite)
Sprite &	moveInFrontOf (Sprite *sprite)
Sprite &	moveToFront ()
Sprite &	moveToBack ()
int	getZOrder ()
bool	isBehind (Sprite *sprite)
bool	getWantsCollideWallEvents ()
Sprite &	setWantsCollideWallEvents (bool wantsThem=true)
Sprite &	enableCollisions (int collisionType=collide_AlphaChannel)
Sprite &	disableCollisions ()
Sprite &	setCollisionRadius (float pixelRadius)
float	getCollisionRadius ()
void	useCollisionMask (Image *frameImage, Image *maskImage)
void	setCollisionHelper (ISpriteCollideHelper *helper)
Sprite &	setElasticity (float elasticity)
float	getElasticity ()
bool	getWantsMouseOverEvents ()
bool	getWantsClickEvents ()
int	getMouseDetectMode ()
bool	getWantsOffscreenEvents ()
Sprite &	setWantsMouseOverEvents (bool wantsThem=true)
Sprite &	setWantsClickEvents (bool wantsThem=true)
Sprite &	setMouseDetectMode (int collisionType=collide_BoundingBox)
Sprite &	setWantsOffscreenEvents (bool wantsThem=true)
void	setUserData (UserData *userData)
void	freeUserData ()
SpriteLayer *	getLayer ()
Public Member Functions inherited from EventEmitter
virtual void	addHandler (IEventHandler *inHandler, long inType=all_events)
	add a new handler for some event type, or for all events if no type specified
virtual void	removeHandler (IEventHandler *inHandler, long inType=all_events)
	Remove a handler for some event type, or for all events if no type specified.
virtual void	clear (bool doRelease=true)
	remove all handlers
virtual void	blockEvent (long inEventType)
	temporarily ignore all events of a particular type, just drop them on the floor
virtual void	unblockEvent (long inEventType)
	stop ignoring events of a particular type, no recovery of previously ignored events
	EventEmitter ()
	constructor for new event emitter
virtual bool	postEvent (long inEventType, void *inEventData, EventEmitter *fromEmitter=0)
	post an event for immediate handling locally, or relay it to the EventManger
Public Member Functions inherited from Animated
	SERIALIZABLE_TAG (CLASSTAG_ANIMATED)
	SERIALIZABLE_METHODS ()
Rect	getBoundingBox ()
RotatedRect	getRotatedBounds ()
Animated &	setLocation (const Point &loc)
Point	getLocation ()
Animated &	moveTo (float x, float y)
Animated &	moveTo (const Point &where)
Animated &	move (float deltaX, float deltaY)
Animated &	move (const Offset &delta)
virtual void	moveTo (const Point &loc, ms_delta msDuration, EasingFunc easing=easeInOutQuad)
void	moveTo (float x, float y, ms_delta msDuration, EasingFunc easing=easeInOutQuad)
void	move (float deltaX, float deltaY, ms_delta msDuration, EasingFunc easing=easeInOutQuad)
void	move (const Offset &delta, ms_delta msDuration, EasingFunc easing=easeInOutQuad)
virtual Animated &	setVelocity (const Vector &deltaPerSec)
virtual Vector	getVelocity ()
Animated &	setSpeed (float speed)
float	getSpeed ()
Animated &	setVelocityInRadians (float speed, float direction)
float	getMovementDirectionInRadians ()
Animated &	setVelocity (float deltaXPerSec, float deltaYPerSec)
Animated &	stopMoving ()
virtual void	accelerateTo (float speed, ms_delta msDuration, EasingFunc easing=linearTween)
void	accelerate (float deltaSpeed, ms_delta msDuration, EasingFunc easing=linearTween)
Animated &	setSize (float width, float height)
Animated &	setWidth (float width)
float	getWidth ()
Animated &	setHeight (float height)
float	getHeight ()
Animated &	grow (float factor)
Animated &	stretch (float widthFactor, float heightFactor)
Animated &	startGrowing (float amountPerSecond)
Animated &	stopGrowing ()
Animated &	startStretching (float widthPerSecond, float heightPerSecond)
Animated &	stopStretching ()
virtual void	resizeTo (float width, float height, ms_delta msDuration, EasingFunc easing=easeInOutQuad)
void	resize (float deltaWidth, float deltaHeight, ms_delta msDuration, EasingFunc easing=easeInOutQuad)
void	grow (float factor, ms_delta msDuration, EasingFunc easing=easeInOutQuad)
void	stretch (float widthFactor, float weightFactor, ms_delta msDuration, EasingFunc easing=easeInOutQuad)
Animated &	setRotation (float radiansRotation)
float	getRotation ()
Animated &	setCenterOffset (const Offset &offset)
Offset	getCenterOffset ()
Animated &	rotateTo (float radiansRotation)
Animated &	rotate (float radians)
Animated &	setSpin (float radiansPerSecond)
float	getSpin ()
Animated &	stopSpinning ()
virtual void	rotateTo (float radiansRotation, ms_delta msDuration, EasingFunc easing=easeInOutQuad)
void	rotate (float radians, ms_delta msDuration, EasingFunc easing=easeInOutQuad)
void	changeCenterTo (float xOffset, float yOffset, ms_delta msDuration, EasingFunc easing=easeInOutQuad)
void	changeCenterTo (const Offset &offset, ms_delta msDuration, EasingFunc easing=easeInOutQuad)
void	changeCenter (float deltaXOffset, float deltaYOffset, ms_delta msDuration, EasingFunc easing=easeInOutQuad)
void	changeCenter (const Offset &offset, ms_delta msDuration, EasingFunc easing=easeInOutQuad)
Animated *	wait (ms_delta msDuration)
virtual Animated &	setMass (float mass)
float	getMass ()
virtual Animated &	setFriction (float frictionCoefficient)
Animated &	setMoveFriction (float frictionCoefficient)
Animated &	setSpinFriction (float frictionCoefficient)
Animated &	setSizeFriction (float frictionCoefficient)
float	getMoveFriction ()
float	getSpinFriction ()
float	getSizeFriction ()
virtual void	applyForce (const Vector &force, ms_delta msDuration=duration_Instantaneous)
virtual void	applyForce (float forceX, float forceY, ms_delta msDuration=duration_Instantaneous)
virtual void	applyTorque (float forceSpin, ms_delta msDuration=duration_Instantaneous)
virtual void	stopAllForces ()
virtual void	addAnimationHelper (IAnimationHelper *helper)
virtual void	removeAnimationHelper (IAnimationHelper *helper)
virtual void	clearAnimationHelpers ()
Public Member Functions inherited from ISerializable
virtual uint32	getSerializedSize (ISerializer *serializer) const =0
	Get number of bytes needed to hold serialized state.
virtual void	serialize (ISerializer *serializer) const =0
	Write self out to a serializer.
virtual void	deserialize (IDeserializer *deserializer)=0
	Read self from a deserializer.
virtual uint32	getMyClassTag () const =0
	Get a tag value that uniquely represents this class.
	ISerializable ()
virtual	~ISerializable ()
Public Member Functions inherited from RefCountedObj
virtual void	addRef () const throw ()
virtual void	release () const throw ()

Static Public Member Functions
static pdg::ISerializable *	CreateInstance ()
Static Public Member Functions inherited from Animated
static pdg::ISerializable *	CreateInstance ()

Public Attributes
long	spriteId
bool	wantsMouseOver
bool	wantsClicks
bool	wantsAnimLoop
bool	wantsAnimEnd
bool	wantsOffscreen
bool	wantsWallCollide
UserData *	userData

Friends
class	SpriteLayer
class	TileLayer
class	SpriteManager

Member Enumeration Documentation

anonymous enum

Enumerator:

animate_StartToEnd
animate_EndToStart
animate_Unidirectional
animate_Bidirectional
animate_NoLooping
animate_Looping
start_FromFirstFrame
start_FromLastFrame
all_Frames
action_CollideSprite
action_CollideWall
action_Offscreen
action_Onscreen
action_ExitLayer
action_AnimationLoop
action_AnimationEnd
action_FadeComplete
action_FadeInComplete
action_FadeOutComplete
action_JointBreak
touch_MouseEnter
touch_MouseLeave	NOT IMPLEMENTED
touch_MouseDown	NOT IMPLEMENTED
touch_MouseUp
touch_MouseClick
collide_None
collide_Point
collide_BoundingBox
collide_CollisionRadius
collide_AlphaChannel
collide_Last

Member Function Documentation

void addFramesImage	(	Image *	image,
		int	startingFrame = start_FromFirstFrame,
		int	numFrames = all_Frames
	)

void changeFramesImage	(	Image *	oldImage,
		Image *	newImage
	)

static pdg::ISerializable* CreateInstance ( )

inlinestatic

Sprite& disableCollisions

(

)

Sprite& enableCollisions

(

int

collisionType = collide_AlphaChannel

)

void fadeIn	(	ms_delta	msDuration,
		EasingFunc	easing = linearTween
	)

void fadeOut	(	ms_delta	msDuration,
		EasingFunc	easing = linearTween
	)

void fadeTo	(	float	targetOpacity,
		ms_delta	msDuration,
		EasingFunc	easing = linearTween
	)

void freeUserData

(

)

float getCollisionRadius

(

)

int getCurrentFrame

(

)

float getElasticity

(

)

Offset getFrameCenterOffset	(	Image *	image = 0,
		int	frameNum = 0
	)

int getFrameCount ( )

inline

RotatedRect getFrameRotatedBounds

(

int

frameNum = -1

)

SpriteLayer* getLayer ( )

inline

int getMouseDetectMode ( )

inline

float getOpacity

(

)

bool getWantsAnimEndEvents ( )

inline

bool getWantsAnimLoopEvents ( )

inline

bool getWantsClickEvents ( )

inline

bool getWantsCollideWallEvents ( )

inline

bool getWantsMouseOverEvents ( )

inline

bool getWantsOffscreenEvents ( )

inline

int getZOrder

(

)

bool isBehind

(

Sprite *

sprite

)

Sprite& moveBehind

(

Sprite *

sprite

)

Sprite& moveInFrontOf

(

Sprite *

sprite

)

Sprite & moveToBack ( )

inline

Sprite & moveToFront ( )

inline

void offsetFrameCenters	(	int	offsetX,
		int	offsetY,
		Image *	image = 0,
		int	startingFrame = start_FromFirstFrame,
		int	numFrames = all_Frames
	)

SERIALIZABLE_METHODS

(

)

SERIALIZABLE_TAG

(

CLASSTAG_SPRITE

)

void setCollisionHelper

(

ISpriteCollideHelper *

helper

)

Sprite& setCollisionRadius

(

float

pixelRadius

)

void setDrawHelper

(

ISpriteDrawHelper *

helper

)

Sprite& setElasticity

(

float

elasticity

)

Sprite& setFrame

(

int

frame

)

Sprite& setMouseDetectMode

(

int

collisionType = collide_BoundingBox

)

Sprite& setOpacity

(

float

opacity

)

void setPostDrawHelper

(

ISpriteDrawHelper *

helper

)

void setUserData

(

UserData *

userData

)

Sprite & setWantsAnimEndEvents ( bool  wantsThem = true )

inline

Sprite & setWantsAnimLoopEvents ( bool  wantsThem = true )

inline

Sprite& setWantsClickEvents

(

bool

wantsThem = true

)

Sprite & setWantsCollideWallEvents ( bool  wantsThem = true )

inline

Sprite& setWantsMouseOverEvents

(

bool

wantsThem = true

)

Sprite & setWantsOffscreenEvents ( bool  wantsThem = true )

inline

void startFrameAnimation	(	float	fps,
		int	startingFrame = start_FromFirstFrame,
		int	numFrames = all_Frames,
		int	animateFlags = animate_Looping
	)

void stopFrameAnimation

(

)

void useCollisionMask	(	Image *	frameImage,
		Image *	maskImage
	)

Friends And Related Function Documentation

friend class SpriteLayer

friend

friend class SpriteManager

friend

friend class TileLayer

friend

Member Data Documentation

long spriteId

UserData* userData

bool wantsAnimEnd

bool wantsAnimLoop

bool wantsClicks

bool wantsMouseOver

bool wantsOffscreen

bool wantsWallCollide