com.bonzaiengine.model.util

Class Utils

java.lang.Object

com.bonzaiengine.model.util.Utils

public final class Utils
extends java.lang.Object

Various utilities.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Utils.BoxPosition

Constructor Summary

Constructors

Constructor and Description
Utils()

Method Summary

Modifier and Type	Method and Description
static boolean	containsMesh(Array<Mesh> list, Mesh mesh)
static Motion	extractMotion(Model model, Animation animation) Extract JointMotion and MorphMotion referenced by the specified Animation
static Animation[]	getAnimations(Model model)
static Array<Animation>	getAnimations(Model model, JointMotion jointMotion)
static float	getDistanceToViewAlongForwardAxis(IViewable camera, Vec3 point)
static float	getDistanceToViewAlongForwardAxis(Mat4x4 lookAt, Vec3 point)
static int	getMaterialIndex(Model model, java.lang.Object materialKey)
static Mesh	getMesh(Mesh mesh, java.lang.String meshName) Search a mesh from his name
static Mesh	getMesh(Model model, java.lang.String meshName, int meshLod) Search a mesh from his name
static Mesh	getMeshParent(Model model, GeometryData geometry) Search the parent mesh.
static Mesh	getMeshParent(Model model, Mesh mesh) Search the parent mesh.
static Model	getModel(Model model, java.lang.String modelName) Search a model from his name
static Model	getModelParent(Model model, Mesh mesh)
static int	getNumTextureWithDiffuseAlphaChannel(Model model)
static int	getNumTotalChilds(Mesh mesh)
static int	getNumTotalFaces(Mesh mesh)
static int	getNumTotalFaces(Model model, int lod)
static int	getNumTotalGeometries(Mesh mesh)
static int	getNumTotalMeshes(Model model, int lod)
static int	getNumTotalVertices(Mesh mesh)
static int	getNumTotalVertices(Model model, int lod)
static boolean	isMaterialsReceiveLighting(Model model)
static boolean	isMaterialsTwoSided(Model model)
static java.util.HashSet<Map>	listDiffuseMaps(java.lang.Iterable<? extends IMaterial> materials)
static java.util.HashSet<java.lang.String>	listDiffuseTextures(java.lang.Iterable<? extends IMaterial> materials)
static java.util.HashSet<Map>	listExceptDiffuseMaps(java.lang.Iterable<MaterialStandard> materials)
static java.util.HashSet<java.lang.String>	listExceptDiffuseTextures(java.lang.Iterable<MaterialStandard> materials)
static java.util.HashSet<GeometryData>	listGeometryDatas(java.lang.Iterable<Mesh> meshes)
static java.util.HashSet<Map>	listMaps(java.lang.Iterable<? extends IMaterial> materials)
static java.util.HashSet<MaterialStandard>	listMaterials(Model model, boolean rec)
static java.util.HashSet<MaterialStandard>	listMaterialsUsing(Model model, Texture texture)
static java.util.HashSet<Mesh>	listMeshes(Mesh mesh)
static java.util.HashSet<Mesh>	listMeshes(Model model, int lod, boolean rec)
static java.util.HashSet<Mesh>	listMeshesUsing(java.util.HashSet<Mesh> meshes, IMaterial material)
static java.util.HashSet<Model>	listModels(Model model)
static void	listNodes(AnimGraph graph, java.util.HashSet<GraphNode> list)
static java.util.HashSet<java.lang.String>	listTextures(java.lang.Iterable<? extends IMaterial> materials) List material maps names.
static java.util.HashSet<VertexData>	listVertexDatas(java.lang.Iterable<GeometryData> geometries)
static long	memoryUsage(Model m) Calculate the approximative memory usage of the model.
static int	mergeDuplicatedMaterials(Model model)
static void	mergeLods(Model base, Model lod1, Model lod2, Model lod3) Merge up to 3 lod levels in the base Model
static <T extends ITransformable & IBoundable> Vec3	moveToOrigin(T object, Utils.BoxPosition boxPosition, boolean zUp) An utility to move the model to the origin, using as reference a bounding box position.
static int	removeAdvancedMaps(Model model) Remove all Map used by shaders: Normal Height Reflect Refract Opacity Specular Shininess Glossiness
static boolean	removeAndReplaceMaterial(Model model, MaterialStandard remove, MaterialStandard replaceWith)
static int	removeAnimations(Model model, Animation[] animToRemove) Remove the specified list of animations
static Array<Animation>	removeAnimations(Model model, JointMotion jointMotion) Remove the specified JointMotion from this Model.skeleton and all Animation using the specified JointMotion.
static int	removeMaps(Model model, Map.MapType type) Remove all material map of type specified.
static int	removeMapsNotLoaded(Model model)
static boolean	removeMaterial(Model model, MaterialStandard remove) Remove a material and update references
static Mesh	removeMesh(Model model, Mesh toRemove) Remove the first occurrence of the mesh to remove
static Model	removeModel(Model model, Model remove)
static void	removeMotions(Model model) Remove JointMotion and MorphMotion of the specified Model
static Transform	removeTransform(Model model, int index)
static Transform	removeTransform(Model model, Mesh mesh, int index)
static int	removeUnusedMaterials(Model model)
static void	renameMaterial(Model model, MaterialStandard material, java.lang.String newName) Rename a material and update references
static void	setMaterialKey(Model model, java.lang.Object materialKey)
static void	setMaterialsForceAlphaTest(Model model, boolean forceAlphaTest) For all the MaterialStandard in the specified Model, set the forceAlphaTest property
static void	setMaterialsReceiveLight(Model model, boolean useLight) For all the MaterialStandard in the specified Model, set the useLight property
static void	setMaterialsTwoSided(Model model, boolean twoSided) For all the MaterialStandard in the specified Model, set the twoSided property
static void	setMaterialsUseDiffuseAlpha(Model model, boolean useDiffuseChannel) For all the MaterialStandard in the specified Model, set the useDiffuseChannel property
static AssetManager	simpleAssets()
static long	sizeOfArray(java.lang.Object[] array)
static long	sizeOfBoundingVolume(IVolume<?> bv)
static void	unassignAllMaterials(Model model)
static void	useMaterialStringReference(Model model) Ensure Material name are unique and not null/empty (or set default name).

