kzu_animation_util.h File Reference

Animation utilities Utility functions for specifying animations. More...

#include <user/properties/kzu_property_common.h>
#include "kzu_animation_key.h"
#include <system/debug/kzs_error.h>
#include <system/kzs_types.h>
#include <system/kzs_header.h>

Enumerations
enum	KzuPropertyBinaryDataType { KZU_BINARY_DATA_TYPE_FLOAT, KZU_BINARY_DATA_TYPE_TEXTURE, KZU_BINARY_DATA_TYPE_MATRIX4X4 }
	Binary container type. More...
enum	KzuPropertyBinaryTargetAttribute {   KZU_PROPERTY_BINARY_TARGET_ATTRIBUTE_TRANSLATION_X, KZU_PROPERTY_BINARY_TARGET_ATTRIBUTE_TRANSLATION_Y, KZU_PROPERTY_BINARY_TARGET_ATTRIBUTE_TRANSLATION_Z, KZU_PROPERTY_BINARY_TARGET_ATTRIBUTE_SCALE_X,   KZU_PROPERTY_BINARY_TARGET_ATTRIBUTE_SCALE_Y, KZU_PROPERTY_BINARY_TARGET_ATTRIBUTE_SCALE_Z, KZU_PROPERTY_BINARY_TARGET_ATTRIBUTE_ROTATION_Z, KZU_PROPERTY_BINARY_TARGET_ATTRIBUTE_ROTATION_Y,   KZU_PROPERTY_BINARY_TARGET_ATTRIBUTE_ROTATION_X, KZU_PROPERTY_BINARY_TARGET_ATTRIBUTE_WHOLE_PROPERTY, KZU_PROPERTY_BINARY_TARGET_ATTRIBUTE_COLOR_R, KZU_PROPERTY_BINARY_TARGET_ATTRIBUTE_COLOR_G,   KZU_PROPERTY_BINARY_TARGET_ATTRIBUTE_COLOR_B, KZU_PROPERTY_BINARY_TARGET_ATTRIBUTE_COLOR_A, KZU_PROPERTY_BINARY_TARGET_ATTRIBUTE_VECTOR_X, KZU_PROPERTY_BINARY_TARGET_ATTRIBUTE_VECTOR_Y,   KZU_PROPERTY_BINARY_TARGET_ATTRIBUTE_VECTOR_Z, KZU_PROPERTY_BINARY_TARGET_ATTRIBUTE_VECTOR_W }
	Binary target attribute type. More...

Functions
kzsError	kzuAnimationItemCreateColorAnimation (struct KzuUIDomain *uiDomain, kzString relativePath, const struct KzuPropertyType *propertyType, const struct KzcColorRGBA *colorStart, const struct KzcColorRGBA *colorEnd, kzFloat duration, enum KzuAnimationInterpolation interpolation, struct KzuAnimationItem **out_animationItem)
	Creates target color animation item. More...
kzsError	kzuAnimationItemCreateVector3Animation (struct KzuUIDomain *uiDomain, kzString relativePath, const struct KzuPropertyType *propertyType, const struct KzcVector3 *positionStart, const struct KzcVector3 *positionEnd, kzFloat duration, enum KzuAnimationInterpolation interpolation, struct KzuAnimationItem **out_animationItem)
	Creates vector3 animation item. More...
kzsError	kzuAnimationItemCreateFloatAnimation (struct KzuUIDomain *uiDomain, kzString relativePath, const struct KzuPropertyType *propertyType, kzFloat valueStart, kzFloat valueEnd, kzFloat duration, enum KzuAnimationInterpolation interpolation, struct KzuAnimationItem **out_animationItem)
	Creates target float animation item. More...
kzsError	kzuAnimationItemCreateMatrix3x3Animation (struct KzuUIDomain *uiDomain, kzString relativePath, const struct KzuPropertyType *propertyType, const struct KzcMatrix3x3 *valueStart, const struct KzcMatrix3x3 *valueEnd, kzFloat duration, enum KzuAnimationInterpolation interpolation, struct KzuAnimationItem **out_animationItem)
	Creates target matrix3x3 animation item. More...
