com.jme3.scene.plugins.blender.animations

Class AnimationHelper

java.lang.Object

com.jme3.scene.plugins.blender.AbstractBlenderHelper

com.jme3.scene.plugins.blender.animations.AnimationHelper

public class AnimationHelper
extends AbstractBlenderHelper

The helper class that helps in animations loading.

Field Summary

Fields inherited from class com.jme3.scene.plugins.blender.AbstractBlenderHelper

blenderContext, blenderVersion, fixUpAxis, upAxisRotationQuaternion

Constructor Summary

Constructors

Constructor and Description
AnimationHelper(java.lang.String blenderVersion, BlenderContext blenderContext)

Method Summary

Modifier and Type	Method and Description
void	applyAnimations(Node node, BlenderKey.AnimationMatchMethod animationMatchMethod) The method applies animations to the given node.
void	applyAnimations(Node node, Skeleton skeleton, BlenderKey.AnimationMatchMethod animationMatchMethod) The method applies skeleton animations to the given node.
Ipo	fromIpoStructure(Structure ipoStructure, BlenderContext blenderContext) This method creates an ipo object used for interpolation calculations.
Ipo	fromValue(float constValue) This method creates an ipo with only a single value.
int	getCurveType(Structure structure, BlenderContext blenderContext) This method returns the type of the ipo curve.
void	loadAnimations() Loads all animations that are stored in the blender file.

Methods inherited from class com.jme3.scene.plugins.blender.AbstractBlenderHelper

applyProperties, loadLibrary, loadProperties

Methods inherited from class java.lang.Object

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

Constructor Detail

AnimationHelper

public AnimationHelper(java.lang.String blenderVersion,
                       BlenderContext blenderContext)

Method Detail

loadAnimations

public void loadAnimations()
                    throws BlenderFileException

Loads all animations that are stored in the blender file. The animations are not yet applied to the scene features. This should be called before objects are loaded.

Throws:

BlenderFileException - an exception is thrown when problems with blender file reading occur

applyAnimations

public void applyAnimations(Node node,
                            BlenderKey.AnimationMatchMethod animationMatchMethod)

The method applies animations to the given node. The names of the animations should be the same as actions names in the blender file.

Parameters:

node - the node to whom the animations will be applied

animationMatchMethod - the way animation should be matched with node

applyAnimations

public void applyAnimations(Node node,
                            Skeleton skeleton,
                            BlenderKey.AnimationMatchMethod animationMatchMethod)

The method applies skeleton animations to the given node.

Parameters:

node - the node where the animations will be applied

skeleton - the skeleton of the node

animationMatchMethod - the way animation should be matched with skeleton

fromIpoStructure

public Ipo fromIpoStructure(Structure ipoStructure,
                            BlenderContext blenderContext)
                     throws BlenderFileException

This method creates an ipo object used for interpolation calculations.

Parameters:

ipoStructure - the structure with ipo definition

blenderContext - the blender context

Returns:

the ipo object

Throws:

BlenderFileException - this exception is thrown when the blender file is somehow corrupted

fromValue

public Ipo fromValue(float constValue)

This method creates an ipo with only a single value. No track type is specified so do not use it for calculating tracks.

Parameters:

constValue - the value of this ipo

Returns:

constant ipo

getCurveType

public int getCurveType(Structure structure,
                        BlenderContext blenderContext)

This method returns the type of the ipo curve.

Parameters:

structure - the structure must contain the 'rna_path' field and 'array_index' field (the type is not important here)

blenderContext - the blender context

Returns:

the type of the curve