com.jme3.scene.plugins.blender.objects

Class ObjectHelper

java.lang.Object

com.jme3.scene.plugins.blender.AbstractBlenderHelper

com.jme3.scene.plugins.blender.objects.ObjectHelper

public class ObjectHelper
extends AbstractBlenderHelper

A class that is used in object calculations.

Author:

Marcin Roguski (Kaelthas)

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ARMATURE_NODE_MARKER
static java.lang.String	OMA_MARKER

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

blenderContext, blenderVersion, fixUpAxis, upAxisRotationQuaternion

Constructor Summary

Constructors

Constructor and Description
ObjectHelper(java.lang.String blenderVersion, BlenderContext blenderContext) This constructor parses the given blender version and stores the result.

Method Summary

Methods

Modifier and Type	Method and Description
com.jme3.math.Matrix4f	getMatrix(Structure structure, java.lang.String matrixName, boolean fixUpAxis) This method returns the matrix of a given name for the given structure.
com.jme3.math.Transform	getTransformation(Structure objectStructure, BlenderContext blenderContext) This method calculates local transformation for the object.
boolean	isParent(java.lang.Long supposedParentOMA, java.lang.Long spatialOMA) Checks if the first given OMA points to a parent of the second one.
java.lang.Object	toObject(Structure objectStructure, BlenderContext blenderContext) This method reads the given structure and createn an object that represents the data.

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

Field Detail

OMA_MARKER

public static final java.lang.String OMA_MARKER

See Also:

Constant Field Values

ARMATURE_NODE_MARKER

public static final java.lang.String ARMATURE_NODE_MARKER

See Also:

Constant Field Values

Constructor Detail

ObjectHelper

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

This constructor parses the given blender version and stores the result. Some functionalities may differ in different blender versions.

Parameters:

blenderVersion - the version read from the blend file

blenderContext - the blender context

Method Detail

toObject

public java.lang.Object toObject(Structure objectStructure,
                        BlenderContext blenderContext)
                          throws BlenderFileException

This method reads the given structure and createn an object that represents the data.

Parameters:

objectStructure - the object's structure

blenderContext - the blender context

Returns:

blener's object representation or null if its type is excluded from loading

Throws:

BlenderFileException - an exception is thrown when the given data is inapropriate

isParent

public boolean isParent(java.lang.Long supposedParentOMA,
               java.lang.Long spatialOMA)

Checks if the first given OMA points to a parent of the second one. The parent need not to be the direct one. This method should be called when we are sure that both of the features are alred loaded because it does not check it. The OMA's should point to a spatials, otherwise the function will throw ClassCastException.

Parameters:

supposedParentOMA - the OMA of the node that we suppose might be a parent of the second one

spatialOMA - the OMA of the scene's node

Returns:

true if the first given OMA points to a parent of the second one and false otherwise

getTransformation

public com.jme3.math.Transform getTransformation(Structure objectStructure,
                                        BlenderContext blenderContext)

This method calculates local transformation for the object. Parentage is taken under consideration.

Parameters:

objectStructure - the object's structure

Returns:

objects transformation relative to its parent

getMatrix

public com.jme3.math.Matrix4f getMatrix(Structure structure,
                               java.lang.String matrixName,
                               boolean fixUpAxis)

This method returns the matrix of a given name for the given structure. It takes up axis into consideration.

Parameters:

structure - the structure with matrix data

matrixName - the name of the matrix

fixUpAxis - tells if the Y axis is a UP axis

Returns:

the required matrix