kzsError	kzuAnimationItemCreateMatrix3x3AnimationSRT (struct KzuUIDomain *uiDomain, kzString relativePath, const struct KzuPropertyType *propertyType, const struct KzcVector2 *scaleStart, kzFloat rotateStart, const struct KzcVector2 *translationStart, const struct KzcVector2 *scaleEnd, kzFloat rotateEnd, const struct KzcVector2 *translationEnd, kzFloat duration, enum KzuAnimationInterpolation interpolation, struct KzuAnimationItem **out_animationItem)
	Creates target matrix3x3 animation item. More...
kzsError	kzuAnimationItemCreateMatrix4x4Animation (struct KzuUIDomain *uiDomain, kzString relativePath, const struct KzuPropertyType *propertyType, const struct KzcMatrix4x4 *valueStart, const struct KzcMatrix4x4 *valueEnd, kzFloat duration, enum KzuAnimationInterpolation interpolation, struct KzuAnimationItem **out_animationItem)
	Creates target matrix4x4 animation item. More...
kzsError	kzuAnimationItemCreateMatrix4x4SRTAnimation (struct KzuUIDomain *uiDomain, kzString relativePath, const struct KzuPropertyType *propertyType, const struct KzcVector3 *scaleStart, const struct KzcVector3 *rotationStart, const struct KzcVector3 *translationStart, const struct KzcVector3 *scaleEnd, const struct KzcVector3 *rotationEnd, const struct KzcVector3 *translationEnd, kzFloat duration, enum KzuAnimationInterpolation interpolation, struct KzuAnimationItem **out_animationItem)
	Creates target matrix4x4 animation item. More...
kzsError	kzuPropertyBinaryTargetAttributeConvertToBinaryDataType (const struct KzuPropertyType *propertyType, enum KzuPropertyBinaryTargetAttribute targetAttribute, enum KzuPropertyBinaryDataType *out_binaryDataType)
	Find out corresponding binary data type for binary target attribute. More...
kzsError	kzuPropertyBinaryTargetAttributeConvertToTargetAttribute (const struct KzuPropertyType *propertyType, enum KzuPropertyBinaryTargetAttribute binaryTargetAttribute, enum KzuPropertyField *out_targetAttribute)
	Find out corresponding target attribute for binary target attribute. More...

Detailed Description

Animation utilities Utility functions for specifying animations.

Copyright 2008-2019 by Rightware. All rights reserved.

Enumeration Type Documentation

enum KzuPropertyBinaryDataType

Binary container type.

Enumerator
KZU_BINARY_DATA_TYPE_FLOAT
KZU_BINARY_DATA_TYPE_TEXTURE
KZU_BINARY_DATA_TYPE_MATRIX4X4

enum KzuPropertyBinaryTargetAttribute

Binary target attribute type.

Enumerator
KZU_PROPERTY_BINARY_TARGET_ATTRIBUTE_TRANSLATION_X
KZU_PROPERTY_BINARY_TARGET_ATTRIBUTE_TRANSLATION_Y
KZU_PROPERTY_BINARY_TARGET_ATTRIBUTE_TRANSLATION_Z
KZU_PROPERTY_BINARY_TARGET_ATTRIBUTE_SCALE_X
KZU_PROPERTY_BINARY_TARGET_ATTRIBUTE_SCALE_Y
KZU_PROPERTY_BINARY_TARGET_ATTRIBUTE_SCALE_Z
KZU_PROPERTY_BINARY_TARGET_ATTRIBUTE_ROTATION_Z
KZU_PROPERTY_BINARY_TARGET_ATTRIBUTE_ROTATION_Y
KZU_PROPERTY_BINARY_TARGET_ATTRIBUTE_ROTATION_X
KZU_PROPERTY_BINARY_TARGET_ATTRIBUTE_WHOLE_PROPERTY
KZU_PROPERTY_BINARY_TARGET_ATTRIBUTE_COLOR_R
KZU_PROPERTY_BINARY_TARGET_ATTRIBUTE_COLOR_G
KZU_PROPERTY_BINARY_TARGET_ATTRIBUTE_COLOR_B
KZU_PROPERTY_BINARY_TARGET_ATTRIBUTE_COLOR_A
KZU_PROPERTY_BINARY_TARGET_ATTRIBUTE_VECTOR_X
KZU_PROPERTY_BINARY_TARGET_ATTRIBUTE_VECTOR_Y
KZU_PROPERTY_BINARY_TARGET_ATTRIBUTE_VECTOR_Z
KZU_PROPERTY_BINARY_TARGET_ATTRIBUTE_VECTOR_W

Function Documentation

