C# Class Sphere.Core.Spriteset

A Sphere spriteset object
Inheritance: IDisposable
Show file Open project: Radnen/spherestudio Class Usage Examples

Public Methods

Method Description
Dispose ( ) : void

Disposes and clears this object.

GetDirections ( ) : string[]

Returns an array of the directions in this spriteset.

GetImage ( int index ) : Image

Returns an image based on the given index.

GetImage ( string direction, int frame ) : Image

Attempts to grab an image by using a direction and frame.

Load ( String filename ) : bool

Attempts to load the spriteset from the given filename.

MakeNew ( ) : void

Populates this spriteset with default info.

RemoveFrameReference ( int reference ) : void

Removes the frame from the spriteset and its image array.

Save ( string filename ) : void

Saves the Spriteset to the filename.

Private Methods

Method Description
Dispose ( bool disposing ) : void
Purge ( ) : void

Method Details

Dispose() public method

Disposes and clears this object.
public Dispose ( ) : void
return void

GetDirections() public method

Returns an array of the directions in this spriteset.
public GetDirections ( ) : string[]
return string[]

GetImage() public method

Returns an image based on the given index.
public GetImage ( int index ) : Image
index int The image index to use.
return Image

GetImage() public method

Attempts to grab an image by using a direction and frame.
public GetImage ( string direction, int frame ) : Image
direction string The name of the direction to get an image from.
frame int The frame in the direction to use.
return Image

Load() public method

Attempts to load the spriteset from the given filename.
public Load ( String filename ) : bool
filename String The filename of the Spriteset to load.
return bool

MakeNew() public method

Populates this spriteset with default info.
public MakeNew ( ) : void
return void

RemoveFrameReference() public method

Removes the frame from the spriteset and its image array.
public RemoveFrameReference ( int reference ) : void
reference int
return void

Save() public method

Saves the Spriteset to the filename.
public Save ( string filename ) : void
filename string The filename to store the spriteset.
return void