Methods inherited from class java.lang.Object

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

Constructor Detail

Utils

public Utils()

Method Detail

simpleAssets

public static AssetManager simpleAssets()

Returns:

A new AssetManager with a TextureList and a null TextureLoader

listModels

public static final java.util.HashSet<Model> listModels(Model model)

Returns:

a list containing all Model objects retained in the Model object (including it).

listMaterials

public static final java.util.HashSet<MaterialStandard> listMaterials(Model model,
                                                                      boolean rec)

Parameters:

model - Model to search materials

rec - true to search in Model#getChilds()

Returns:

a set containing the MaterialStandard

listTextures

public static final java.util.HashSet<java.lang.String> listTextures(java.lang.Iterable<? extends IMaterial> materials)

List material maps names. A map can refer multiple texture (cubemap). Use ModelTextureList.mapNameToFileName to obtain the file system filename

listMaps

public static final java.util.HashSet<Map> listMaps(java.lang.Iterable<? extends IMaterial> materials)

listDiffuseTextures

public static final java.util.HashSet<java.lang.String> listDiffuseTextures(java.lang.Iterable<? extends IMaterial> materials)

listDiffuseMaps

public static final java.util.HashSet<Map> listDiffuseMaps(java.lang.Iterable<? extends IMaterial> materials)

listExceptDiffuseTextures

public static final java.util.HashSet<java.lang.String> listExceptDiffuseTextures(java.lang.Iterable<MaterialStandard> materials)

listExceptDiffuseMaps

public static final java.util.HashSet<Map> listExceptDiffuseMaps(java.lang.Iterable<MaterialStandard> materials)

listMeshes

public static final java.util.HashSet<Mesh> listMeshes(Model model,
                                                       int lod,
                                                       boolean rec)

Parameters:

lod -

Returns:

a list containing all Mesh objects retained in the Model object and in sub models if rec is true.

listMeshesUsing

public static java.util.HashSet<Mesh> listMeshesUsing(java.util.HashSet<Mesh> meshes,
                                                      IMaterial material)

listMeshes

public static java.util.HashSet<Mesh> listMeshes(Mesh mesh)

listGeometryDatas

public static final java.util.HashSet<GeometryData> listGeometryDatas(java.lang.Iterable<Mesh> meshes)

Returns:

a list containing all Mesh objects retained in the Model object.

listVertexDatas

public static final java.util.HashSet<VertexData> listVertexDatas(java.lang.Iterable<GeometryData> geometries)

listMaterialsUsing

public static final java.util.HashSet<MaterialStandard> listMaterialsUsing(Model model,
                                                                           Texture texture)

Returns:

true if the mesh uses the texture specified. Sub mesh are not traversed.

listNodes

