Animation

Classes
struct	CzAnimFrame
	Animation frame data. More...
struct	CzAnimFrameBool
struct	CzAnimFrameFloat
struct	CzAnimFrameVec2
struct	CzAnimFrameVec3
struct	CzAnimFrameVec4
struct	CzAnimFrameRect
struct	CzAnimFrameString
class	IzAnimTarget
	An animation target object. More...
class	CzAnim
	A collection of animation frames. More...
class	CzAnimCreator
	Creates an instance of an CzAnim object. More...
class	CzAnimInstance
	An instance of an animation object. More...
class	CzAnimTimeline
	CzAnimTimeline - An animation timeline. More...
class	CzAnimTimelineCreator
	Creates an instance of an animation object. More...
class	CzAnimTimelinesManager
	Manages a collection of timelines. More...
class	CzAnimUtil
	Animation utility class. More...
Defines
#define	CZ_NEW_ANIM(anim, name, duration, type)
	A macro that creates a simple animation.
#define	CZ_NEW_ANIM_FRAME_VEC2(anim, time, _x, _y, easing)
	A macro that creates a vec2 animation frame.
#define	CZ_NEW_ANIM_FRAME_VEC3(anim, time, _x, _y, _z, easing)
	A macro that creates a vec3 animation frame.
#define	CZ_NEW_ANIM_FRAME_VEC4(anim, time, _x, _y, _z, _w, easing)
	A macro that creates a vec4 animation frame.
#define	CZ_NEW_ANIM_FRAME_RECT(anim, time, _x, _y, _w, _h, easing)
	A macro that creates a rect animation frame.
#define	CZ_NEW_ANIM_FRAME_FLOAT(anim, time, _d, easing)
	A macro that creates a floating point animation frame.
#define	CZ_NEW_ANIM_FRAME_BOOL(anim, time, _d, easing)
	A macro that creates a boolean animation frame.
#define	CZ_NEW_ANIM_FRAME_STRING(anim, time, _d, easing)
	A macro that creates a string animation frame.
#define	CZ_NEW_TIMELINE(timeline, name, animation, delay, interpolate, repeat, target_property)
	A macro that creates a new animation instance then adds it to a new timeline.
#define	CZ_ADD_TIMELINE(timeline, animation, delay, interpolate, repeat, target_property)
	A macro that creates a new animation instance then adds its to an existing timeline.
Typedefs
typedef float(*	CzTweenEffect )(float)
	CzTweenEffect - Animation tweening effect (used to tween between different frames).

---

Define Documentation

#define CZ_ADD_TIMELINE	(		timeline,
			animation,
			delay,
			interpolate,
			repeat,
			target_property
	)

Value:

{                                                                                           \
		CzAnimInstance* inst = new CzAnimInstance();                                          \
        inst->setAnimation(animation);                                                          \
        inst->setDelay(delay);                                                                  \
        inst->setInterpolate(interpolate);                                                      \
        inst->setRepeatCount(repeat);                                                           \
        inst->setTarget(NULL, target_property);                                                 \
        timeline->addAnimation(inst);                                                           \
    }

A macro that creates a new animation instance then adds its to an existing timeline.

Parameters:

timeline	The timeline.
animation	The animation to attach.
delay	The start delay in seconds.
interpolate	The interpolate option.
repeat	The repeat count.
target_property	Target property name.

#define CZ_NEW_ANIM	(		anim,
			name,
			duration,
			type
	)

Value:

CzAnim* anim = new CzAnim();                                \
    anim->setName(name);                                        \
    anim->setDuration(duration);                                \
    anim->setType(type);

A macro that creates a simple animation.

Parameters:

anim	The animation.
name	The name of the animation.
duration	The duration of the animation in seconds.
type	The type of animation.

#define CZ_NEW_ANIM_FRAME_BOOL	(		anim,
			time,
			_d,
			easing
	)

Value:

{                                                               \
		CzAnimFrameBool* frame = new CzAnimFrameBool();               \
        frame->Time = time;                                         \
        frame->data = _d;                                           \
        frame->setEasing(easing);                                   \
        anim->addFrame(frame);                                      \
    }

A macro that creates a boolean animation frame.

Parameters:

anim	The animation where the frame will be added.
time	The time of the frame in seconds.
_d	The data.
easing	The easing method.

#define CZ_NEW_ANIM_FRAME_FLOAT	(		anim,
			time,
			_d,
			easing
	)

Value:

{                                                               \
		CzAnimFrameFloat* frame = new CzAnimFrameFloat();         \
        frame->Time = time;                                         \
        frame->data = _d;                                           \
        frame->setEasing(easing);                                   \
        anim->addFrame(frame);                                      \
    }

A macro that creates a floating point animation frame.

Parameters:

