kzu_animation_item.h File Reference

The base class for animation related classes. More...

#include <user/resource/kzu_resource_common.h>
#include <system/debug/kzs_error.h>
#include <system/kzs_types.h>
#include <system/kzs_header.h>

Enumerations
enum	KzuAnimationItemType { KZU_ANIMATION_ITEM_TYPE_ANIMATION, KZU_ANIMATION_ITEM_TYPE_CLIP, KZU_ANIMATION_ITEM_TYPE_TIME_LINE_SEQUENCE }
	Types of animation items. More...

Functions
enum KzuAnimationItemType	kzuAnimationItemGetType (const struct KzuAnimationItem *animationItem)
	Gets type of animation item. More...
kzsError	kzuAnimationItemUpdate (struct KzuAnimationPlayer *animationPlayer, const struct KzuAnimationItem *animationItem, kzFloat targetTime)
	Updates animation item. More...
kzsError	kzuAnimationItemPrepare (struct KzuAnimationPlayer *animationPlayer, const struct KzuAnimationItem *animationItem)
	Prepares animation item for update. More...
kzsError	kzuAnimationItemFinish (struct KzuAnimationPlayer *animationPlayer, const struct KzuAnimationItem *animationItem)
	Finishes an animation item. More...
kzsError	kzuAnimationItemDelete (struct KzuAnimationItem *animationItem)
	Deletes animation item. More...
kzsError	kzuAnimationItemStart (struct KzuAnimationPlayer *animationPlayer, const struct KzuAnimationItem *animationItem)
	Starts (launches) animation item. More...
kzsError	kzuAnimationItemClearCache (const struct KzuAnimationItem *animationItem)
	Clears the animation item caches. More...
kzFloat	kzuAnimationItemGetDuration (const struct KzuAnimationItem *animationItem)
	Gets duration of the animation item. More...
void	kzuAnimationItemSetChangeFlag (struct KzuAnimationItem *animationItem, kzBool isSet)
	Sets change flag for animation item. More...
kzBool	kzuAnimationItemIsChangeFlagSet (const struct KzuAnimationItem *animationItem)
	Returns if animation item change flag is set. More...
kzsError	kzuAnimationItemSetName (struct KzuAnimationItem *animationItem, kzString name)
	Sets name for the animation clip. More...
kzString	kzuAnimationItemGetName (const struct KzuAnimationItem *animationItem)
	Gets name from the animation clip. More...
struct KzuResource *	kzuAnimationItemToResource (const struct KzuAnimationItem *animationItem)
	Converts animation item to resource. More...
struct KzuAnimationItem *	kzuAnimationItemFromResource (const struct KzuResource *resource)
	Converts animation item from resource. More...
struct KzuAnimationItem *	kzuAnimationItemCastFromResource (const struct KzuResource *resource)
	Casts animation item from resource, returns KZ_NULL if the resource is of invalid type. More...

Variables
const KzuResourceType	KZU_RESOURCE_TYPE_ANIMATION_ITEM
	Resource type identifier for animation item. More...

Detailed Description

The base class for animation related classes.

The base class for KzuAnimation, KzuAnimationClip and KzuTimeLineSequence.

See Also

kzu_animation.h, kzu_animation_clip.h, kzu_time_line_sequence.h.

Copyright 2008-2019 by Rightware. All rights reserved.

Enumeration Type Documentation

enum KzuAnimationItemType

Types of animation items.

Enumerator
KZU_ANIMATION_ITEM_TYPE_ANIMATION
KZU_ANIMATION_ITEM_TYPE_CLIP
KZU_ANIMATION_ITEM_TYPE_TIME_LINE_SEQUENCE

Function Documentation

enum KzuAnimationItemType kzuAnimationItemGetType

(

const struct KzuAnimationItem *

animationItem)

Gets type of animation item.

kzsError kzuAnimationItemUpdate	(	struct KzuAnimationPlayer *	animationPlayer,
		const struct KzuAnimationItem *	animationItem,
		kzFloat	targetTime
	)

Updates animation item.

kzsError kzuAnimationItemPrepare	(	struct KzuAnimationPlayer *	animationPlayer,
		const struct KzuAnimationItem *	animationItem
	)

Prepares animation item for update.

kzsError kzuAnimationItemFinish	(	struct KzuAnimationPlayer *	animationPlayer,
		const struct KzuAnimationItem *	animationItem
	)

Finishes an animation item.

kzsError kzuAnimationItemDelete

(

struct KzuAnimationItem *

animationItem)

Deletes animation item.

kzsError kzuAnimationItemStart	(	struct KzuAnimationPlayer *	animationPlayer,
		const struct KzuAnimationItem *	animationItem
	)

Starts (launches) animation item.

kzsError kzuAnimationItemClearCache

(

const struct KzuAnimationItem *

animationItem)

Clears the animation item caches.

kzFloat kzuAnimationItemGetDuration

(

const struct KzuAnimationItem *

animationItem)

Gets duration of the animation item.

void kzuAnimationItemSetChangeFlag	(	struct KzuAnimationItem *	animationItem,
		kzBool	isSet
	)

Sets change flag for animation item.

kzBool kzuAnimationItemIsChangeFlagSet

(

const struct KzuAnimationItem *

animationItem)

Returns if animation item change flag is set.

kzsError kzuAnimationItemSetName	(	struct KzuAnimationItem *	animationItem,
		kzString	name
	)

Sets name for the animation clip.

kzString kzuAnimationItemGetName

(

const struct KzuAnimationItem *

animationItem)

Gets name from the animation clip.

struct KzuResource* kzuAnimationItemToResource

(

const struct KzuAnimationItem *

animationItem)

Converts animation item to resource.

struct KzuAnimationItem* kzuAnimationItemFromResource

(

const struct KzuResource *

resource)

Converts animation item from resource.

struct KzuAnimationItem* kzuAnimationItemCastFromResource

(

const struct KzuResource *

resource)

Casts animation item from resource, returns KZ_NULL if the resource is of invalid type.

Variable Documentation

const KzuResourceType KZU_RESOURCE_TYPE_ANIMATION_ITEM

Resource type identifier for animation item.