public static final void listNodes(AnimGraph graph,
                                   java.util.HashSet<GraphNode> list)

removeModel

public static final Model removeModel(Model model,
                                      Model remove)

removeMesh

public static final Mesh removeMesh(Model model,
                                    Mesh toRemove)

Remove the first occurrence of the mesh to remove

Parameters:

model -

toRemove - mesh to remove

Returns:

mesh removed

getModel

public static final Model getModel(Model model,
                                   java.lang.String modelName)

Search a model from his name

Parameters:

model -

modelName - model name to search

Returns:

model found if any

getMesh

public static final Mesh getMesh(Model model,
                                 java.lang.String meshName,
                                 int meshLod)

Search a mesh from his name

Parameters:

model -

meshName - mesh name to search

Returns:

mesh found (if any)

getMesh

public static final Mesh getMesh(Mesh mesh,
                                 java.lang.String meshName)

Search a mesh from his name

Parameters:

mesh - root mesh to search from (included)

meshName - mesh name to search

Returns:

mesh found (if any)

getMeshParent

public static final Mesh getMeshParent(Model model,
                                       Mesh mesh)

Search the parent mesh.

Parameters:

model -

mesh -

Returns:

the parent of mesh

getMeshParent

public static final Mesh getMeshParent(Model model,
                                       GeometryData geometry)

Search the parent mesh.

Parameters:

model -

mesh -

Returns:

the parent of mesh

getModelParent

public static Model getModelParent(Model model,
                                   Mesh mesh)

containsMesh

public static boolean containsMesh(Array<Mesh> list,
                                   Mesh mesh)

getNumTotalMeshes

public static int getNumTotalMeshes(Model model,
                                    int lod)

Returns:

the number of mesh and sub-meshes in this model and sub-models.

getNumTotalFaces

public static int getNumTotalFaces(Model model,
                                   int lod)

Returns:

the number of faces of this model and all its sub-meshes and sub-links.

getNumTotalVertices

public static int getNumTotalVertices(Model model,
                                      int lod)

Returns:

the number of faces of this model and all its sub-meshes and sub-links.

getNumTotalChilds

public static int getNumTotalChilds(Mesh mesh)

Returns:

the number of childs and sub-childs, not including this mesh.

getNumTotalFaces

public static int getNumTotalFaces(Mesh mesh)

Returns:

the number of faces of this mesh and all its childs and sub-childs.

getNumTotalVertices

public static int getNumTotalVertices(Mesh mesh)

Returns:

the number of vertices indexed of this mesh. This is equivalent to vertices.positions.length

getNumTotalGeometries

public static int getNumTotalGeometries(Mesh mesh)

setMaterialKey

public static final void setMaterialKey(Model model,
                                        java.lang.Object materialKey)

Parameters:

model - a Model

materialKey - a material key to set to all meshes of the specified model

getMaterialIndex

public static final int getMaterialIndex(Model model,
                                         java.lang.Object materialKey)

Parameters:

model - a Model

materialName - name of the MaterialStandard to get it's id

Returns:

the index of the material from the Model.materials list, -1 if not found.

setMaterialsUseDiffuseAlpha

public static final void setMaterialsUseDiffuseAlpha(Model model,
                                                     boolean useDiffuseChannel)

For all the MaterialStandard in the specified Model, set the useDiffuseChannel property

setMaterialsForceAlphaTest

public static final void setMaterialsForceAlphaTest(Model model,
                                                    boolean forceAlphaTest)

For all the MaterialStandard in the specified Model, set the forceAlphaTest property

setMaterialsReceiveLight

public static final void setMaterialsReceiveLight(Model model,
                                                  boolean useLight)

For all the MaterialStandard in the specified Model, set the useLight property

setMaterialsTwoSided

public static final void setMaterialsTwoSided(Model model,
                                              boolean twoSided)

For all the MaterialStandard in the specified Model, set the twoSided property

isMaterialsReceiveLighting

public static final boolean isMaterialsReceiveLighting(Model model)

Returns:

true if all materials receive dynamic lighting

isMaterialsTwoSided

public static final boolean isMaterialsTwoSided(Model model)

Returns:

true if all materials are two sided

getNumTextureWithDiffuseAlphaChannel

public static final int getNumTextureWithDiffuseAlphaChannel(Model model)

Returns:

the number of texture with alpha channel

unassignAllMaterials

public static final void unassignAllMaterials(Model model)

removeMapsNotLoaded

public static final int removeMapsNotLoaded(Model model)

Returns:

the number of map, with no texture associated, removed

removeMaps

