kzu_time_line_sequence.h File Reference

Animation sequence. More...

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

Functions
kzsError	kzuTimeLineSequenceCreate (const struct KzcMemoryManager *memoryManager, struct KzuUIDomain *uiDomain, struct KzuTimeLineSequence **out_timeLineSequence)
	Creates new time line sequence. More...
kzsError	kzuTimeLineSequenceLoadFromKZB (struct KzuTimeLineSequence *timeLineSequence, struct KzcInputStream *inputStream, const struct KzuBinaryFileInfo *file)
	Loads time line sequence from KZB. More...
kzsError	kzuTimeLineSequenceUpdate (struct KzuAnimationPlayer *player, const struct KzuTimeLineSequence *timeLineEntry, kzFloat time)
	Updates animation in the time line sequence. More...
kzsError	kzuTimeLineSequenceSortAnimations (const struct KzuTimeLineSequence *sequence)
	Sorts the animations the animation sequence. More...
kzsError	kzuTimeLineSequenceAddEntry (struct KzuTimeLineSequence *sequence, struct KzuTimeLineEntry *timeLineEntry)
	Adds new time line entry to the sequence. More...
kzBool	kzuTimeLineSequenceContainsEntry (const struct KzuTimeLineSequence *sequence, const struct KzuTimeLineEntry *timeLineEntry)
	Returns KZ_TRUE if sequence contains given KzuTimeLineEntry. More...
kzsError	kzuTimeLineSequenceRemoveEntry (const struct KzuTimeLineSequence *sequence, struct KzuTimeLineEntry *timeLineEntry)
	Removes a time line entry from sequence. More...
kzBool	kzuTimeLineSequenceContainsAnimationItem (const struct KzuTimeLineSequence *sequence, const struct KzuAnimationItem *animationItem)
	Returns KZ_TRUE if sequence contains given KzuAnimationItem. More...
kzsError	kzuTimeLineSequenceRemoveAnimationItem (const struct KzuTimeLineSequence *sequence, const struct KzuAnimationItem *animationClip)
	Removes timeline entry containing animation item. More...
kzUint	kzuTimeLineSequenceGetActiveTimeLineEntryCount (const struct KzuTimeLineSequence *sequence, kzFloat time)
	Gets the active animation count on given time from given time line. More...
kzsError	kzuTimeLineSequenceRemoveAllTimeLineEntries (const struct KzuTimeLineSequence *sequence)
	Removes all time line entries from the sequence. More...
kzFloat	kzuTimeLineSequenceGetDuration (const struct KzuTimeLineSequence *sequence)
	Gets duration of the time line sequence. More...
struct KzuTimeLineEntry *	kzuTimeLineSequenceGetEntryAtIndex (const struct KzuTimeLineSequence *sequence, kzUint index)
	Gets entry at given index from sequence, KZ_NULL if not found. More...
kzUint	kzuTimeLineSequenceGetEntryCount (const struct KzuTimeLineSequence *sequence)
	Gets number of entries from timeline sequence. More...
kzsError	kzuTimeLineSequenceGetEntriesRecursively (const struct KzcMemoryManager *memoryManager, const struct KzuTimeLineSequence *sequence, struct KzcDynamicArray **out_dynamicArray)
	Gets the timeline entry array from the sequence recursively, including children if there's additional sequences as children. More...
struct KzuAnimationItem *	kzuTimeLineSequenceToAnimationItem (const struct KzuTimeLineSequence *timeLineSequence)
	Cast animation clip->animation item. More...
struct KzuTimeLineSequence *	kzuTimeLineSequenceFromAnimationItem (const struct KzuAnimationItem *animationItem)
	Cast animation item->animation clip. More...
kzsError	kzuTimeLineSequenceRemoveEntryFromTimeLine_private (const struct KzuTimeLineSequence *timeLineSequence, const struct KzuTimeLineEntry *timeLineEntry)
	Removes entry from timeline. More...

Detailed Description

Animation sequence.

A sequence of time line entries (KzuTimeLineEntry). Used to group several time line entries together for playback.

KzuTimeLineSequence inherits from KzuAnimationItem. This means KzuTimeLineSequence can be added to a KzuAnimationPlayer as one of the time line entries and a time line sequence can include other time line sequences.

See Also

kzu_animation_player.h.

Copyright 2008-2019 by Rightware. All rights reserved.

