com.jme3.scene.plugins.blender.meshes

Class MeshHelper

java.lang.Object

com.jme3.scene.plugins.blender.AbstractBlenderHelper

com.jme3.scene.plugins.blender.meshes.MeshHelper

public class MeshHelper
extends AbstractBlenderHelper

A class that is used in mesh calculations.

Field Summary

Fields

Modifier and Type	Field and Description
static int	UV_DATA_LAYER_TYPE_BMESH A type of UV data layer in bmesh type.
static int	UV_DATA_LAYER_TYPE_FMESH A type of UV data layer in traditional faced mesh (triangles or quads).

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

blenderContext, blenderVersion, fixUpAxis, upAxisRotationQuaternion

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
Material	getBlackUnshadedMaterial(BlenderContext blenderContext) Returns the black unshaded material.
boolean	isBMeshCompatible(Structure meshStructure) Tells if the given mesh structure supports BMesh.
java.util.LinkedHashMap<java.lang.String,java.util.List<Vector2f>>	loadUVCoordinates(Structure meshStructure) The method loads the UV coordinates.
void	loadVerticesAndNormals(Structure meshStructure, java.util.List<Vector3f> vertices, java.util.List<Vector3f> normals) This method returns the vertices: a list of vertex positions and a list of vertex normals.
java.util.List<byte[]>	loadVerticesColors(Structure meshStructure, BlenderContext blenderContext) This method returns the vertices colors.
java.util.List<java.util.Map<java.lang.String,java.lang.Float>>	loadVerticesGroups(Structure meshStructure) Loads all vertices groups.
java.util.Map<java.lang.String,java.util.List<Vector2f>>	selectUVSubset(Face face, java.lang.Integer... indexesSublist) Selects the proper subsets of UV coordinates for the given sublist of indexes.
java.util.List<byte[]>	selectVertexColorSubset(Face face, java.lang.Integer... indexesSublist) Selects the proper subsets of vertex colors for the given sublist of indexes.
TemporalMesh	toTemporalMesh(Structure meshStructure, BlenderContext blenderContext) Converts the mesh structure into temporal mesh.

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

UV_DATA_LAYER_TYPE_FMESH

public static final int UV_DATA_LAYER_TYPE_FMESH

A type of UV data layer in traditional faced mesh (triangles or quads).

See Also:

Constant Field Values

UV_DATA_LAYER_TYPE_BMESH

public static final int UV_DATA_LAYER_TYPE_BMESH

A type of UV data layer in bmesh type.

See Also:

Constant Field Values

Constructor Detail

MeshHelper

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

toTemporalMesh

public TemporalMesh toTemporalMesh(Structure meshStructure,
                                   BlenderContext blenderContext)
                            throws BlenderFileException

Converts the mesh structure into temporal mesh. The temporal mesh is stored in blender context and here always a clone is being returned because the mesh might be modified by modifiers.

Parameters:

meshStructure - the mesh structure

blenderContext - the blender context

Returns:

temporal mesh read from the given structure

Throws:

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

isBMeshCompatible

public boolean isBMeshCompatible(Structure meshStructure)

Tells if the given mesh structure supports BMesh.

Parameters:

meshStructure - the mesh structure

Returns:

true if BMesh is supported and false otherwise

loadVerticesAndNormals

public void loadVerticesAndNormals(Structure meshStructure,
                                   java.util.List<Vector3f> vertices,
                                   java.util.List<Vector3f> normals)
                            throws BlenderFileException

This method returns the vertices: a list of vertex positions and a list of vertex normals.

Parameters:

meshStructure - the structure containing the mesh data

Throws:

BlenderFileException - this exception is thrown when the blend file structure is somehow invalid or corrupted

loadVerticesColors

public java.util.List<byte[]> loadVerticesColors(Structure meshStructure,
                                                 BlenderContext blenderContext)
                                          throws BlenderFileException

This method returns the vertices colors. Each vertex is stored in byte[4] array.

Parameters:

meshStructure - the structure containing the mesh data

blenderContext - the blender context

Returns:

a list of vertices colors, each color belongs to a single vertex or empty list of colors are not specified

Throws:

BlenderFileException - this exception is thrown when the blend file structure is somehow invalid or corrupted

loadUVCoordinates

public java.util.LinkedHashMap<java.lang.String,java.util.List<Vector2f>> loadUVCoordinates(Structure meshStructure)
                                                                                     throws BlenderFileException

The method loads the UV coordinates. The result is a map where the key is the user's UV set name and the values are UV coordinates. But depending on the mesh type (triangle/quads or bmesh) the lists in the map have different meaning. For bmesh they are enlisted just like they are stored in the blend file (in loops). For traditional faces every 4 UV's should be assigned for a single face.

Parameters:

meshStructure - the mesh structure

Returns:

a map that sorts UV coordinates between different UV sets

Throws:

BlenderFileException - an exception is thrown when problems with blend file occur

loadVerticesGroups

public java.util.List<java.util.Map<java.lang.String,java.lang.Float>> loadVerticesGroups(Structure meshStructure)
                                                                                   throws BlenderFileException

Loads all vertices groups.

Parameters:

meshStructure - the mesh structure

Returns:

a list of vertex groups for every vertex in the mesh

Throws:

BlenderFileException - an exception is thrown when problems with blend file occur

selectUVSubset

public java.util.Map<java.lang.String,java.util.List<Vector2f>> selectUVSubset(Face face,
                                                                               java.lang.Integer... indexesSublist)

Selects the proper subsets of UV coordinates for the given sublist of indexes.

Parameters:

face - the face with the original UV sets

indexesSublist - the sub list of indexes

Returns:

a map of UV coordinates subsets

selectVertexColorSubset

public java.util.List<byte[]> selectVertexColorSubset(Face face,
                                                      java.lang.Integer... indexesSublist)

Selects the proper subsets of vertex colors for the given sublist of indexes.

Parameters:

face - the face with the original vertex colors

indexesSublist - the sub list of indexes

Returns:

a sublist of vertex colors

getBlackUnshadedMaterial

public Material getBlackUnshadedMaterial(BlenderContext blenderContext)

Returns the black unshaded material. It is used for lines and points because that is how blender renders it.

Parameters:

blenderContext - the blender context

Returns:

black unshaded material