Animation sequence. More...
#include "kzu_animation_item_base.h"#include <system/kzs_types.h>#include <system/debug/kzs_error.h>Classes | |
| struct | KzuTimeLineSequence |
| A sequence of animation to play. More... | |
Namespaces | |
| kanzi | |
Typedefs | |
| typedef shared_ptr < KzuTimeLineSequence > | kanzi::TimeLineSequenceSharedPtr |
Functions | |
| KANZI_API kzsError | kzuTimeLineSequenceCreate (kanzi::Domain *domain, struct KzuTimeLineSequence **out_timeLineSequence) |
| Creates new time line sequence. More... | |
| KANZI_API kanzi::TimeLineSequenceSharedPtr | kzuTimeLineSequenceCreate (kanzi::Domain *domain) |
| Creates new time line sequence. More... | |
| KANZI_API kzsError | kzuTimeLineSequenceLoadFromKZB (struct KzuTimeLineSequence *timeLineSequence, struct KzcInputStream *inputStream, const struct KzuBinaryFileInfo *file) |
| Loads time line sequence from KZB. More... | |
| KANZI_API kzsError | kzuTimeLineSequenceUpdate (struct KzuAnimationPlayer *player, const struct KzuTimeLineSequence *timeLineEntry, kzFloat time) |
| Updates animation in the time line sequence. More... | |
| KANZI_API kzsError | kzuTimeLineSequenceSortAnimations (const struct KzuTimeLineSequence *sequence) |
| Sorts the animations the animation sequence. More... | |
| KANZI_API kzsError | kzuTimeLineSequenceAddEntry (KzuTimeLineSequence *sequence, struct KzuTimeLineEntry *timeLineEntry) |
| Adds new time line entry to the sequence. More... | |
| KANZI_API kzBool | kzuTimeLineSequenceContainsEntry (const struct KzuTimeLineSequence *sequence, const struct KzuTimeLineEntry *timeLineEntry) |
| Returns KZ_TRUE if sequence contains given KzuTimeLineEntry. More... | |
| KANZI_API kzsError | kzuTimeLineSequenceRemoveEntry (KzuTimeLineSequence *sequence, struct KzuTimeLineEntry *timeLineEntry) |
| Removes a time line entry from sequence. More... | |
| KANZI_API kzBool | kzuTimeLineSequenceContainsAnimationItem (const struct KzuTimeLineSequence *sequence, const struct KzuAnimationItem *animationItem) |
| Returns KZ_TRUE if sequence contains given KzuAnimationItem. More... | |
| KANZI_API kzsError | kzuTimeLineSequenceRemoveAnimationItem (KzuTimeLineSequence *sequence, const struct KzuAnimationItem *animationClip) |
| Removes timeline entry containing animation item. More... | |
| KANZI_API kzUint | kzuTimeLineSequenceGetActiveTimeLineEntryCount (const struct KzuTimeLineSequence *sequence, kzFloat time) |
| Gets the active animation count on given time from given time line. More... | |
| KANZI_API kzsError | kzuTimeLineSequenceRemoveAllTimeLineEntries (const struct KzuTimeLineSequence *sequence) |
| Removes all time line entries from the sequence. More... | |
| KANZI_API kzFloat | kzuTimeLineSequenceGetDuration (const struct KzuTimeLineSequence *sequence) |
| Gets duration of the time line sequence. More... | |
| KANZI_API struct KzuTimeLineEntry * | kzuTimeLineSequenceGetEntryAtIndex (const struct KzuTimeLineSequence *sequence, kzUint index) |
| Gets entry at given index from sequence, KZ_NULL if not found. More... | |
| KANZI_API kzUint | kzuTimeLineSequenceGetEntryCount (const struct KzuTimeLineSequence *sequence) |
| Gets number of entries from timeline sequence. More... | |
| KANZI_API 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... | |
| KANZI_API kzsError | kzuTimeLineSequenceRemoveEntryFromTimeLine_private (const struct KzuTimeLineSequence *timeLineSequence, const struct KzuTimeLineEntry *timeLineEntry) |
| Removes entry from timeline. More... | |
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.
Copyright 2008-2020 by Rightware. All rights reserved.
| KANZI_API kzsError kzuTimeLineSequenceCreate | ( | kanzi::Domain * | domain, |
| struct KzuTimeLineSequence ** | out_timeLineSequence | ||
| ) |
Creates new time line sequence.
| KANZI_API kanzi::TimeLineSequenceSharedPtr kzuTimeLineSequenceCreate | ( | kanzi::Domain * | domain | ) |
Creates new time line sequence.
| KANZI_API kzsError kzuTimeLineSequenceLoadFromKZB | ( | struct KzuTimeLineSequence * | timeLineSequence, |
| struct KzcInputStream * | inputStream, | ||
| const struct KzuBinaryFileInfo * | file | ||
| ) |
Loads time line sequence from KZB.
| KANZI_API kzsError kzuTimeLineSequenceUpdate | ( | struct KzuAnimationPlayer * | player, |
| const struct KzuTimeLineSequence * | timeLineEntry, | ||
| kzFloat | time | ||
| ) |
Updates animation in the time line sequence.
| KANZI_API kzsError kzuTimeLineSequenceSortAnimations | ( | const struct KzuTimeLineSequence * | sequence | ) |
Sorts the animations the animation sequence.
This function must be called if starting times of animations are modified.
| KANZI_API kzsError kzuTimeLineSequenceAddEntry | ( | 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.
| KANZI_API kzBool kzuTimeLineSequenceContainsEntry | ( | const struct KzuTimeLineSequence * | sequence, |
| const struct KzuTimeLineEntry * | timeLineEntry | ||
| ) |
Returns KZ_TRUE if sequence contains given KzuTimeLineEntry.
KZ_FALSE if does not.
| KANZI_API kzsError kzuTimeLineSequenceRemoveEntry | ( | KzuTimeLineSequence * | sequence, |
| struct KzuTimeLineEntry * | timeLineEntry | ||
| ) |
Removes a time line entry from sequence.
Returns error if element is not found.
| KANZI_API kzBool kzuTimeLineSequenceContainsAnimationItem | ( | const struct KzuTimeLineSequence * | sequence, |
| const struct KzuAnimationItem * | animationItem | ||
| ) |
Returns KZ_TRUE if sequence contains given KzuAnimationItem.
KZ_FALSE if does not.
| KANZI_API kzsError kzuTimeLineSequenceRemoveAnimationItem | ( | 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.
| KANZI_API kzUint kzuTimeLineSequenceGetActiveTimeLineEntryCount | ( | const struct KzuTimeLineSequence * | sequence, |
| kzFloat | time | ||
| ) |
Gets the active animation count on given time from given time line.
| KANZI_API kzsError kzuTimeLineSequenceRemoveAllTimeLineEntries | ( | const struct KzuTimeLineSequence * | sequence | ) |
Removes all time line entries from the sequence.
| KANZI_API kzFloat kzuTimeLineSequenceGetDuration | ( | const struct KzuTimeLineSequence * | sequence | ) |
Gets duration of the time line sequence.
| KANZI_API struct KzuTimeLineEntry* kzuTimeLineSequenceGetEntryAtIndex | ( | const struct KzuTimeLineSequence * | sequence, |
| kzUint | index | ||
| ) |
Gets entry at given index from sequence, KZ_NULL if not found.
| KANZI_API kzUint kzuTimeLineSequenceGetEntryCount | ( | const struct KzuTimeLineSequence * | sequence | ) |
Gets number of entries from timeline sequence.
| KANZI_API 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.
| KANZI_API kzsError kzuTimeLineSequenceRemoveEntryFromTimeLine_private | ( | const struct KzuTimeLineSequence * | timeLineSequence, |
| const struct KzuTimeLineEntry * | timeLineEntry | ||
| ) |
Removes entry from timeline.