Package com.ardor3d.extension.animation.skeletal.clip

Class InterpolatedFloatChannel

java.lang.Object

com.ardor3d.extension.animation.skeletal.clip.AbstractAnimationChannel

com.ardor3d.extension.animation.skeletal.clip.InterpolatedFloatChannel

All Implemented Interfaces:

Savable

public class InterpolatedFloatChannel
extends AbstractAnimationChannel

An animation source channel consisting of float value samples. These samples are interpolated between key frames. Potential uses for this channel include extracting and using forward motion from walk animations, animating colors or texture coordinates, etc.

Field Summary

Fields

Modifier and Type	Field	Description
protected final float[]	_values	Our key samples.

Fields inherited from class com.ardor3d.extension.animation.skeletal.clip.AbstractAnimationChannel

_channelName, _times

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	InterpolatedFloatChannel()
	InterpolatedFloatChannel(String channelName, float[] times, float[] values)	Construct a new InterpolatedFloatChannel.

Method Summary

Modifier and Type	Method	Description
float[]	createStateDataObject(AnimationClipInstance instance)
Class<? extends InterpolatedFloatChannel>	getClassTag()
InterpolatedFloatChannel	getSubchannelBySample(String name, int startSample, int endSample)	Returns a new channel of the same content as this, but trimmed to just the times between start and end sample.
InterpolatedFloatChannel	getSubchannelByTime(String name, float startTime, float endTime)	Returns a new channel of the same content as this, but trimmed to just the times between start and end sample.
float[]	getValues()
static InterpolatedFloatChannel	initSavable()
void	read(InputCapsule capsule)
void	setCurrentSample(int sampleIndex, double progressPercent, Object applyTo)	Sets data on the given applyTo Object for the given sampleIndex and a percent progress towards the sample following it.
void	write(OutputCapsule capsule)

Methods inherited from class com.ardor3d.extension.animation.skeletal.clip.AbstractAnimationChannel

getChannelName, getMaxTime, getSampleCount, getSubchannelBySample, getSubchannelByTime, getTimes, updateSample

Methods inherited from class java.lang.Object

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

Field Details

_values

protected final float[] _values

Our key samples.

Constructor Details

InterpolatedFloatChannel

public InterpolatedFloatChannel(String channelName,
 float[] times,
 float[] values)

Construct a new InterpolatedFloatChannel.

Parameters:

channelName - the name of this channel.

times - the time samples

values - our value samples. Entries may be null. Should have as many entries as the times array.

InterpolatedFloatChannel

protected InterpolatedFloatChannel()

Method Details

getValues

public float[] getValues()

setCurrentSample

public void setCurrentSample(int sampleIndex,
 double progressPercent,
 Object applyTo)

Description copied from class: AbstractAnimationChannel

Sets data on the given applyTo Object for the given sampleIndex and a percent progress towards the sample following it.

Specified by:

setCurrentSample in class AbstractAnimationChannel

Parameters:

sampleIndex - the sample to pull information from.

progressPercent - a value [0.0, 1.0] representing progress from sampleIndex to sampleIndex+1

applyTo - the data object to apply this channel's information to.

createStateDataObject

public float[] createStateDataObject(AnimationClipInstance instance)

Specified by:

createStateDataObject in class AbstractAnimationChannel

Parameters:

instance - the instance creating and storing the state data object.

Returns:

an Object suitable for storing information for this type of animation channel.

getSubchannelBySample

public InterpolatedFloatChannel getSubchannelBySample(String name,
 int startSample,
 int endSample)

Description copied from class: AbstractAnimationChannel

Returns a new channel of the same content as this, but trimmed to just the times between start and end sample.

Specified by:

getSubchannelBySample in class AbstractAnimationChannel

Parameters:

name - the new name for our subchannel.

startSample - the sample to start with (inclusive). Sample counting starts at 0.

endSample - the sample to end with (inclusive). max is getSampleCount() - 1.

Returns:

the new channel.

getSubchannelByTime

public InterpolatedFloatChannel getSubchannelByTime(String name,
 float startTime,
 float endTime)

Description copied from class: AbstractAnimationChannel

Returns a new channel of the same content as this, but trimmed to just the times between start and end sample.

Specified by:

getSubchannelByTime in class AbstractAnimationChannel

Parameters:

name - the new name for our subchannel.

startTime - the time to start with (inclusive)

endTime - the time to end with (inclusive)

Returns:

the new channel.

getClassTag

public Class<? extends InterpolatedFloatChannel> getClassTag()

write

public void write(OutputCapsule capsule)
           throws IOException

Specified by:

write in interface Savable

Overrides:

write in class AbstractAnimationChannel

Throws:

IOException

read

public void read(InputCapsule capsule)
          throws IOException

Specified by:

read in interface Savable

Overrides:

read in class AbstractAnimationChannel

Throws:

IOException

initSavable

public static InterpolatedFloatChannel initSavable()