anim	The animation where the frame will be added.
time	The time of the frame in seconds.
_d	The data.
easing	The easing method.

#define CZ_NEW_ANIM_FRAME_RECT	(		anim,
			time,
			_x,
			_y,
			_w,
			_h,
			easing
	)

Value:

{                                                               \
		CzAnimFrameRect* frame = new CzAnimFrameRect();               \
        frame->Time = time;                                         \
        frame->data.x = _x;                                         \
        frame->data.y = _y;                                         \
        frame->data.w = _w;                                         \
        frame->data.h = _h;                                         \
        frame->setEasing(easing);                                   \
        anim->addFrame(frame);                                      \
    }

A macro that creates a rect animation frame.

Parameters:

anim	The animation where the frame will be added.
time	The time of the frame in seconds.
_x	The x coordinate.
_y	The y coordinate.
_w	The width.
_h	The height.
easing	The easing method.

#define CZ_NEW_ANIM_FRAME_STRING	(		anim,
			time,
			_d,
			easing
	)

Value:

{                                                               \
		CzAnimFrameString* frame = new CzAnimFrameString();           \
        frame->Time = time;                                         \
        frame->data = _d;                                           \
        frame->setEasing(easing);                                   \
        anim->addFrame(frame);                                      \
    }

A macro that creates a string animation frame.

Parameters:

anim	The animation where the frame will be added.
time	The time of the frame in seconds.
_d	The data.
easing	The easing method.

#define CZ_NEW_ANIM_FRAME_VEC2	(		anim,
			time,
			_x,
			_y,
			easing
	)

Value:

{                                                               \
		CzAnimFrameVec2* frame = new CzAnimFrameVec2();               \
        frame->Time = time;                                         \
        frame->data.x = _x;                                         \
        frame->data.y = _y;                                         \
        frame->setEasing(easing);                                   \
        anim->addFrame(frame);                                      \
    }

A macro that creates a vec2 animation frame.

Parameters:

anim	The animation where the frame will be added.
time	The time of the frame in seconds.
_x	The x coordinate.
_y	The y coordinate.
easing	The easing method.

#define CZ_NEW_ANIM_FRAME_VEC3	(		anim,
			time,
			_x,
			_y,
			_z,
			easing
	)

Value:

{                                                               \
		CzAnimFrameVec3* frame = new CzAnimFrameVec3();               \
        frame->Time = time;                                         \
        frame->data.x = _x;                                         \
        frame->data.y = _y;                                         \
        frame->data.z = _z;                                         \
        frame->setEasing(easing);                                   \
        anim->addFrame(frame);                                      \
    }

A macro that creates a vec3 animation frame.

Parameters:

anim	The animation where the frame will be added.
time	The time of the frame in seconds.
_x	The x coordinate.
_y	The y coordinate.
_z	The z coordinate.
easing	The easing method.

#define CZ_NEW_ANIM_FRAME_VEC4	(		anim,
			time,
			_x,
			_y,
			_z,
			_w,
			easing
	)

Value:

{                                                               \
		CzAnimFrameVec4* frame = new CzAnimFrameVec4();               \
        frame->Time = time;                                         \
        frame->data.x = _x;                                         \
        frame->data.y = _y;                                         \
        frame->data.z = _z;                                         \
        frame->data.w = _w;                                         \
        frame->setEasing(easing);                                   \
        anim->addFrame(frame);                                      \
    }

A macro that creates a vec4 animation frame.

Parameters:

anim	The animation where the frame will be added.
time	The time of the frame in seconds.
_x	The x coordinate.
_y	The y coordinate.
_z	The z coordinate.
_w	The w coordinate.
easing	The easing method.

#define CZ_NEW_TIMELINE	(		timeline,
			name,
			animation,
			delay,
			interpolate,
			repeat,
			target_property
	)

Value:

CzAnimTimeline* timeline = new CzAnimTimeline();                                            \
    {                                                                                           \
		CzAnimInstance* inst = new CzAnimInstance();                                          \
        inst->setAnimation(animation);                                                          \
        inst->setDelay(delay);                                                                  \
        inst->setInterpolate(interpolate);                                                      \
        inst->setRepeatCount(repeat);                                                           \
        inst->setTarget(NULL, target_property);                                                 \
        timeline->setName(name);                                                                \
        timeline->addAnimation(inst);                                                           \
    }

A macro that creates a new animation instance then adds it to a new timeline.

Parameters:

timeline	The timeline.
name	The name of the timeline.
animation	The animation to attach.
delay	The start delay in seconds.
interpolate	The interpolate option.
repeat	The repeat count.
target_property	Target property name.

---

Typedef Documentation

float(* CzTweenEffect)(float)

CzTweenEffect - Animation tweening effect (used to tween between different frames).