com.bonzaiengine.model.util

Class Optimizer

java.lang.Object

com.bonzaiengine.model.util.Optimizer

public final class Optimizer
extends java.lang.Object

Utilities to optimize Model structure in term of rendering speed and memory usage.

Usage

Optimizer can be called automatically by the reader, that way :
ModelReaderSettings settings = new ModelReaderSettings();
settings.< fields > = < value >;
Optimizer.Param optimizerParam = Optimizer.getBestOptions(settings.animated);
settings.optimizerParam = optimizerParam;

You can also specify additional options:
optimizer.setRemoveHiddenObject(true); //Default: false optimizer.setRemoveAdvancedMaps(true); //Default: false optimizer.setAnimationCompressionLevel(1); //Default: -1 optimizer.setRemoveMorphTargets(true); //Default: false

Or you can explicitly call it with :
Optimizer optimizer = Optimizer.getBestOptions(model);
optimizer.optimize(model);

See Also:

Param#getBestOptions(boolean), Param#getBestOptions(Model),


Constructor Summary

Constructors

Constructor and Description
Optimizer() Default Optimizer, each optimization must be enabled using the setter of this class.

Method Summary

Modifier and Type	Method and Description
Optimizer	clone()
boolean	equals(java.lang.Object obj)
int	getAnimationCompressionLevel()
static Optimizer	getBestOptions(boolean animated) Best options for animated or non-animated models.
static Optimizer	getBestOptions(Model model) Analyze the model and get the best options to optimize it.
int	getOptimizations()
boolean	isFlattenMeshHierarchy()
boolean	isFlattenModelHierarchy()
boolean	isMergeDuplicatedMaterials()
boolean	isMergeMeshPerMaterialId()
boolean	isOptimizeVertexCache()
boolean	isOptimizeVertexDataWithOneJoint()
boolean	isPrecomputeBox()
boolean	isPrecomputeCapsule()
boolean	isPrecomputeCylinder()
boolean	isPrecomputeSphere()
boolean	isRemoveAdvancedMaps()
boolean	isRemoveAnimation()
boolean	isRemoveEmptyObject()
boolean	isRemoveHiddenObject()
boolean	isRemoveMapNotLoaded()
boolean	isRemoveMorphTargets()
boolean	isRemoveUnusedMaterial()
boolean	isRemoveUnusedShaderVertexAttributes()
boolean	isRemoveUnusedSkeletonAttributes()
boolean	isRemoveUnusedVertexAttributes()
boolean	isTransformAll()
boolean	isTransformStaticMesh()
boolean	isUseMaterialStringReference()
void	optimize(Model model) Optimize model
void	setAnimationCompressionLevel(int level)
void	setFlattenMeshHierarchy(boolean flattenMeshHierarchy)
void	setFlattenModelHierarchy(boolean flattenModelHierarchy)
void	setMergeDuplicatedMaterials(boolean mergeDuplicatedMaterials)
void	setMergeMeshPerMaterialId(boolean mergeMeshPerMaterialId)
void	setOptimizations(int bitFieldOptimizations)
void	setOptimizeVertexCache(boolean optimizeVertexCache)
void	setOptimizeVertexDataWithOneJoint(boolean optimizeVertexDataWithOneJoint)
void	setPrecomputeBox(boolean precomputeBox)
void	setPrecomputeCapsule(boolean precomputeCapsule)
void	setPrecomputeCylinder(boolean precomputeCylinder)
void	setPrecomputeSphere(boolean precomputeSphere)
void	setRemoveAdvancedMaps(boolean removeAdvancedMaps) Remove all textures used only by shaders.
void	setRemoveAnimation(boolean removeAnimation)
void	setRemoveEmptyObject(boolean removeEmptyObject)
void	setRemoveHiddenObject(boolean removeHiddenObject) Remove all hidden objects if: Material is fully transparent Mesh is flagged as invisible Model is flagged as invisible Mesh does not contains any visible geometry Model does not contains any visible geometry This option is not setted by getBestOptions(boolean) or getBestOptions(Model).
void	setRemoveMapNotLoaded(boolean removeMapNotLoaded)
void	setRemoveMorphTargets(boolean removeMorphTargets)
void	setRemoveUnusedMaterial(boolean removeUnusedMaterial)
void	setRemoveUnusedShaderVertexAttributes(boolean removeUnusedShaderVertexAttributes)
void	setRemoveUnusedSkeletonAttributes(boolean removeUnusedSkeletonAttributes)
void	setRemoveUnusedVertexAttributes(boolean removeUnusedVertexAttributes)
void	setTransformAll(boolean transformModelAndMesh)
void	setTransformMesh(boolean transformStaticMesh)
void	setUseMaterialStringReference(boolean materialStringReference)

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Optimizer