Function Documentation

kzsError kzuTimeLineSequenceCreate	(	const struct KzcMemoryManager *	memoryManager,
		struct KzuUIDomain *	uiDomain,
		struct KzuTimeLineSequence **	out_timeLineSequence
	)

Creates new time line sequence.

kzsError kzuTimeLineSequenceLoadFromKZB	(	struct KzuTimeLineSequence *	timeLineSequence,
		struct KzcInputStream *	inputStream,
		const struct KzuBinaryFileInfo *	file
	)

Loads time line sequence from KZB.

kzsError kzuTimeLineSequenceUpdate	(	struct KzuAnimationPlayer *	player,
		const struct KzuTimeLineSequence *	timeLineEntry,
		kzFloat	time
	)

Updates animation in the time line sequence.

kzsError kzuTimeLineSequenceSortAnimations

(

const struct KzuTimeLineSequence *

sequence)

Sorts the animations the animation sequence.

This function must be called if starting times of animations are modified.

kzsError kzuTimeLineSequenceAddEntry	(	struct KzuTimeLineSequence *	sequence,
		struct KzuTimeLineEntry *	timeLineEntry
	)

Adds new time line entry to the sequence.

The time line entry added to sequence should not be shared. After the call sequence takes ownership of the structure and deletes it upon deletion of the sequence.

kzBool kzuTimeLineSequenceContainsEntry	(	const struct KzuTimeLineSequence *	sequence,
		const struct KzuTimeLineEntry *	timeLineEntry
	)

Returns KZ_TRUE if sequence contains given KzuTimeLineEntry.

KZ_FALSE if does not.

kzsError kzuTimeLineSequenceRemoveEntry	(	const struct KzuTimeLineSequence *	sequence,
		struct KzuTimeLineEntry *	timeLineEntry
	)

Removes a time line entry from sequence.

Returns error if element is not found.

kzBool kzuTimeLineSequenceContainsAnimationItem	(	const struct KzuTimeLineSequence *	sequence,
		const struct KzuAnimationItem *	animationItem
	)

Returns KZ_TRUE if sequence contains given KzuAnimationItem.

KZ_FALSE if does not.

kzsError kzuTimeLineSequenceRemoveAnimationItem	(	const struct KzuTimeLineSequence *	sequence,
		const struct KzuAnimationItem *	animationClip
	)

Removes timeline entry containing animation item.

Returns error if not found. If there are multiple entries containing the given item, it will remove the first one found.

kzUint kzuTimeLineSequenceGetActiveTimeLineEntryCount	(	const struct KzuTimeLineSequence *	sequence,
		kzFloat	time
	)

Gets the active animation count on given time from given time line.

kzsError kzuTimeLineSequenceRemoveAllTimeLineEntries

(

const struct KzuTimeLineSequence *

sequence)

Removes all time line entries from the sequence.

kzFloat kzuTimeLineSequenceGetDuration

(

const struct KzuTimeLineSequence *

sequence)

Gets duration of the time line sequence.

struct KzuTimeLineEntry* kzuTimeLineSequenceGetEntryAtIndex	(	const struct KzuTimeLineSequence *	sequence,
		kzUint	index
	)

Gets entry at given index from sequence, KZ_NULL if not found.

kzUint kzuTimeLineSequenceGetEntryCount

(

const struct KzuTimeLineSequence *

sequence)

Gets number of entries from timeline sequence.

kzsError kzuTimeLineSequenceGetEntriesRecursively	(	const struct KzcMemoryManager *	memoryManager,
		const struct KzuTimeLineSequence *	sequence,
		struct KzcDynamicArray **	out_dynamicArray
	)

Gets the timeline entry array from the sequence recursively, including children if there's additional sequences as children.

struct KzuAnimationItem* kzuTimeLineSequenceToAnimationItem

(

const struct KzuTimeLineSequence *

timeLineSequence)

Cast animation clip->animation item.

struct KzuTimeLineSequence* kzuTimeLineSequenceFromAnimationItem

(

const struct KzuAnimationItem *

animationItem)

Cast animation item->animation clip.

kzsError kzuTimeLineSequenceRemoveEntryFromTimeLine_private	(	const struct KzuTimeLineSequence *	timeLineSequence,
		const struct KzuTimeLineEntry *	timeLineEntry
	)

Removes entry from timeline.