CubicSplineSegment (3D 1.5.3-pre3-1409021114)

java.lang.Object
- com.sun.j3d.utils.behaviors.interpolators.CubicSplineSegment

```
public class CubicSplineSegment
extends java.lang.Object
```
The CubicSplineSegment class creates the representation of a TCB (Kochanek-Bartels Spline). This class takes 4 key frames as its input (using TCBKeyFrame). If interpolating between the i^th and (i+1)^th key frame then the four key frames that need to be specified are the (i-1)^th, i^th, (i+1)^th and (i+2)^th keyframes in order. The CubicSegmentClass then pre-computes the hermite interpolation basis coefficients if the (i+1)^th frame has the linear flag set to zero. These are used to calculate the interpolated position, scale and quaternions when they requested by the user using the getInterpolated* methods. If the the (i+1)^th frame's linear flag is set to 1 then the class uses linear interpolation to calculate the interpolated position, sccale and quaternions it returns through the getInterpolated* methods.

Since:

Java3D 1.1

Field Summary

Fields
Modifier and Type	Field and Description
`(package private) Point3f`	`c0`
`(package private) Point3f`	`c1`
`(package private) Point3f`	`c2`
`(package private) Point3f`	`c3`
`(package private) float`	`dda`
`(package private) float`	`ddb`
`(package private) float`	`dsa`
`(package private) float`	`dsb`
`(package private) Point3f`	`e0`
`(package private) Point3f`	`e1`
`(package private) Point3f`	`e2`
`(package private) Point3f`	`e3`
`(package private) TCBKeyFrame[]`	`keyFrame`
`(package private) float`	`length`
`(package private) int`	`linear`
`(package private) static double[]`	`modCoeff`
`(package private) static double[]`	`modRoot`
`(package private) float`	`one_minus_b_in`
`(package private) float`	`one_minus_b_out`
`(package private) float`	`one_minus_c_in`
`(package private) float`	`one_minus_c_out`
`(package private) float`	`one_minus_t_in`
`(package private) float`	`one_minus_t_out`
`(package private) float`	`one_plus_b_in`
`(package private) float`	`one_plus_b_out`
`(package private) float`	`one_plus_c_in`
`(package private) float`	`one_plus_c_out`

Constructor Summary

Constructors
Constructor and Description
`CubicSplineSegment()` Default constructor
`CubicSplineSegment(TCBKeyFrame kf0, TCBKeyFrame kf1, TCBKeyFrame kf2, TCBKeyFrame kf3)` Creates a cubic spline segment between two key frames using the key frames provided.

Method Summary

Methods
Modifier and Type	Method and Description
`private void`	`computeCommonCoefficients(TCBKeyFrame kf0, TCBKeyFrame kf1, TCBKeyFrame kf2, TCBKeyFrame kf3)`
`private void`	`computeHermiteCoefficients(TCBKeyFrame kf0, TCBKeyFrame kf1, TCBKeyFrame kf2, TCBKeyFrame kf3)`
`float`	`computeLength(float u)` Computes the length of the curve at a given point between key frames.
`private float`	`computeSpeed(float u)`
`void`	`getInterpolatedPosition(float u, Point3f newPos)` Computes the interpolated position along the curve at a given point between key frames and returns a Point3f with the interpolated x, y, and z scale components.
`void`	`getInterpolatedPositionVector(float u, Vector3f newPos)` Computes the interpolated position along the curve at a given point between key frames and returns a Vector3f with the interpolated x, y, and z scale components.
`void`	`getInterpolatedQuaternion(float u, Quat4f newQuat)` Computes the interpolated quaternion along the curve at a given point between key frames.
`void`	`getInterpolatedScale(float u, Point3f newScale)` Computes the interpolated scale along the curve at a given point between key frames and returns a Point3f with the interpolated x, y, and z scale components.
`float`	`getInterpolatedValue(float u)` Computes the ratio of the length of the spline from the i^th key frame to the position specified by u to the length of the entire spline segment from the i^th key frame to the (i+1) ^th key frame.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - modRoot
```
static final double[] modRoot
```
  - modCoeff
```
static final double[] modCoeff
```
  - keyFrame
```
TCBKeyFrame[] keyFrame
```
  - c0
```
Point3f c0
```
  - c1
```
Point3f c1
```
  - c2
```
Point3f c2
```
  - c3
```
Point3f c3
```
  - e0
```
Point3f e0
```
  - e1
```
Point3f e1
```
  - e2
```
Point3f e2
```
  - e3
```
Point3f e3
```
  - one_minus_t_in
```
float one_minus_t_in
```
  - one_minus_c_in
```
float one_minus_c_in
```
  - one_minus_b_in
```
float one_minus_b_in
```
  - one_plus_c_in
```
float one_plus_c_in
```
  - one_plus_b_in
```
float one_plus_b_in
```
  - ddb
```
float ddb
```
  - dda
```
float dda
```
  - one_minus_t_out
