com.jme3.scene.plugins.blender.meshes

Class Face

java.lang.Object

com.jme3.scene.plugins.blender.meshes.Face

All Implemented Interfaces:

java.util.Comparator<java.lang.Integer>

public class Face
extends java.lang.Object
implements java.util.Comparator<java.lang.Integer>

A class that represents a single face in the mesh. The face is a polygon. Its minimum count of vertices is = 3.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Face.TriangulationWarning A warning that indicates a problem with face triangulation.

Constructor Summary

Constructors

Constructor and Description
Face(java.lang.Integer[] indexes, boolean smooth, int materialNumber, java.util.Map<java.lang.String,java.util.List<Vector2f>> faceUVCoords, java.util.List<byte[]> vertexColors, TemporalMesh temporalMesh) Creates a complete face with all available data.

Method Summary

Modifier and Type	Method and Description
Face	clone()
int	compare(java.lang.Integer index1, java.lang.Integer index2)
Vector3f	computeCentroid()
boolean	equals(java.lang.Object obj)
void	flipIndexes() Flips the order of the indexes.
void	flipUV(boolean u, boolean v) Flips UV coordinates.
java.util.List<java.util.List<java.lang.Integer>>	getCurrentIndexes()
IndexesLoop	getIndexes()
int	getMaterialNumber()
TemporalMesh	getTemporalMesh()
java.util.Map<java.lang.String,java.util.List<Vector2f>>	getUvSets()
java.util.List<byte[]>	getVertexColors()
int	hashCode()
boolean	isSmooth()
static java.util.List<Face>	loadAll(Structure meshStructure, java.util.Map<java.lang.String,java.util.List<Vector2f>> userUVGroups, java.util.List<byte[]> verticesColors, TemporalMesh temporalMesh, BlenderContext blenderContext) Loads all faces of a given mesh.
void	setTemporalMesh(TemporalMesh temporalMesh) Sets the temporal mesh for the face.
java.lang.String	toString()
Face.TriangulationWarning	triangulate() The method triangulates the face.
int	vertexCount()

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Comparator

comparing, comparing, comparingDouble, comparingInt, comparingLong, naturalOrder, nullsFirst, nullsLast, reversed, reverseOrder, thenComparing, thenComparing, thenComparing, thenComparingDouble, thenComparingInt, thenComparingLong

Constructor Detail

Face

public Face(java.lang.Integer[] indexes,
            boolean smooth,
            int materialNumber,
            java.util.Map<java.lang.String,java.util.List<Vector2f>> faceUVCoords,
            java.util.List<byte[]> vertexColors,
            TemporalMesh temporalMesh)

Creates a complete face with all available data.

Parameters:

indexes - the indexes of the face (required)

smooth - indicates if the face is smooth or solid

materialNumber - the material index of the face

faceUVCoords - UV coordinate sets of the face (optional)

vertexColors - the vertex colors of the face (optional)

temporalMesh - the temporal mesh the face belongs to (required)

Method Detail

clone

public Face clone()

Overrides:

clone in class java.lang.Object

getTemporalMesh

public TemporalMesh getTemporalMesh()

Returns:

the mesh this face belongs to

getIndexes

public IndexesLoop getIndexes()

Returns:

the original indexes of the face

computeCentroid

public Vector3f computeCentroid()

Returns:

the centroid of the face

getCurrentIndexes

public java.util.List<java.util.List<java.lang.Integer>> getCurrentIndexes()

Returns:

current indexes of the face (if it is already triangulated then more than one index group will be in the result list)

setTemporalMesh

public void setTemporalMesh(TemporalMesh temporalMesh)

Sets the temporal mesh for the face. The given mesh cannot be null.

Parameters:

temporalMesh - the temporal mesh of the face

Throws:

java.lang.IllegalArgumentException - thrown if given temporal mesh is null

flipIndexes

public void flipIndexes()

Flips the order of the indexes.

flipUV

public void flipUV(boolean u,
                   boolean v)

Flips UV coordinates.

Parameters:

u - indicates if U coords should be flipped

v - indicates if V coords should be flipped

getUvSets

public java.util.Map<java.lang.String,java.util.List<Vector2f>> getUvSets()

Returns:

the UV sets of the face

vertexCount

public int vertexCount()

Returns:

current vertex count of the face

triangulate

public Face.TriangulationWarning triangulate()

The method triangulates the face.

isSmooth

public boolean isSmooth()

Returns:

true if the face is smooth and false otherwise

getMaterialNumber

public int getMaterialNumber()

Returns:

the material index of the face

getVertexColors

public java.util.List<byte[]> getVertexColors()

Returns:

the vertices colord of the face

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Specified by:

equals in interface java.util.Comparator<java.lang.Integer>

Overrides:

equals in class java.lang.Object

loadAll

public static java.util.List<Face> loadAll(Structure meshStructure,
                                           java.util.Map<java.lang.String,java.util.List<Vector2f>> userUVGroups,
                                           java.util.List<byte[]> verticesColors,
                                           TemporalMesh temporalMesh,
                                           BlenderContext blenderContext)
                                    throws BlenderFileException

Loads all faces of a given mesh.

Parameters:

meshStructure - the mesh structure we read the faces from

userUVGroups - UV groups defined by the user

verticesColors - the vertices colors of the mesh

temporalMesh - the temporal mesh the faces will belong to

blenderContext - the blender context

Returns:

list of faces read from the given mesh structure

Throws:

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

compare

public int compare(java.lang.Integer index1,
                   java.lang.Integer index2)

Specified by:

compare in interface java.util.Comparator<java.lang.Integer>