com.bonzaiengine.animation

Class KeyFrame<T extends IData<T>>

java.lang.Object

com.bonzaiengine.animation.KeyFrame<T>

All Implemented Interfaces:

java.lang.Cloneable, java.lang.Iterable<KeyData<T>>

Direct Known Subclasses:

KeyFramePercent, KeyFrameTransform

public class KeyFrame<T extends IData<T>>
extends java.lang.Object
implements java.lang.Cloneable, java.lang.Iterable<KeyData<T>>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	KeyFrame.ICompressorRule<T extends IData<T>>

Constructor Summary

Constructors

Constructor and Description
KeyFrame()
KeyFrame(int initialCapacity)

Method Summary

Modifier and Type	Method and Description
void	clear() Remove all keys
KeyFrame<T>	clone()
int	compress(KeyFrame.ICompressorRule<T> rule) KeyFrame compression used by the Optimizer.
float	getEndTime()
KeyData<T>	getIndex(int index) The implementation is free to return a copy or the actual object.
int	getKeyIndexAfter(float time)
int	getKeyIndexBefore(float time)
boolean	getKeyRange(KeyRange<T> dst, AnimNode node)
boolean	getKeyRange(KeyRange<T> dst, float time)
float	getStartTime()
float	getTimeAt(int index)
void	getValue(T dst, AnimNode node)
void	getValue(T dst, float time)
T	getValueAt(int index)
int	insert(float time, T value)
int	insert(KeyData<T> keyData)
void	insertOrdered(float time, T value, int index)
int	insertTimes(java.util.Set<java.lang.Float> timesSet)
boolean	isEmpty()
java.util.Iterator<KeyData<T>>	iterator()
void	listKeyTimes(java.util.Set<java.lang.Float> timesSet)
void	listKeyTimes(java.util.Set<java.lang.Float> timesSet, Animation anim)
void	offsetTime(float timeOffset)
static KeyFrame	read(ByteInputStream in)
KeyData<T>	removeIndex(int index)
void	set(KeyFrame<T> src)
boolean	setIndex(int index, KeyData<T> keyData)
void	setValueAt(int index, T value)
int	size()
KeyFrame<T>	subRange(float startTime, float endTime)
KeyFrame<T>	subRange(int startIndex, int endIndex)
void	trimToSize()
static void	write(ByteOutputStream out, KeyFrame<?> keys, java.lang.Class<?> c)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

KeyFrame

public KeyFrame()

KeyFrame

public KeyFrame(int initialCapacity)

Parameters:

initialCapacity - initial size of the vector of keys.
Default is 1.

Method Detail

read

public static final KeyFrame read(ByteInputStream in)
                           throws java.io.IOException

Throws:

java.io.IOException

write

public static final void write(ByteOutputStream out,
                               KeyFrame<?> keys,
                               java.lang.Class<?> c)
                        throws java.io.IOException

Throws:

java.io.IOException

clone

public final KeyFrame<T> clone()

Overrides:

clone in class java.lang.Object

set

public final void set(KeyFrame<T> src)

iterator

public final java.util.Iterator<KeyData<T>> iterator()

Specified by:

iterator in interface java.lang.Iterable<KeyData<T extends IData<T>>>

size

public final int size()

Returns:

the number of keys

isEmpty

public final boolean isEmpty()

Returns:

true if the size is 0

insert

public final int insert(KeyData<T> keyData)

Parameters:

keyData - KeyData to insert

Returns:

the index of the keyData, -1 if the KeyData time already exist in this

insert

public final int insert(float time,
                        T value)

Parameters:

time - time of the key to insert

value - value of the key to insert

Returns:

the index of the keyData, -1 if the KeyData time already exist in this

insertOrdered

public final void insertOrdered(float time,
                                T value,
                                int index)

Parameters:

time - time of the key to insert

value - value of the key to insert

subRange

public final KeyFrame<T> subRange(float startTime,
                                  float endTime)

Returns:

KeyFrame containing the subRange [startTime; endTime]

subRange

public KeyFrame<T> subRange(int startIndex,
                            int endIndex)

Returns:

KeyFrame containing the key between the indices [startIndex; endIndex]

offsetTime

public final void offsetTime(float timeOffset)

clear

public final void clear()

Remove all keys

trimToSize

public final void trimToSize()

getIndex

public final KeyData<T> getIndex(int index)

The implementation is free to return a copy or the actual object.
If you modify the KeyData, use setIndex(int, KeyData) to reflect the changes.

Parameters:

index - an indes in the range of [0,size()[

Returns:

the KeyData requested

getValueAt

public final T getValueAt(int index)

Returns:

the value at the specified index

getTimeAt

public final float getTimeAt(int index)

Returns:

the value at the specified index

setIndex

public final boolean setIndex(int index,
                              KeyData<T> keyData)

Parameters:

index - an indes in the range of [0,size()[

Returns:

the KeyData requested

setValueAt

public final void setValueAt(int index,
                             T value)

Parameters:

value - set the value at the specified index

removeIndex

public final KeyData<T> removeIndex(int index)

Parameters:

index - an indes in the range of [0,size()[

Returns:

the KeyData removed

getStartTime

public final float getStartTime()

Returns:

the first time. This KeyFrame must contains at least one element

getEndTime

public final float getEndTime()

Returns:

the last time. This KeyFrame must contains at least one element

getValue

public final void getValue(T dst,
                           float time)

getValue

public final void getValue(T dst,
                           AnimNode node)

getKeyRange

public final boolean getKeyRange(KeyRange<T> dst,
                                 float time)

Parameters:

time - time in seconds

dst - destination KeyRange to store result.

Returns:

true if destination has changed

getKeyRange

public final boolean getKeyRange(KeyRange<T> dst,
                                 AnimNode node)

Parameters:

dst - destination KeyRange to store result.

track -

Returns:

KeyRange to store result.

getKeyIndexBefore

public final int getKeyIndexBefore(float time)

Parameters:

time -

Returns:

return the key before the specified time.
Note: if no key exists before the specified time, it will return the closest key

getKeyIndexAfter

public final int getKeyIndexAfter(float time)

Parameters:

time -

Returns:

return the key after the specified time
Note: if no key exists before the specified time, it will return the closest key

listKeyTimes

public void listKeyTimes(java.util.Set<java.lang.Float> timesSet)

Parameters:

timesSet - set to contains the list of times of this KeyFrame

listKeyTimes

public void listKeyTimes(java.util.Set<java.lang.Float> timesSet,
                         Animation anim)

Parameters:

anim - animation to list times

timesSet - set to contains the list of times for the anim of this KeyFrame

insertTimes

public final int insertTimes(java.util.Set<java.lang.Float> timesSet)

Parameters:

timesSet - list of times to insert in this KeyFrame.
On insertion, value is interpolated

Returns:

number of key inserted

compress

public int compress(KeyFrame.ICompressorRule<T> rule)

KeyFrame compression used by the Optimizer.

Parameters:

rule - compression rule

Returns:

number of keys eliminated during the compression process

See Also:

Optimizer