public Optimizer()

Default Optimizer, each optimization must be enabled using the setter of this class.

See Also:

getBestOptions(boolean), getBestOptions(Model)

Method Detail

getBestOptions

public static final Optimizer getBestOptions(Model model)

Analyze the model and get the best options to optimize it.

getBestOptions

public static final Optimizer getBestOptions(boolean animated)

Best options for animated or non-animated models.

clone

public final Optimizer clone()

Overrides:

clone in class java.lang.Object

equals

public final boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

getOptimizations

public final int getOptimizations()

Returns:

optimizations encoded in bit field

See Also:

setOptimizations(int)

setOptimizations

public final void setOptimizations(int bitFieldOptimizations)

Parameters:

bitFieldOptimizations - optimizations encoded in bit field from getOptimizations()

isRemoveAnimation

public final boolean isRemoveAnimation()

setRemoveAnimation

public final void setRemoveAnimation(boolean removeAnimation)

Parameters:

removeAnimation -

• true: remove all animation of the in the Optimizer input Model
• false (default): do nothing

isTransformAll

public final boolean isTransformAll()

setTransformAll

public final void setTransformAll(boolean transformModelAndMesh)

Parameters:

transformModelAndMesh -

• true: apply positioning (transform) directly in the geometry.
  This allow further optimization like: geometry merge ...
• false (default): do nothing

isRemoveUnusedMaterial

public final boolean isRemoveUnusedMaterial()

setRemoveUnusedMaterial

public final void setRemoveUnusedMaterial(boolean removeUnusedMaterial)

Parameters:

removeUnusedMaterial -

• true: remove all material not linked to any geometry.
• false (default): do nothing

isFlattenModelHierarchy

public final boolean isFlattenModelHierarchy()

setFlattenModelHierarchy

public final void setFlattenModelHierarchy(boolean flattenModelHierarchy)

Parameters:

flattenModelHierarchy -

• true: flatten model hierarchy to merge model graph into a flat list.
  This allow further optimization like: geometry merge ...
• false (default): do nothing

isFlattenMeshHierarchy

public final boolean isFlattenMeshHierarchy()

setFlattenMeshHierarchy

public final void setFlattenMeshHierarchy(boolean flattenMeshHierarchy)

Parameters:

flattenMeshHierarchy -

• true: flatten mesh hierarchy to merge mesh graph into a flat list.
  This allow further optimization like: geometry merge ...
• false (default): do nothing

isMergeMeshPerMaterialId

public final boolean isMergeMeshPerMaterialId()

setMergeMeshPerMaterialId

public final void setMergeMeshPerMaterialId(boolean mergeMeshPerMaterialId)

Parameters:

mergeMeshPerMaterialId -

• true: merge all geometry sharing the same materials (to send geometry in fewer OpenGL batch).
• false (default): do nothing

isRemoveEmptyObject

public final boolean isRemoveEmptyObject()

setRemoveEmptyObject

public final void setRemoveEmptyObject(boolean removeEmptyObject)

Parameters:

removeEmptyObject -

• true: remove empty mesh or model.
• false (default): do nothing

isRemoveHiddenObject

public final boolean isRemoveHiddenObject()

setRemoveHiddenObject

public final void setRemoveHiddenObject(boolean removeHiddenObject)

Remove all hidden objects if:

• Material is fully transparent
• Mesh is flagged as invisible
• Model is flagged as invisible
• Mesh does not contains any visible geometry
• Model does not contains any visible geometry

This option is not setted by getBestOptions(boolean) or getBestOptions(Model).
You can add it as you wish.

isRemoveAdvancedMaps

public final boolean isRemoveAdvancedMaps()

setRemoveAdvancedMaps

public final void setRemoveAdvancedMaps(boolean removeAdvancedMaps)

Remove all textures used only by shaders.

This option is not setted by getBestOptions(boolean) or getBestOptions(Model).
You can add it as you wish.

isRemoveUnusedVertexAttributes

public final boolean isRemoveUnusedVertexAttributes()

setRemoveUnusedVertexAttributes

public final void setRemoveUnusedVertexAttributes(boolean removeUnusedVertexAttributes)

Parameters:

removeUnusedVertexAttributes -