```
float one_minus_t_out
```
  - one_minus_c_out
```
float one_minus_c_out
```
  - one_minus_b_out
```
float one_minus_b_out
```
  - one_plus_c_out
```
float one_plus_c_out
```
  - one_plus_b_out
```
float one_plus_b_out
```
  - dsb
```
float dsb
```
  - dsa
```
float dsa
```
  - length
```
float length
```
  - linear
```
int linear
```
- Constructor Detail
  - CubicSplineSegment
```
CubicSplineSegment()
```
    Default constructor
  - CubicSplineSegment
```
CubicSplineSegment(TCBKeyFrame kf0,
                  TCBKeyFrame kf1,
                  TCBKeyFrame kf2,
                  TCBKeyFrame kf3)
```
    Creates a cubic spline segment between two key frames using the key frames provided. If creating a spline between the ith frame and the (i+1)^th frame then send down the (i - 1)^th, i^th , (i+1)^th and the (i+2)^th key frames.
    
    Parameters:
    kf0 - (i - 1)^th Key Frame
    kf1 - i^th Key Frame
    kf2 - (i + 1)^th Key Frame
    kf3 - (i + 2)^th Key Frame
- Method Detail
  - computeCommonCoefficients
```
private void computeCommonCoefficients(TCBKeyFrame kf0,
                             TCBKeyFrame kf1,
                             TCBKeyFrame kf2,
                             TCBKeyFrame kf3)
```
  - computeHermiteCoefficients
```
private void computeHermiteCoefficients(TCBKeyFrame kf0,
                              TCBKeyFrame kf1,
                              TCBKeyFrame kf2,
                              TCBKeyFrame kf3)
```
  - computeLength
```
public float computeLength(float u)
```
    Computes the length of the curve at a given point between key frames.
    
    Parameters:
    u - specifies the point between keyframes where 0 <= u <= 1.
  - computeSpeed
```
private float computeSpeed(float u)
```
  - getInterpolatedQuaternion
```
public void getInterpolatedQuaternion(float u,
                             Quat4f newQuat)
```
    Computes the interpolated quaternion along the curve at a given point between key frames. This routine uses linear interpolation if the (i+1)^th key frame's linear value is equal to 1.
    
    Parameters:
    u - specifies the point between keyframes where 0 <= u <= 1.
    newQuat - returns the value of the interpolated quaternion
  - getInterpolatedScale
```
public void getInterpolatedScale(float u,
                        Point3f newScale)
```
    Computes the interpolated scale along the curve at a given point between key frames and returns a Point3f with the interpolated x, y, and z scale components. This routine uses linear interpolation if the (i+1)^th key frame's linear value is equal to 1.
    
    Parameters:
    u - specifies the point between keyframes where 0 <= u <= 1.
    newScale - returns the interpolated x,y,z scale value in a Point3f
  - getInterpolatedPosition
```
public void getInterpolatedPosition(float u,
                           Point3f newPos)
```
    Computes the interpolated position along the curve at a given point between key frames and returns a Point3f with the interpolated x, y, and z scale components. This routine uses linear interpolation if the (i+1)^th key frame's linear value is equal to 1.
    
    Parameters:
    u - specifies the point between keyframes where 0 <= u <= 1.
    newPos - returns the interpolated x,y,z position in a Point3f
  - getInterpolatedPositionVector
```
public void getInterpolatedPositionVector(float u,
                                 Vector3f newPos)
```
    Computes the interpolated position along the curve at a given point between key frames and returns a Vector3f with the interpolated x, y, and z scale components. This routine uses linear interpolation if the (i+1)^th key frame's linear value is equal to 1.
    
    Parameters:
    u - specifies the point between keyframes where 0 <= u <= 1.
    newPos - returns the interpolated x,y,z position in a Vector3f.
  - getInterpolatedValue
```
public float getInterpolatedValue(float u)
```
    Computes the ratio of the length of the spline from the i^th key frame to the position specified by u to the length of the entire spline segment from the i^th key frame to the (i+1) ^th key frame. When the (i+1)^th key frame's linear value is equal to 1, this is meaninful otherwise it should return u.
    
    Parameters:
    u - specifies the point between keyframes where 0 <= u <= 1.
    
    Returns:
    the interpolated ratio

Class CubicSplineSegment

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

modRoot

modCoeff

keyFrame

c0

c1

c2

c3

e0

e1

e2

e3

one_minus_t_in

one_minus_c_in

one_minus_b_in

one_plus_c_in

one_plus_b_in

ddb

dda

one_minus_t_out

one_minus_c_out

one_minus_b_out

one_plus_c_out

one_plus_b_out

dsb

dsa

length

linear

Constructor Detail

CubicSplineSegment

CubicSplineSegment

Method Detail

computeCommonCoefficients

computeHermiteCoefficients

computeLength

computeSpeed

getInterpolatedQuaternion

getInterpolatedScale

getInterpolatedPosition

getInterpolatedPositionVector

getInterpolatedValue