public static final int removeMaps(Model model,
                                   Map.MapType type)

Remove all material map of type specified.
This utility is expected to be used before texture loading. It does not actually unload texture from the GPU, but it remove the description from the material properties.

If you are not using shader, it is recommended to use removeAdvancedMaps

Parameters:

model -

type - type of map to remove

Returns:

number of map removed

See Also:

removeAdvancedMaps(Model)

removeAdvancedMaps

public static final int removeAdvancedMaps(Model model)

Remove all Map used by shaders:

• Normal
• Height
• Reflect
• Refract
• Opacity
• Specular
• Shininess
• Glossiness

Returns:

number of Map removed

renameMaterial

public static final void renameMaterial(Model model,
                                        MaterialStandard material,
                                        java.lang.String newName)

Rename a material and update references

Parameters:

model - a Model containing the specified material

material - IMaterial to rename

newName - new name of the material

removeMaterial

public static final boolean removeMaterial(Model model,
                                           MaterialStandard remove)

Remove a material and update references

Parameters:

model -

remove - material to remove

Returns:

true if removed

removeAndReplaceMaterial

public static final boolean removeAndReplaceMaterial(Model model,
                                                     MaterialStandard remove,
                                                     MaterialStandard replaceWith)

removeUnusedMaterials

public static final int removeUnusedMaterials(Model model)

Returns:

the number of unused materials removed

mergeDuplicatedMaterials

public static final int mergeDuplicatedMaterials(Model model)

Returns:

number of material removed

useMaterialStringReference

public static final void useMaterialStringReference(Model model)

Ensure Material name are unique and not null/empty (or set default name).
Replace all MaterialStandard references by name (String), instead of index (Integer)

Parameters:

model - model to do operation on

mergeLods

public static final void mergeLods(Model base,
                                   Model lod1,
                                   Model lod2,
                                   Model lod3)

Merge up to 3 lod levels in the base Model

Parameters:

base - base Model

lod1 - lod level 1 Model

lod2 - lod level 2 Model

lod3 - lod level 3 Model

moveToOrigin

public static <T extends ITransformable & IBoundable> Vec3 moveToOrigin(T object,
                                                                        Utils.BoxPosition boxPosition,
                                                                        boolean zUp)

An utility to move the model to the origin, using as reference a bounding box position.

Parameters:

boxPosition -

See Also:

Utils.BoxPosition

getDistanceToViewAlongForwardAxis

public static final float getDistanceToViewAlongForwardAxis(IViewable camera,
                                                            Vec3 point)

Returns:

the distance to the view projected along the view direction

getDistanceToViewAlongForwardAxis

public static final float getDistanceToViewAlongForwardAxis(Mat4x4 lookAt,
                                                            Vec3 point)

removeTransform

public static final Transform removeTransform(Model model,
                                              int index)

removeTransform

public static final Transform removeTransform(Model model,
                                              Mesh mesh,
                                              int index)

getAnimations

public static final Array<Animation> getAnimations(Model model,
                                                   JointMotion jointMotion)

Parameters:

model -

jointMotion -

Returns:

list of Animation which uses the specified JointMotion

removeAnimations

public static final Array<Animation> removeAnimations(Model model,
                                                      JointMotion jointMotion)

Remove the specified JointMotion from this Model.skeleton and all Animation using the specified JointMotion.

Parameters:

jointMotion - JointMotion to remove

Returns:

animations removed

Throws:

java.lang.IllegalStateException - if Model.skeleton is null

extractMotion

public static final Motion extractMotion(Model model,
                                         Animation animation)

Extract JointMotion and MorphMotion referenced by the specified Animation

Parameters:

model -

animation -

Returns:

removeMotions

public static final void removeMotions(Model model)

Remove JointMotion and MorphMotion of the specified Model

getAnimations

public static final Animation[] getAnimations(Model model)

Returns:

the Animation of the specified Model in an array

removeAnimations

public static final int removeAnimations(Model model,
                                         Animation[] animToRemove)

Remove the specified list of animations

Parameters:

model -

animToRemove - list of animation to remove

Returns:

number of animation removed

memoryUsage

public static long memoryUsage(Model m)

Calculate the approximative memory usage of the model.
MediaManager, Texture, shader, display list, vertex array and VBO are not taken into account.

Note: In most cases, the value return is >= real memory usage (due to data sharing).

sizeOfBoundingVolume

public static long sizeOfBoundingVolume(IVolume<?> bv)

sizeOfArray

public static final long sizeOfArray(java.lang.Object[] array)