AgateLib.DisplayLib.ISprite Interface Reference

Basic interface implemented by different sprite classes. More...

Inheritance diagram for AgateLib.DisplayLib.ISprite:

List of all members.

Public Member Functions
void	AdvanceFrame ()
	Shows the next frame in the sequence. This pays attention to whether the animation is playing forwards or reverse.
void	Update ()
	Updates the animation of the sprite, using the DeltaTime given by the Display object.
void	Update (double time_ms)
	Updates the animation of the sprite, using the given frame time.
void	StartAnimation ()
	Restarts the animation.
Properties
SpriteAnimType	AnimationType [get, set]
	Gets or sets an enum value indicating what type of animation is happening. Looping - The animation will play from beginning to end and then restart. PingPong - The animation will play from beginning to end and then from end to beginning (continuously). Once - The animation plays once, and then shows its first frame. OnceHoldLast - The animation plays once, and leaves the last frame on.
ISpriteFrame	CurrentFrame [get]
	Gets the currently displaying frame.
int	CurrentFrameIndex [get, set]
	The index of the current frame.
bool	IsAnimating [get, set]
	Gets or sets a flag which indicates: True if the animation is running. False if a single frame will be shown indefinitely.
bool	PlayReverse [get, set]
	Gets or sets a flag which indicates whether or not this animation plays in reverse instead.
int	SpriteHeight [get]
	Gets height of the sprite.
Size	SpriteSize [get]
	Gets the size of the sprite.
int	SpriteWidth [get]
	Gets width of the sprite.
Sprites.IFrameList	Frames [get]
	Gets the list of SpriteFrame objects in this sprite.
double	TimePerFrame [get, set]
	The amount of time each frame should display, in milliseconds.
bool	Visible [get, set]
	If Visible is set to false, all calls to Draw overloads are ignored.
Events
SpriteEventHandler	AnimationStarted
	Event which is raised when the animation is started.
SpriteEventHandler	AnimationStopped
	Event which is raised when the animation is stopped.
SpriteEventHandler	PlayDirectionChanged
	Event which is raised when the play direction is changed, as in the PingPong type.

---

Detailed Description

Basic interface implemented by different sprite classes.

---

Member Function Documentation

void AgateLib.DisplayLib.ISprite.AdvanceFrame

(

)

Shows the next frame in the sequence. This pays attention to whether the animation is playing forwards or reverse.

Implemented in AgateLib.Sprites.Sprite.

void AgateLib.DisplayLib.ISprite.StartAnimation

(

)

Restarts the animation.

Implemented in AgateLib.Sprites.Sprite.

void AgateLib.DisplayLib.ISprite.Update

(

double

time_ms

)

Updates the animation of the sprite, using the given frame time.

Parameters:

time_ms

The amount of time to consider passed, in milliseconds.

Implemented in AgateLib.Sprites.Sprite.

void AgateLib.DisplayLib.ISprite.Update

(

)

Updates the animation of the sprite, using the DeltaTime given by the Display object.

Implemented in AgateLib.Sprites.Sprite.

---

Property Documentation

SpriteAnimType AgateLib.DisplayLib.ISprite.AnimationType [get, set]

Gets or sets an enum value indicating what type of animation is happening. Looping - The animation will play from beginning to end and then restart. PingPong - The animation will play from beginning to end and then from end to beginning (continuously). Once - The animation plays once, and then shows its first frame. OnceHoldLast - The animation plays once, and leaves the last frame on.

Implemented in AgateLib.Sprites.Sprite.

ISpriteFrame AgateLib.DisplayLib.ISprite.CurrentFrame [get]

Gets the currently displaying frame.

Implemented in AgateLib.Sprites.Sprite.

int AgateLib.DisplayLib.ISprite.CurrentFrameIndex [get, set]

The index of the current frame.

Implemented in AgateLib.Sprites.Sprite.

Sprites.IFrameList AgateLib.DisplayLib.ISprite.Frames [get]

Gets the list of SpriteFrame objects in this sprite.

Implemented in AgateLib.Sprites.Sprite.

bool AgateLib.DisplayLib.ISprite.IsAnimating [get, set]

Gets or sets a flag which indicates: True if the animation is running. False if a single frame will be shown indefinitely.

Implemented in AgateLib.Sprites.Sprite.

bool AgateLib.DisplayLib.ISprite.PlayReverse [get, set]

Gets or sets a flag which indicates whether or not this animation plays in reverse instead.

Implemented in AgateLib.Sprites.Sprite.

int AgateLib.DisplayLib.ISprite.SpriteHeight [get]

Gets height of the sprite.

Implemented in AgateLib.Sprites.Sprite.

Size AgateLib.DisplayLib.ISprite.SpriteSize [get]

Gets the size of the sprite.

Implemented in AgateLib.Sprites.Sprite.

int AgateLib.DisplayLib.ISprite.SpriteWidth [get]

Gets width of the sprite.

Implemented in AgateLib.Sprites.Sprite.

double AgateLib.DisplayLib.ISprite.TimePerFrame [get, set]

The amount of time each frame should display, in milliseconds.

Implemented in AgateLib.Sprites.Sprite.

bool AgateLib.DisplayLib.ISprite.Visible [get, set]

If Visible is set to false, all calls to Draw overloads are ignored.

Implemented in AgateLib.Sprites.Sprite.

---

Event Documentation

SpriteEventHandler AgateLib.DisplayLib.ISprite.AnimationStarted

Event which is raised when the animation is started.

Implemented in AgateLib.Sprites.Sprite.

SpriteEventHandler AgateLib.DisplayLib.ISprite.AnimationStopped

Event which is raised when the animation is stopped.

Implemented in AgateLib.Sprites.Sprite.

SpriteEventHandler AgateLib.DisplayLib.ISprite.PlayDirectionChanged

Event which is raised when the play direction is changed, as in the PingPong type.

Implemented in AgateLib.Sprites.Sprite.

---

The documentation for this interface was generated from the following file:

• DisplayLib/ISprite.cs