kzu_animation_item_base.h File Reference

Animation item Private functions of base class for animations, clips and timeline. More...

#include "kzu_animation_item.h"
#include <user/resource/kzu_resource_base.h>
#include <system/debug/kzs_error.h>
#include <system/kzs_types.h>
#include <system/kzs_header.h>

Data Structures
struct	KzuAnimationItemClass
	Defines functions for different object node types. More...
struct	KzuAnimationItem
	Structure for animation item. More...

Typedefs
typedef kzsError(*	KzuAnimationItemUpdateFunction )(struct KzuAnimationPlayer *animationPlayer, const struct KzuAnimationItem *animationItem, kzFloat time)
	Function type of update function for the animation. More...
typedef kzsError(*	KzuAnimationItemPrepareFunction )(struct KzuAnimationPlayer *animationPlayer, const struct KzuAnimationItem *animationItem)
	Function type to prepare animation item to be updated. More...
typedef kzFloat(*	KzuAnimationItemGetDurationFunction )(const struct KzuAnimationItem *animationItem)
	Function type to get duration of the animation item. More...
typedef kzsError(*	KzuAnimationItemFinishFunction )(struct KzuAnimationPlayer *animationPlayer, const struct KzuAnimationItem *animationItem)
	Function type to finish animation item, i.e. More...
typedef kzsError(*	KzuAnimationItemDeleteFunction )(struct KzuAnimationItem *animationItem)
	Function type to delete animation item. More...
typedef kzsError(*	KzuAnimationItemStartFunction )(struct KzuAnimationPlayer *animationPlayer, const struct KzuAnimationItem *animationItem)
	Function type start animation item. More...
typedef kzsError(*	KzuAnimationItemClearCacheFunction )(const struct KzuAnimationItem *animationItem)
	Function type to clear animation item cache. More...

Functions
kzsError	kzuAnimationItemCreate_protected (struct KzuAnimationItem *animationItem, struct KzuUIDomain *uiDomain, enum KzuAnimationItemType type, kzString name, const struct KzuAnimationItemClass *itemClass)
	Creates new animation item. More...
kzsError	kzuAnimationItemDelete_protected (struct KzuAnimationItem *animationItem)
	Deletes animation item. More...
void	kzuAnimationItemSetUIDomain_protected (struct KzuAnimationItem *animationItem, struct KzuUIDomain *uiDomain)
	Sets UI domain to animation item. More...

Detailed Description

Animation item Private functions of base class for animations, clips and timeline.

Copyright 2008-2019 by Rightware. All rights reserved.

Typedef Documentation

typedef kzsError(* KzuAnimationItemUpdateFunction)(struct KzuAnimationPlayer *animationPlayer, const struct KzuAnimationItem *animationItem, kzFloat time)

Function type of update function for the animation.

typedef kzsError(* KzuAnimationItemPrepareFunction)(struct KzuAnimationPlayer *animationPlayer, const struct KzuAnimationItem *animationItem)

Function type to prepare animation item to be updated.

typedef kzFloat(* KzuAnimationItemGetDurationFunction)(const struct KzuAnimationItem *animationItem)

Function type to get duration of the animation item.

typedef kzsError(* KzuAnimationItemFinishFunction)(struct KzuAnimationPlayer *animationPlayer, const struct KzuAnimationItem *animationItem)

Function type to finish animation item, i.e.

animation item ends.

typedef kzsError(* KzuAnimationItemDeleteFunction)(struct KzuAnimationItem *animationItem)

Function type to delete animation item.

typedef kzsError(* KzuAnimationItemStartFunction)(struct KzuAnimationPlayer *animationPlayer, const struct KzuAnimationItem *animationItem)

Function type start animation item.

typedef kzsError(* KzuAnimationItemClearCacheFunction)(const struct KzuAnimationItem *animationItem)

Function type to clear animation item cache.

Function Documentation

kzsError kzuAnimationItemCreate_protected	(	struct KzuAnimationItem *	animationItem,
		struct KzuUIDomain *	uiDomain,
		enum KzuAnimationItemType	type,
		kzString	name,
		const struct KzuAnimationItemClass *	itemClass
	)

Creates new animation item.

kzsError kzuAnimationItemDelete_protected

(

struct KzuAnimationItem *

animationItem)

Deletes animation item.

void kzuAnimationItemSetUIDomain_protected	(	struct KzuAnimationItem *	animationItem,
		struct KzuUIDomain *	uiDomain
	)

Sets UI domain to animation item.