com.jme3.scene.plugins.blender.animations

Class Ipo

java.lang.Object

com.jme3.scene.plugins.blender.animations.Ipo

public class Ipo
extends java.lang.Object

This class is used to calculate bezier curves value for the given frames. The Ipo (interpolation object) consists of several b-spline curves (connected 3rd degree bezier curves) of a different type.

Field Summary

Fields

Modifier and Type	Field and Description
static int	AC_LOC_X
static int	AC_LOC_Y
static int	AC_LOC_Z
static int	AC_QUAT_W
static int	AC_QUAT_X
static int	AC_QUAT_Y
static int	AC_QUAT_Z
static int	AC_SIZE_X
static int	AC_SIZE_Y
static int	AC_SIZE_Z
protected int	blenderVersion Depending on the blender version rotations are stored in degrees or radians so we need to know the version that is used.
protected boolean	fixUpAxis This variable indicates if the Y asxis is the UP axis or not.
static int	OB_ROT_X
static int	OB_ROT_Y
static int	OB_ROT_Z

Constructor Summary

Constructors

Constructor and Description
Ipo(BezierCurve[] bezierCurves, boolean fixUpAxis, int blenderVersion) Constructor.

Method Summary

Modifier and Type	Method and Description
Track	calculateTrack(int targetIndex, BoneContext boneContext, Vector3f localTranslation, Quaternion localRotation, Vector3f localScale, int startFrame, int stopFrame, int fps, boolean spatialTrack) This method calculates the value of the curves as a bone track between the specified frames.
double	calculateValue(int frame) This method calculates the ipo value for the first curve.
double	calculateValue(int frame, int curveIndex) This method calculates the ipo value for the curve of the specified index.
int	getLastFrame() This method returns the frame where last bezier triple center point of the specified bezier curve is located.

Methods inherited from class java.lang.Object

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

Field Detail

AC_LOC_X

public static final int AC_LOC_X

See Also:

Constant Field Values

AC_LOC_Y

public static final int AC_LOC_Y

See Also:

Constant Field Values

AC_LOC_Z

public static final int AC_LOC_Z

See Also:

Constant Field Values

OB_ROT_X

public static final int OB_ROT_X

See Also:

Constant Field Values

OB_ROT_Y

public static final int OB_ROT_Y

See Also:

Constant Field Values

OB_ROT_Z

public static final int OB_ROT_Z

See Also:

Constant Field Values

AC_SIZE_X

public static final int AC_SIZE_X

See Also:

Constant Field Values

AC_SIZE_Y

public static final int AC_SIZE_Y

See Also:

Constant Field Values

AC_SIZE_Z

public static final int AC_SIZE_Z

See Also:

Constant Field Values

AC_QUAT_W

public static final int AC_QUAT_W

See Also:

Constant Field Values

AC_QUAT_X

public static final int AC_QUAT_X

See Also:

Constant Field Values

AC_QUAT_Y

public static final int AC_QUAT_Y

See Also:

Constant Field Values

AC_QUAT_Z

public static final int AC_QUAT_Z

See Also:

Constant Field Values

fixUpAxis

protected boolean fixUpAxis

This variable indicates if the Y asxis is the UP axis or not.

blenderVersion

protected final int blenderVersion

Depending on the blender version rotations are stored in degrees or radians so we need to know the version that is used.

Constructor Detail

Ipo

public Ipo(BezierCurve[] bezierCurves,
           boolean fixUpAxis,
           int blenderVersion)

Constructor. Stores the bezier curves.

Parameters:

bezierCurves - a table of bezier curves

fixUpAxis - indicates if the Y is the up axis or not

blenderVersion - the blender version that is currently used

Method Detail

calculateValue

public double calculateValue(int frame)

This method calculates the ipo value for the first curve.

Parameters:

frame - the frame for which the value is calculated

Returns:

calculated ipo value

calculateValue

public double calculateValue(int frame,
                             int curveIndex)

This method calculates the ipo value for the curve of the specified index. Make sure you do not exceed the curves amount. Alway chech the amount of curves before calling this method.

Parameters:

frame - the frame for which the value is calculated

curveIndex - the index of the curve

Returns:

calculated ipo value

getLastFrame

public int getLastFrame()

This method returns the frame where last bezier triple center point of the specified bezier curve is located.

Returns:

the frame number of the last defined bezier triple point for the specified ipo

calculateTrack

public Track calculateTrack(int targetIndex,
                            BoneContext boneContext,
                            Vector3f localTranslation,
                            Quaternion localRotation,
                            Vector3f localScale,
                            int startFrame,
                            int stopFrame,
                            int fps,
                            boolean spatialTrack)

This method calculates the value of the curves as a bone track between the specified frames.

Parameters:

targetIndex - the index of the target for which the method calculates the tracks IMPORTANT! Aet to -1 (or any negative number) if you want to load spatial animation.

localTranslation - the local translation of the object/bone that will be animated by the track

localRotation - the local rotation of the object/bone that will be animated by the track

localScale - the local scale of the object/bone that will be animated by the track

startFrame - the first frame of tracks (inclusive)

stopFrame - the last frame of the tracks (inclusive)

fps - frame rate (frames per second)

spatialTrack - this flag indicates if the track belongs to a spatial or to a bone; the difference is important because it appears that bones in blender have the same type of coordinate system (Y as UP) as jme while other features have different one (Z is UP)

Returns:

bone track for the specified bone