tk2dSpriteAnimationClip Class Reference

Sprite Animation Clip contains a collection of frames and associated properties required to play it. More...

List of all members.

Public Types
enum	WrapMode
	Wrap mode for the clip. More...
Public Member Functions
	tk2dSpriteAnimationClip ()
	Default contstructor.
	tk2dSpriteAnimationClip (tk2dSpriteAnimationClip source)
	Copy constructor.
void	CopyFrom (tk2dSpriteAnimationClip source)
	Copies the source animation clip into the current one. All frames are duplicated.
void	Clear ()
	Clears the clip, removes all frames.
tk2dSpriteAnimationFrame	GetFrame (int frame)
	Gets the tk2dSpriteAnimationFrame for a particular frame.
Public Attributes
string	name = "Default"
	Name of animation clip.
tk2dSpriteAnimationFrame[]	frames = new tk2dSpriteAnimationFrame[0]
	Array of frames.
float	fps = 30.0f
	FPS of clip.
int	loopStart = 0
	Defines the start point of the loop when WrapMode.LoopSection is selected.
WrapMode	wrapMode = WrapMode.Loop
	The wrap mode.
Properties
bool	Empty [get]
	Is the clip empty?

---

Detailed Description

Sprite Animation Clip contains a collection of frames and associated properties required to play it.

---

Member Enumeration Documentation

enum tk2dSpriteAnimationClip.WrapMode

Wrap mode for the clip.

---

Constructor & Destructor Documentation

tk2dSpriteAnimationClip.tk2dSpriteAnimationClip

(

)

Default contstructor.

tk2dSpriteAnimationClip.tk2dSpriteAnimationClip

(

tk2dSpriteAnimationClip

source

)

Copy constructor.

---

Member Function Documentation

void tk2dSpriteAnimationClip.Clear

(

)

Clears the clip, removes all frames.

void tk2dSpriteAnimationClip.CopyFrom

(

tk2dSpriteAnimationClip

source

)

Copies the source animation clip into the current one. All frames are duplicated.

tk2dSpriteAnimationFrame tk2dSpriteAnimationClip.GetFrame

(

int

frame

)

Gets the tk2dSpriteAnimationFrame for a particular frame.

---

Member Data Documentation

float tk2dSpriteAnimationClip.fps = 30.0f

FPS of clip.

tk2dSpriteAnimationFrame [] tk2dSpriteAnimationClip.frames = new tk2dSpriteAnimationFrame[0]

Array of frames.

int tk2dSpriteAnimationClip.loopStart = 0

Defines the start point of the loop when WrapMode.LoopSection is selected.

string tk2dSpriteAnimationClip.name = "Default"

Name of animation clip.

WrapMode tk2dSpriteAnimationClip.wrapMode = WrapMode.Loop

The wrap mode.

---

Property Documentation

bool tk2dSpriteAnimationClip.Empty [get]

Is the clip empty?