jme3tools.optimize

Class LodGenerator

java.lang.Object

jme3tools.optimize.LodGenerator

public class LodGenerator
extends java.lang.Object

This is a utility class that adds the ability to generate the lod levels for an arbitrary mesh. It computes a collapse cost for each vertex and each edge. The higher the cost the more likely collapsing the edge or the vertex will produce artifacts on the mesh.

This class is the java implementation of the enhanced version of Ogre engine Lod generator, by Péter Szücs, originally based on Stan Melax "easy mesh simplification". The MIT licenced C++ source code can be found here https://github.com/worldforge/ember/tree/master/src/components/ogre/lod more information can be found here http://www.melax.com/polychop http://sajty.elementfx.com/progressivemesh/GSoC2012.pdf

The algorithm sorts vertices according to their collapse cost in ascending order. It collapses from the "cheapest" vertex to the more expensive.
Usage :

      LodGenerator lODGenerator = new LodGenerator(geometry);
      lODGenerator.bakeLods(reductionMethod,reductionValue);
 

reductionMethod type is VertexReductionMethod described here LodGenerator.TriangleReductionMethod reduction value depends on the reductionMethod

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LodGenerator.TriangleReductionMethod Describe the way triangles will be removed.

Constructor Summary

Constructors

Constructor and Description
LodGenerator(Geometry geom) Construct a LodGenerator for the given geometry
LodGenerator(Mesh mesh) Construct a LodGenerator for the given mesh

Method Summary

Modifier and Type	Method and Description
void	bakeLods(LodGenerator.TriangleReductionMethod reductionMethod, float... reductionValues) Computes the lods and bake them into the mesh This method must be fed with the reduction method LodGenerator.TriangleReductionMethod and a list of reduction values. for each value a lod will be generated.
VertexBuffer[]	computeLods(LodGenerator.TriangleReductionMethod reductionMethod, float... reductionValues) Computes the lod and return a list of VertexBuffers that can then be used for lod (use Mesh.setLodLevels(VertexBuffer[])) This method must be fed with the reduction method LodGenerator.TriangleReductionMethod and a list of reduction values. for each value a lod will be generated.

Methods inherited from class java.lang.Object

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

Constructor Detail

LodGenerator

public LodGenerator(Mesh mesh)

Construct a LodGenerator for the given mesh

Parameters:

mesh - the mesh to consider to generate de Lods.

LodGenerator

public LodGenerator(Geometry geom)

Construct a LodGenerator for the given geometry

Parameters:

geom - the geometry to consider to generate de Lods.

Method Detail

computeLods

public VertexBuffer[] computeLods(LodGenerator.TriangleReductionMethod reductionMethod,
                                  float... reductionValues)

Computes the lod and return a list of VertexBuffers that can then be used for lod (use Mesh.setLodLevels(VertexBuffer[]))
This method must be fed with the reduction method LodGenerator.TriangleReductionMethod and a list of reduction values.
for each value a lod will be generated.
The resulting array will always contain at index 0 the original index buffer of the mesh.

Important note : some meshes cannot be decimated, so the result of this method can vary depending of the given mesh. Also the reduction values are indicative and the produces mesh will not always meet the required reduction.

Parameters:

reductionMethod - the reduction method to use

reductionValues - the reduction value to use for each lod level.

Returns:

an array of VertexBuffers containing the different index buffers representing the lod levels.

bakeLods

public void bakeLods(LodGenerator.TriangleReductionMethod reductionMethod,
                     float... reductionValues)

Computes the lods and bake them into the mesh
This method must be fed with the reduction method LodGenerator.TriangleReductionMethod and a list of reduction values.
for each value a lod will be generated.

Important note : some meshes cannot be decimated, so the result of this method can vary depending of the given mesh. Also the reduction values are indicative and the produces mesh will not always meet the required reduction.

Parameters:

reductionMethod - the reduction method to use

reductionValues - the reduction value to use for each lod level.