C# Class XNATestBed.Sprite

Show file Open project: ReticentJohn/Spring-Project-2011

Public Properties

Property	Type	Description
isAnimated	bool
isMoving	bool
movementDestination	Vector2
position	Vector2
visible	bool

Public Methods

Method	Description
CopyFromSprite ( Sprite loadedSprite ) : void
Draw ( SpriteBatch spriteBatch ) : void	Draw the sprite at its current position.
Draw ( SpriteBatch spriteBatch, Vector2 drawingPosition ) : void	Draw the sprite at the specified position. Assumes the sprite is not moving.
Draw ( SpriteBatch spriteBatch, float rotation ) : void	Draw the sprite at its current position with a given radian rotation. (This is a flimsy function for special cases. Will be updated when needed.)
LoadContent ( Microsoft.Xna.Framework.Content.ContentManager contentManager, string textureName ) : void	Load the texture for the sprite using the Content Pipeline If no frames specified, then assume the sprite will never be animated and thus has only 1 frame.
LoadContent ( Microsoft.Xna.Framework.Content.ContentManager contentManager, string textureName, int maxNumOfFrames, int maxNumOfFrameSets ) : void	Load the texture for the sprite using the Content Pipeline
Sprite ( ) : System
Sprite ( Sprite loadedSprite ) : System
StartAnimation ( float aniInterval, bool onlyAnimateOnce ) : void	Using the sprite's current frame and frame set, animate through its frameset either indefinitely or at least once, at the given interval.
StartMovement ( Vector2 destinationPosition, float moveSpeed ) : void	Set the sprite to move from its current drawing position to the given position, at the specified speed.
StartMovementTimed ( Vector2 destinationPosition, float timeToMove ) : void	Set the sprite to move from its current drawing position to the given position, completing it within the specified time.
Update ( GameTime gameTime ) : void

Method Details

CopyFromSprite() public method

public CopyFromSprite ( Sprite loadedSprite ) : void
loadedSprite	Sprite
return	void

Draw() public method

Draw the sprite at its current position.

public Draw ( SpriteBatch spriteBatch ) : void
spriteBatch	Microsoft.Xna.Framework.Graphics.SpriteBatch
return	void

Draw() public method

Draw the sprite at the specified position. Assumes the sprite is not moving.

public Draw ( SpriteBatch spriteBatch, Vector2 drawingPosition ) : void
spriteBatch	Microsoft.Xna.Framework.Graphics.SpriteBatch
drawingPosition	Vector2
return	void

Draw() public method

Draw the sprite at its current position with a given radian rotation. (This is a flimsy function for special cases. Will be updated when needed.)

public Draw ( SpriteBatch spriteBatch, float rotation ) : void
spriteBatch	Microsoft.Xna.Framework.Graphics.SpriteBatch
rotation	float
return	void

LoadContent() public method

Load the texture for the sprite using the Content Pipeline If no frames specified, then assume the sprite will never be animated and thus has only 1 frame.

public LoadContent ( Microsoft.Xna.Framework.Content.ContentManager contentManager, string textureName ) : void
contentManager	Microsoft.Xna.Framework.Content.ContentManager
textureName	string
return	void

LoadContent() public method

Load the texture for the sprite using the Content Pipeline

public LoadContent ( Microsoft.Xna.Framework.Content.ContentManager contentManager, string textureName, int maxNumOfFrames, int maxNumOfFrameSets ) : void
contentManager	Microsoft.Xna.Framework.Content.ContentManager
textureName	string
maxNumOfFrames	int
maxNumOfFrameSets	int
return	void

Sprite() public method

public Sprite ( ) : System
return	System

Sprite() public method

public Sprite ( Sprite loadedSprite ) : System
loadedSprite	Sprite
return	System

StartAnimation() public method

Using the sprite's current frame and frame set, animate through its frameset either indefinitely or at least once, at the given interval.

public StartAnimation ( float aniInterval, bool onlyAnimateOnce ) : void
aniInterval	float
onlyAnimateOnce	bool
return	void

StartMovement() public method

Set the sprite to move from its current drawing position to the given position, at the specified speed.

public StartMovement ( Vector2 destinationPosition, float moveSpeed ) : void
destinationPosition	Vector2
moveSpeed	float
return	void

StartMovementTimed() public method

Set the sprite to move from its current drawing position to the given position, completing it within the specified time.

public StartMovementTimed ( Vector2 destinationPosition, float timeToMove ) : void
destinationPosition	Vector2
timeToMove	float
return	void

Update() public method

public Update ( GameTime gameTime ) : void
gameTime	Microsoft.Xna.Framework.GameTime
return	void

Property Details

isAnimated public property

public bool isAnimated
return	bool

isMoving public property

public bool isMoving
return	bool

movementDestination public property

public Vector2 movementDestination
return	Vector2

position public property

public Vector2 position
return	Vector2

visible public property

public bool visible
return	bool