kzu_animation_item.h File Reference

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

#include <system/debug/kzs_error.h>
#include <system/kzs_types.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
KANZI_API enum KzuAnimationItemType	kzuAnimationItemGetType (const struct KzuAnimationItem *animationItem)
	Gets type of animation item. More...
KANZI_API kzsError	kzuAnimationItemUpdate (struct KzuAnimationPlayer *animationPlayer, const struct KzuAnimationItem *animationItem, kzFloat targetTime)
	Updates animation item. More...
KANZI_API kzsError	kzuAnimationItemPrepare (struct KzuAnimationPlayer *animationPlayer, const struct KzuAnimationItem *animationItem)
	Prepares animation item for update. More...
KANZI_API kzsError	kzuAnimationItemFinish (struct KzuAnimationPlayer *animationPlayer, const struct KzuAnimationItem *animationItem)
	Finishes an animation item. More...
KANZI_API kzsError	kzuAnimationItemStart (struct KzuAnimationPlayer *animationPlayer, const struct KzuAnimationItem *animationItem)
	Starts (launches) animation item. More...
KANZI_API kzsError	kzuAnimationItemClearCache (const struct KzuAnimationItem *animationItem)
	Clears the animation item caches. More...
KANZI_API kzFloat	kzuAnimationItemGetDuration (const struct KzuAnimationItem *animationItem)
	Gets duration of the animation item. More...
KANZI_API void	kzuAnimationItemSetChangeFlag (struct KzuAnimationItem *animationItem, kzBool isSet)
	Sets change flag for animation item. More...
KANZI_API kzBool	kzuAnimationItemIsChangeFlagSet (const struct KzuAnimationItem *animationItem)
	Returns if animation item change flag is set. 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-2020 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

KANZI_API enum KzuAnimationItemType kzuAnimationItemGetType

(

const struct KzuAnimationItem *

animationItem

)

Gets type of animation item.

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

Updates animation item.

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

Prepares animation item for update.

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

Finishes an animation item.

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

Starts (launches) animation item.

KANZI_API kzsError kzuAnimationItemClearCache

(

const struct KzuAnimationItem *

animationItem

)

Clears the animation item caches.

KANZI_API kzFloat kzuAnimationItemGetDuration

(

const struct KzuAnimationItem *

animationItem

)

Gets duration of the animation item.

KANZI_API void kzuAnimationItemSetChangeFlag	(	struct KzuAnimationItem *	animationItem,
		kzBool	isSet
	)

Sets change flag for animation item.

KANZI_API kzBool kzuAnimationItemIsChangeFlagSet

(

const struct KzuAnimationItem *

animationItem

)

Returns if animation item change flag is set.