kzsError kzuAnimationItemCreateColorAnimation	(	struct KzuUIDomain *	uiDomain,
		kzString	relativePath,
		const struct KzuPropertyType *	propertyType,
		const struct KzcColorRGBA *	colorStart,
		const struct KzcColorRGBA *	colorEnd,
		kzFloat	duration,
		enum KzuAnimationInterpolation	interpolation,
		struct KzuAnimationItem **	out_animationItem
	)

Creates target color animation item.

kzsError kzuAnimationItemCreateVector3Animation	(	struct KzuUIDomain *	uiDomain,
		kzString	relativePath,
		const struct KzuPropertyType *	propertyType,
		const struct KzcVector3 *	positionStart,
		const struct KzcVector3 *	positionEnd,
		kzFloat	duration,
		enum KzuAnimationInterpolation	interpolation,
		struct KzuAnimationItem **	out_animationItem
	)

Creates vector3 animation item.

kzsError kzuAnimationItemCreateFloatAnimation	(	struct KzuUIDomain *	uiDomain,
		kzString	relativePath,
		const struct KzuPropertyType *	propertyType,
		kzFloat	valueStart,
		kzFloat	valueEnd,
		kzFloat	duration,
		enum KzuAnimationInterpolation	interpolation,
		struct KzuAnimationItem **	out_animationItem
	)

Creates target float animation item.

kzsError kzuAnimationItemCreateMatrix3x3Animation	(	struct KzuUIDomain *	uiDomain,
		kzString	relativePath,
		const struct KzuPropertyType *	propertyType,
		const struct KzcMatrix3x3 *	valueStart,
		const struct KzcMatrix3x3 *	valueEnd,
		kzFloat	duration,
		enum KzuAnimationInterpolation	interpolation,
		struct KzuAnimationItem **	out_animationItem
	)

Creates target matrix3x3 animation item.

kzsError kzuAnimationItemCreateMatrix3x3AnimationSRT	(	struct KzuUIDomain *	uiDomain,
		kzString	relativePath,
		const struct KzuPropertyType *	propertyType,
		const struct KzcVector2 *	scaleStart,
		kzFloat	rotateStart,
		const struct KzcVector2 *	translationStart,
		const struct KzcVector2 *	scaleEnd,
		kzFloat	rotateEnd,
		const struct KzcVector2 *	translationEnd,
		kzFloat	duration,
		enum KzuAnimationInterpolation	interpolation,
		struct KzuAnimationItem **	out_animationItem
	)

Creates target matrix3x3 animation item.

kzsError kzuAnimationItemCreateMatrix4x4Animation	(	struct KzuUIDomain *	uiDomain,
		kzString	relativePath,
		const struct KzuPropertyType *	propertyType,
		const struct KzcMatrix4x4 *	valueStart,
		const struct KzcMatrix4x4 *	valueEnd,
		kzFloat	duration,
		enum KzuAnimationInterpolation	interpolation,
		struct KzuAnimationItem **	out_animationItem
	)

Creates target matrix4x4 animation item.

kzsError kzuAnimationItemCreateMatrix4x4SRTAnimation	(	struct KzuUIDomain *	uiDomain,
		kzString	relativePath,
		const struct KzuPropertyType *	propertyType,
		const struct KzcVector3 *	scaleStart,
		const struct KzcVector3 *	rotationStart,
		const struct KzcVector3 *	translationStart,
		const struct KzcVector3 *	scaleEnd,
		const struct KzcVector3 *	rotationEnd,
		const struct KzcVector3 *	translationEnd,
		kzFloat	duration,
		enum KzuAnimationInterpolation	interpolation,
		struct KzuAnimationItem **	out_animationItem
	)

Creates target matrix4x4 animation item.

kzsError kzuPropertyBinaryTargetAttributeConvertToBinaryDataType	(	const struct KzuPropertyType *	propertyType,
		enum KzuPropertyBinaryTargetAttribute	targetAttribute,
		enum KzuPropertyBinaryDataType *	out_binaryDataType
	)

Find out corresponding binary data type for binary target attribute.

kzsError kzuPropertyBinaryTargetAttributeConvertToTargetAttribute	(	const struct KzuPropertyType *	propertyType,
		enum KzuPropertyBinaryTargetAttribute	binaryTargetAttribute,
		enum KzuPropertyField *	out_targetAttribute
	)

Find out corresponding target attribute for binary target attribute.