com.jme3.scene.plugins.blender

Class AbstractBlenderHelper

java.lang.Object

com.jme3.scene.plugins.blender.AbstractBlenderHelper

Direct Known Subclasses:

AnimationHelper, CameraHelper, ConstraintHelper, CurvesHelper, LandscapeHelper, LightHelper, MaterialHelper, MeshHelper, ModifierHelper, ObjectHelper, ParticlesHelper, TextureHelper

public abstract class AbstractBlenderHelper
extends java.lang.Object

A purpose of the helper class is to split calculation code into several classes. Each helper after use should be cleared because it can hold the state of the calculations.

Author:

Marcin Roguski

Field Summary

Fields

Modifier and Type	Field and Description
protected BlenderContext	blenderContext The blender context.
protected int	blenderVersion The version of the blend file.
protected boolean	fixUpAxis This variable indicates if the Y asxis is the UP axis or not.
protected com.jme3.math.Quaternion	upAxisRotationQuaternion Quaternion used to rotate data when Y is up axis.

Constructor Summary

Constructors

Constructor and Description
AbstractBlenderHelper(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
void	applyProperties(com.jme3.scene.Spatial spatial, Properties properties) The method applies properties to the given spatial.
protected java.lang.Object	loadLibrary(Structure id) The method loads library of a given ID from linked blender file.
protected Properties	loadProperties(Structure structure, BlenderContext blenderContext) This method loads the properties if they are available and defined for the structure.

Methods inherited from class java.lang.Object

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

Field Detail

blenderContext

protected BlenderContext blenderContext

The blender context.

blenderVersion

protected final int blenderVersion

The version of the blend file.

fixUpAxis

protected boolean fixUpAxis

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

upAxisRotationQuaternion

protected com.jme3.math.Quaternion upAxisRotationQuaternion

Quaternion used to rotate data when Y is up axis.

Constructor Detail

AbstractBlenderHelper

public AbstractBlenderHelper(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

loadProperties

protected Properties loadProperties(Structure structure,
                        BlenderContext blenderContext)
                             throws BlenderFileException

This method loads the properties if they are available and defined for the structure.

Parameters:

structure - the structure we read the properties from

blenderContext - the blender context

Returns:

loaded properties or null if they are not available

Throws:

BlenderFileException - an exception is thrown when the blend file is somehow corrupted

applyProperties

public void applyProperties(com.jme3.scene.Spatial spatial,
                   Properties properties)

The method applies properties to the given spatial. The Properties instance cannot be directly applied because the end-user might not have the blender plugin jar file and thus receive ClassNotFoundException. The values are set by name instead.

Parameters:

spatial - the spatial that is to have properties applied

properties - the properties to be applied

loadLibrary

protected java.lang.Object loadLibrary(Structure id)
                                throws BlenderFileException

The method loads library of a given ID from linked blender file.

Parameters:

id - the ID of the linked feature (it contains its name and blender path)

Returns:

loaded feature or null if none was found

Throws:

BlenderFileException - and exception is throw when problems with reading a blend file occur