C# Class BrashMonkey.Spriter.Data.ObjectModel.SpriterData

This class provides methods for importing and exporting Spriter data to various implementations.
Show file Open project: CptDefault/spriterdapi-unity Class Usage Examples

Public Methods

Method Description
FindAtlas ( int ID ) : SpriterAtlas

Finds an atlas by its ID.

Returns null if no atlas is found or the IDs are invalid.

FindFile ( int folderID, int fileID ) : SpriterFile

Finds a file by its folder and file ID.

Returns null if no file is found or the IDs are invalid.

FindTimelineBone ( SpriterAnimation animation, int timelineID, int keyID, int time ) : SpriterTimelineBone

Finds a timeline bone for an animation by its ID and time.

Returns null if no bone is found or the IDs are invalid.

FindTimelineObject ( SpriterAnimation animation, int timelineID, int keyID, int time ) : SpriterTimelineObject

Finds a timeline object for an animation by its ID and time.

Returns null if no object is found or the IDs are invalid.

LoadData ( string path ) : void

Loads data from an SCML file.

Reset ( ) : void
SaveData ( string path ) : void

Saves data to an SCML file.

SpriterData ( ) : System.Collections.Generic

Protected Methods

Method Description
FromImplementation ( ) : void

Saves data from the specific implementation

ToImplementation ( ) : void

Sends the data to the specific implementation.

Method Details

FindAtlas() public method

Finds an atlas by its ID.
Returns null if no atlas is found or the IDs are invalid.
public FindAtlas ( int ID ) : SpriterAtlas
ID int
return SpriterAtlas

FindFile() public method

Finds a file by its folder and file ID.
Returns null if no file is found or the IDs are invalid.
public FindFile ( int folderID, int fileID ) : SpriterFile
folderID int
fileID int
return SpriterFile

FindTimelineBone() public method

Finds a timeline bone for an animation by its ID and time.
Returns null if no bone is found or the IDs are invalid.
public FindTimelineBone ( SpriterAnimation animation, int timelineID, int keyID, int time ) : SpriterTimelineBone
animation SpriterAnimation
timelineID int
keyID int
time int
return SpriterTimelineBone

FindTimelineObject() public method

Finds a timeline object for an animation by its ID and time.
Returns null if no object is found or the IDs are invalid.
public FindTimelineObject ( SpriterAnimation animation, int timelineID, int keyID, int time ) : SpriterTimelineObject
animation SpriterAnimation
timelineID int
keyID int
time int
return SpriterTimelineObject

FromImplementation() protected abstract method

Saves data from the specific implementation
protected abstract FromImplementation ( ) : void
return void

LoadData() public method

Loads data from an SCML file.
public LoadData ( string path ) : void
path string
return void

Reset() public method

public Reset ( ) : void
return void

SaveData() public method

Saves data to an SCML file.
public SaveData ( string path ) : void
path string
return void

SpriterData() public method

public SpriterData ( ) : System.Collections.Generic
return System.Collections.Generic

ToImplementation() protected abstract method

Sends the data to the specific implementation.
protected abstract ToImplementation ( ) : void
return void