Package com.ardor3d.scenegraph.controller.interpolation

Class CurveInterpolationController

java.lang.Object

com.ardor3d.scenegraph.controller.ComplexSpatialController<Spatial>

com.ardor3d.scenegraph.controller.interpolation.InterpolationController<ReadOnlyVector3,Spatial>

com.ardor3d.scenegraph.controller.interpolation.Vector3InterpolationController

com.ardor3d.scenegraph.controller.interpolation.CurveInterpolationController

All Implemented Interfaces:

SpatialController<Spatial>, Savable, Serializable

public class CurveInterpolationController
extends Vector3InterpolationController

CurveInterpolationController class interpolates a Spatials vectors using a Curve.

This class is stateful and can not be used by more than one controller at a time.

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.ardor3d.scenegraph.controller.interpolation.Vector3InterpolationController

Vector3InterpolationController.UpdateField

Nested classes/interfaces inherited from class com.ardor3d.scenegraph.controller.ComplexSpatialController

ComplexSpatialController.RepeatType

Field Summary

Fields inherited from class com.ardor3d.scenegraph.controller.interpolation.InterpolationController

DELTA_MAX, DELTA_MIN

Constructor Summary

Constructors

Constructor	Description
CurveInterpolationController()

Method Summary

Modifier and Type	Method	Description
protected int	decrementIndex()	Decrements the index by 1.
void	generateArcLengths(int step)	Generates the arc lengths, generates the reverse table if the repeat type is set to cycle
void	generateArcLengths(int step, boolean reverse)	Generates arc lengths which are required if you wish to have constant speed interpolation.
protected ReadOnlyVector3	getControlPointStart()
protected ReadOnlyVector3	getCotnrolPointEnd()
Curve	getCurve()
protected int	getMaximumIndex()	Since splines require at least 4 points to interpolate correctly the default maximum value is overridden to 1 less than normal.
protected int	getMinimumIndex()	Since splines require at least 4 points to interpolate correctly the default minimum value is overridden to 1 more than normal.
protected double	incrementDelta(double by)
protected int	incrementIndex()	Increments the index by 1.
protected Vector3	interpolateVectors(ReadOnlyVector3 from, ReadOnlyVector3 to, double delta, Vector3 target)	Implemented by sub classes to perform the actual interpolation.
void	reset()	Resets the internal state, namely the cycle direction, delta and index variables.
void	setConstantSpeed(boolean constantSpeed)
void	setCurve(Curve curve)	Setting a new curve will automatically update the control points.

Methods inherited from class com.ardor3d.scenegraph.controller.interpolation.Vector3InterpolationController

getUpdateField, interpolate, isConstantSpeed, setUpdateField

Methods inherited from class com.ardor3d.scenegraph.controller.interpolation.InterpolationController

clampIndex, decrementDelta, getControlFrom, getControls, getControlTo, getDelta, getIndex, isClamped, isCycleForward, setControls, setControls, setCycleForward, setDelta, setIndex, setRepeatType, update, updateDeltaAndIndex

Methods inherited from class com.ardor3d.scenegraph.controller.ComplexSpatialController

getClassTag, getControllerValues, getMaxTime, getMinTime, getRepeatType, getSpeed, isActive, isRepeatTypeClamp, isRepeatTypeCycle, isRepeatTypeWrap, read, setActive, setControllerValues, setMaxTime, setMinTime, setSpeed, write

Methods inherited from class java.lang.Object

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

Constructor Details

CurveInterpolationController

public CurveInterpolationController()

Method Details

incrementDelta

protected double incrementDelta(double by)

Overrides:

incrementDelta in class InterpolationController<ReadOnlyVector3,Spatial>

Parameters:

by - The amount to increment by, if this is negative it will actually decrement the delta.

Returns:

The new delta value as a convenience.

See Also:

• InterpolationController.decrementDelta(double)

decrementIndex

protected int decrementIndex()

Description copied from class: InterpolationController

Decrements the index by 1.

Overrides:

decrementIndex in class InterpolationController<ReadOnlyVector3,Spatial>

Returns:

The new index value as a convenience.

incrementIndex

protected int incrementIndex()

Description copied from class: InterpolationController

Increments the index by 1.

Overrides:

incrementIndex in class InterpolationController<ReadOnlyVector3,Spatial>

Returns:

The new index value as a convenience.

interpolateVectors

protected Vector3 interpolateVectors(ReadOnlyVector3 from,
 ReadOnlyVector3 to,
 double delta,
 Vector3 target)

Description copied from class: Vector3InterpolationController

Implemented by sub classes to perform the actual interpolation.

Specified by:

interpolateVectors in class Vector3InterpolationController

Parameters:

from - The vector to interpolate from.

to - The vector to interpolate to.

delta - The distance between from and to, will be between 0.0 and 1.0 (inclusive).

target - The vector to actually interpolate.

Returns:

The interpolated vector, should not be null.

getControlPointStart

protected ReadOnlyVector3 getControlPointStart()

Returns:

The initial control point, will not be null.

getCotnrolPointEnd

protected ReadOnlyVector3 getCotnrolPointEnd()

Returns:

The final control point, will not be null.

setCurve

public void setCurve(Curve curve)

Setting a new curve will automatically update the control points.

Parameters:

curve - The new curve to follow, can not be null.

See Also:

• getCurve()

getCurve

public Curve getCurve()

Returns:

The curve being followed, will not null.

See Also:

• setCurve(Curve)

setConstantSpeed

public void setConstantSpeed(boolean constantSpeed)

Overrides:

setConstantSpeed in class Vector3InterpolationController

Parameters:

constantSpeed - true to interpolate between vectors at a constant speed, false to interpolate at a constant time.

See Also:

• Vector3InterpolationController.isConstantSpeed()

generateArcLengths

public void generateArcLengths(int step)

Generates the arc lengths, generates the reverse table if the repeat type is set to cycle

Parameters:

step - 'See Also:' method for more info.

See Also:

• generateArcLengths(int, boolean)

generateArcLengths

public void generateArcLengths(int step,
 boolean reverse)

Generates arc lengths which are required if you wish to have constant speed interpolation.

Parameters:

step - 'See Also:' method for more info.

reverse - true to also generate a reverse look up table. This is only required if you plan to use the ComplexSpatialController.RepeatType.CYCLE repeat type.

See Also:

• ArcLengthTable.generate(int, boolean)

getMaximumIndex

protected int getMaximumIndex()

Since splines require at least 4 points to interpolate correctly the default maximum value is overridden to 1 less than normal.

Overrides:

getMaximumIndex in class InterpolationController<ReadOnlyVector3,Spatial>

Returns:

The maximum allowed index. By default it returns the last index in the control list.

getMinimumIndex

protected int getMinimumIndex()

Since splines require at least 4 points to interpolate correctly the default minimum value is overridden to 1 more than normal.

Overrides:

getMinimumIndex in class InterpolationController<ReadOnlyVector3,Spatial>

Returns:

The minimum allowed index. By default it returns 0.

reset

public void reset()

Description copied from class: InterpolationController

Resets the internal state, namely the cycle direction, delta and index variables.

Overrides:

reset in class InterpolationController<ReadOnlyVector3,Spatial>