• true: remove unused vertex attribute:
  
  • remove uv is the material has no texture
  • remove normal if Model has no lighting (Model#isReceiveLight())
• false (default): do nothing

isOptimizeVertexCache

public final boolean isOptimizeVertexCache()

setOptimizeVertexCache

public final void setOptimizeVertexCache(boolean optimizeVertexCache)

Parameters:

optimizeVertexCache - Not yet efficient so disabled.

• true: optimize geometry to use the gpu vertex cache. This will also optimize for pixel overdraw (view independent).
• false (default): do nothing

isMergeDuplicatedMaterials

public final boolean isMergeDuplicatedMaterials()

setMergeDuplicatedMaterials

public final void setMergeDuplicatedMaterials(boolean mergeDuplicatedMaterials)

Parameters:

mergeDuplicatedMaterials -

• true: merge duplicated materials.
• false (default): do nothing

isRemoveMapNotLoaded

public final boolean isRemoveMapNotLoaded()

setRemoveMapNotLoaded

public final void setRemoveMapNotLoaded(boolean removeMapNotLoaded)

Parameters:

removeMapNotLoaded -

• true: remove map not loaded (Map.id is null).
• false (default): do nothing

getAnimationCompressionLevel

public final int getAnimationCompressionLevel()

setAnimationCompressionLevel

public final void setAnimationCompressionLevel(int level)

Parameters:

level - Animation compression level. Accepted values: -1, 0, 1, 2
See link for more details.

See Also:

BonzaiEngine.getPositionMergeDistance(int)

isRemoveUnusedSkeletonAttributes

public final boolean isRemoveUnusedSkeletonAttributes()

setRemoveUnusedSkeletonAttributes

public final void setRemoveUnusedSkeletonAttributes(boolean removeUnusedSkeletonAttributes)

Parameters:

removeUnusedSkeletonAttributes -

• true: remove unused skeleton attribute:
  
  • remove unused joints
• false (default): do nothing

isOptimizeVertexDataWithOneJoint

public final boolean isOptimizeVertexDataWithOneJoint()

setOptimizeVertexDataWithOneJoint

public final void setOptimizeVertexDataWithOneJoint(boolean optimizeVertexDataWithOneJoint)

Parameters:

optimizeVertexDataWithOneJoint -

• true: vertex using only one joint are optimized to use rigid skinning
  
• false (default): do nothing

isTransformStaticMesh

public final boolean isTransformStaticMesh()

setTransformMesh

public final void setTransformMesh(boolean transformStaticMesh)

Parameters:

transformStaticMesh -

• true: apply positioning (transform) directly in the geometry.
  This allow further optimization like: geometry merge ...
• false (default): do nothing

isRemoveMorphTargets

public final boolean isRemoveMorphTargets()

setRemoveMorphTargets

public final void setRemoveMorphTargets(boolean removeMorphTargets)

Parameters:

removeMorphTargets -

• true: remove all morph targets
• false (default): do nothing

isRemoveUnusedShaderVertexAttributes

public final boolean isRemoveUnusedShaderVertexAttributes()

setRemoveUnusedShaderVertexAttributes

public final void setRemoveUnusedShaderVertexAttributes(boolean removeUnusedShaderVertexAttributes)

Parameters:

removeUnusedShaderVertexAttributes -

• true: remove vertex attribute only used with shaders (if not used)
  
• false (default): do nothing

isUseMaterialStringReference

public final boolean isUseMaterialStringReference()

setUseMaterialStringReference

public final void setUseMaterialStringReference(boolean materialStringReference)

Parameters:

materialStringReference -

• true: convert material index reference to material name reference
  
• false (default): do nothing

isPrecomputeBox

public final boolean isPrecomputeBox()

setPrecomputeBox

public final void setPrecomputeBox(boolean precomputeBox)

Parameters:

precomputeBox -

• true: precompute model bounding box
  
• false (default): do nothing

isPrecomputeSphere

public final boolean isPrecomputeSphere()

setPrecomputeSphere

public final void setPrecomputeSphere(boolean precomputeSphere)

Parameters:

precomputeSphere -

• true: precompute model bounding sphere
  
• false (default): do nothing

isPrecomputeCylinder

public final boolean isPrecomputeCylinder()

setPrecomputeCylinder

public final void setPrecomputeCylinder(boolean precomputeCylinder)

Parameters:

precomputeCylinder -

• true: precompute model bounding cylinder
  
• false (default): do nothing

isPrecomputeCapsule

public final boolean isPrecomputeCapsule()

setPrecomputeCapsule

public final void setPrecomputeCapsule(boolean precomputeCapsule)

Parameters:

precomputeCapsule -

• true: precompute model bounding capsule
  
• false (default): do nothing

optimize

public final void optimize(Model model)

Optimize model

Parameters:

model - mode to optimize

See Also:

getBestOptions(boolean), getBestOptions(Model)