Model (Bonzai Engine bonzaiengine.com Copyright © 2007-2019 Jérôme Jouvie)

java.lang.Object
- com.bonzaiengine.model.Model

All Implemented Interfaces:: IUpdatable, ITransformable, IDestroyable, ITree<Model>, IBoundable, ICullable, ICullableNode, ILod, java.lang.Cloneable, java.lang.Comparable<Model>

public final class Model
extends java.lang.Object
implements IDestroyable, java.lang.Cloneable, java.lang.Comparable<Model>, ITransformable, ILod, ITree<Model>, ICullableNode, IUpdatable

Field Summary

Fields
Modifier and Type	Field and Description
`AssetManager`	`assets` Dependency to external assets (textures)
`boolean`	`md3` Flag to indicate the model hierarchy is in MD3 format
`java.lang.String`	`name` Model name
`HwData`	`rendererData` Managed internally.
`Skeleton`	`skeleton` Skeleton for skinning animation.
`Mat4x4[]`	`skeletonAbsoluteMatrices` Managed internally.
`Mat4x4[]`	`skinMatrices` Managed internally.

Constructor Summary

Constructors
Constructor and Description

Model(AssetManager assetManager)

Constructors
Constructor and Description
`Model(AssetManager assetManager)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addAnimation(Animation animation)`
`void`	`addAnimation(Animation animation, JointMotion jointMotion)` Add an `Animation` to this `Model` and it's associated `JointMotion` to this `skeleton`.
`void`	`addAnimationBindPose()` Add an `Animation` that uses the `Skeleton` bind pose.
`void`	`addChild(Model model)`
`void`	`addMaterial(MaterialStandard material)`
`void`	`addMesh(int lod, Mesh mesh)`
`void`	`addMorphMotion(MorphMotion morphMotion)`
`int`	`compareTo(Model o)`
`void`	`destroy(IGLApi glApi)`
`Model`	`duplicate(boolean duplicateHierarchy, boolean duplicateAnimation, boolean duplicateAnimationList, boolean duplicateMaterialKey)`
`Animation`	`getAnimation(int index)`
`Animation`	`getAnimation(java.lang.String animationName)`
`AnimationContext`	`getAnimationContext()`
`int`	`getAnimationIndex(Animation anim)`
`void`	`getAnimationKeys(java.util.Set<java.lang.Float> times, Animation anim)`
`Model`	`getChild(int index)`
`java.lang.Iterable<? extends ICullableNode>`	`getCullableNodes()`
`RenderState.Cull`	`getCullFace()`
`MaterialStandard`	`getMaterial(int materialIndex)`
`IMaterial`	`getMaterial(java.lang.Object materialKey)`
`MaterialStandard`	`getMaterial(java.lang.String materialName)`
`Mat4x4`	`getMatrix()`
`Mat4x4`	`getMatrix(Mat4x4 dst)`
`Array<Mesh>`	`getMeshes()`
`Array<Mesh>`	`getMeshes(int meshLod)`
`MorphMotion`	`getMorphMotion(int index)`
`MorphMotion`	`getMorphMotion(java.lang.String motionName)`
`int`	`getNumAnimations()`
`int`	`getNumAnimationsRec()`
`int`	`getNumChilds()`
`int`	`getNumLodLevels()`
`int`	`getNumMaterials()`
`int`	`getNumMorphMotions()`
`Transform`	`getTransform()`
`Transform`	`getTransform(Transform dst)`
`IVolume<?>`	`getVolume(int bvOptions)` Model Bounding Box ================== By default the bounding box is axis aligned, to get a bounding box oriented relativly to the model use : VolumeOptions.BV_ORIENTED By default, all model/meshes are included in the bounding box even invisible object.
`int`	`indexOfMaterial(MaterialStandard material)`
`void`	`initialize()` Internal use.
`boolean`	`isAnimated()`
`boolean`	`isCullBackFace()`
`boolean`	`isCulled()`
`boolean`	`isCullFrontFace()`
`boolean`	`isDrawBoundingVolume()`
`boolean`	`isVisible()`
`boolean`	`isVisibleAndNotCulled()`
`void`	`onAnimationChanged()` This method must be called when `transforms` has been manually modified (add, remove, clear, null, ...).
`void`	`onContextLost()` Deprecated. Use `AssetManager.onContextLost(Model)` instead
`void`	`onHierarchyChanged()` This method must be called when `childs` or `#meshes` has been manually modified (add, remove, clear, ...).
`void`	`onMaterialChanged()` This method must be called when a {Material#name} has been modified.
`static Model`	`read(IByteInputStream in, Model model)`
`static boolean`	`readBoolean(IByteInputStream in)`
`static java.lang.String`	`readString(IByteInputStream in, java.lang.String[] strings, boolean indexed)`
`boolean`	`removeAnimation(Animation animation)`
`Animation`	`removeAnimation(int index)`
`boolean`	`removeChild(Model model)`
`boolean`	`removeMaterial(MaterialStandard material)`
`boolean`	`removeMesh(int lod, Mesh mesh)`
`MorphMotion`	`removeMorphMotion(int index)`
`void`	`removeMorphMotion(MorphMotion morphMotion)`
`void`	`restartAnimations()` Restart the animation of this model and all its links.
`Array<Model>`	`setChilds(Array<Model> childs)`
`void`	`setCullBackFace(boolean cullBackFace, boolean propagate)`
`void`	`setCulled(boolean culled)`
`void`	`setCullFrontFace(boolean cullFrontFace, boolean propagate)`
`void`	`setDrawBoundingVolume(boolean drawBoundingVolume)`
`void`	`setMaterials(Array<MaterialStandard> materials)`
`Array<Mesh>`	`setMeshes(int lod, Array<Mesh> meshes)`
`void`	`setTransform(Transform src)`
`void`	`setTransforms(KeyFrame<Transform> transforms)`
`void`	`setVisible(boolean visible)`
`java.lang.String`	`toString()`
`void`	`transform(Transform transform)` Post multiplication by the specified transform
`void`	`unreferenceAssets()`
`boolean`	`update(long timePassedMS)` Must be called each frame for the root model to synchronize animation, bounding volumes, etc ...
`void`	`write(IByteOutputStream out)`
`static void`	`writeBoolean(IByteOutputStream out, boolean b)`
`static void`	`writeString(IByteOutputStream out, java.lang.String s)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.bonzaiengine.visibility.ILod
getLodDistance, getLodLevel, setLodLevel

- Field Detail
  - name
```
public java.lang.String name
```
    Model name
  - md3
```
public boolean md3
```
    Flag to indicate the model hierarchy is in MD3 format
  - skeleton
```
public Skeleton skeleton
```
    Skeleton for skinning animation.
    Default: null
  - assets
```
public AssetManager assets
```
    Dependency to external assets (textures)
  - skeletonAbsoluteMatrices
```
public Mat4x4[] skeletonAbsoluteMatrices
```
    Managed internally.
    Absolute matrices of the current interpolated skeleton.
  - skinMatrices
```
public Mat4x4[] skinMatrices
```
    Managed internally.
    Skeleton absolute matrices multiplied by inverse bind pose.
  - rendererData
```
public HwData rendererData
```
    Managed internally.
- Constructor Detail
  - Model
```
public Model(AssetManager assetManager)
```
    Parameters:
    
    assetManager - AssetManager for external resource, can be shared with multiple Model
- Method Detail
  - toString
```
public final java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - compareTo
```
public final int compareTo(Model o)
```
    Specified by:
    
    compareTo in interface java.lang.Comparable<Model>
  - read
```
public static final Model read(IByteInputStream in,
                               Model model)
                        throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - write
```
public final void write(IByteOutputStream out)
                 throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - readString
```
public static final java.lang.String readString(IByteInputStream in,
                                                java.lang.String[] strings,
                                                boolean indexed)
                                         throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - writeString
```
public static final void writeString(IByteOutputStream out,
                                     java.lang.String s)
                              throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - readBoolean
```
public static final boolean readBoolean(IByteInputStream in)
                                 throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - writeBoolean
```
public static final void writeBoolean(IByteOutputStream out,
                                      boolean b)
                               throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - initialize
```
public final void initialize()
```
    Internal use.
  - duplicate
```
public final Model duplicate(boolean duplicateHierarchy,
                             boolean duplicateAnimation,
                             boolean duplicateAnimationList,
                             boolean duplicateMaterialKey)
```
    Returns:
    
    the model duplicated
  - unreferenceAssets
```
public final void unreferenceAssets()
```
  - destroy
```
public final void destroy(IGLApi glApi)
```
    Specified by:
    
    destroy in interface IDestroyable
  - onContextLost
```
@Deprecated
public final void onContextLost()
```
    Deprecated. Use AssetManager.onContextLost(Model) instead
    
    See Also:
    
    AssetManager.onContextLost(Model)
  - getMaterial
```
public final IMaterial getMaterial(java.lang.Object materialKey)
                            throws java.lang.IllegalStateException,
                                   java.lang.IllegalArgumentException
```
    Parameters:
    
    materialKey -
    
    Returns:
    
    Throws:
    
    java.lang.IllegalStateException - when materialKey is an AssetKey and assets's materialLibrary is null
    
    java.lang.IllegalArgumentException - when materialKey type is not int (Integer), String or AssetKey
  - setMaterials
```
public final void setMaterials(Array<MaterialStandard> materials)
```
    Parameters:
    
    materials - list of MaterialStandard set on this Model
  - addMaterial
```
public final void addMaterial(MaterialStandard material)
```
    Parameters:
    
    material - a MaterialStandard to add to this Model
  - removeMaterial
```
public final boolean removeMaterial(MaterialStandard material)
```
    Parameters:
    
    material - a MaterialStandard to remove from this Model
    
    Returns:
    
    true if the specified material has been removed
  - getNumMaterials
```
public final int getNumMaterials()
```
    Returns:
    
    the number of MaterialStandard in this Model
  - getMaterial
```
public final MaterialStandard getMaterial(int materialIndex)
```
    Parameters:
    
    materialIndex - index of the MaterialStandard to get
    
    Returns:
    
    null if the index is out of bounds
    
    See Also:
    
    getNumMaterials()
  - getMaterial
```
public final MaterialStandard getMaterial(java.lang.String materialName)
```
    Parameters:
    
    materialName - a MaterialStandard name
    
    Returns:
    
    null if the name does not exists
  - indexOfMaterial
```
public final int indexOfMaterial(MaterialStandard material)
```
    Parameters:
    
    material - a MaterialStandard to get its index
    
    Returns:
    
    the index of the specified material, or -1 if it is not in this Model
  - getNumChilds
```
public final int getNumChilds()
```
    Specified by:
    
    getNumChilds in interface ITree<Model>
    
    Returns:
    
    the number of direct links, not including this model.
  - addChild
```
public final void addChild(Model model)
```
    Specified by:
    
    addChild in interface ITree<Model>
    
    Parameters:
    
    model - new child to add this this Model
  - removeChild
```
public final boolean removeChild(Model model)
```
    Parameters:
    
    model - a Model to remove
    
    Returns:
    
    true if the Model has been removed from this Model
  - getChild
```
public final Model getChild(int index)
```
    Specified by:
    
    getChild in interface ITree<Model>
    
    Parameters:
    
    index - in the range [0; ITree.getNumChilds()[
    
    Returns:
    
    the child at the specified index
  - setChilds
```
public final Array<Model> setChilds(Array<Model> childs)
```
    Parameters:
    
    childs -
    
    Returns:
    
    old value
  - getMeshes
```
public final Array<Mesh> getMeshes()
```
    Returns:
    
    base meshes list (lod 0)
    
    See Also:
    
    getMeshes(int)
  - getNumLodLevels
```
public final int getNumLodLevels()
```
    Specified by:
    
    getNumLodLevels in interface ILod
    
    Returns:
    
    the number of level of details (lod).
    
    See Also:
    
    getMeshes(int)
  - getMeshes
```
public final Array<Mesh> getMeshes(int meshLod)
```
    Parameters:
    
    meshLod -
    
    Returns:
    
    See Also:
    
    getNumLodLevels()
  - addMesh
```
public final void addMesh(int lod,
                          Mesh mesh)
```
  - removeMesh
```
public final boolean removeMesh(int lod,
                                Mesh mesh)
```
  - setMeshes
```
public final Array<Mesh> setMeshes(int lod,
                                   Array<Mesh> meshes)
```
  - getAnimationContext
```
public final AnimationContext getAnimationContext()
```
  - getNumAnimations
```
public final int getNumAnimations()
```
    Returns:
    
    the number of animations of this Model
  - getNumAnimationsRec
```
public final int getNumAnimationsRec()
```
    Returns:
    
    the number of animations of this Model and all its childs
  - getAnimation
```
public final Animation getAnimation(int index)
```
    Returns:
    
    the Animation at the specified index
  - getAnimation
```
public final Animation getAnimation(java.lang.String animationName)
```
    Returns:
    
    the Animation with the specified name.
    A good practive is to use Animation with unique naming.
  - getAnimationIndex
```
public final int getAnimationIndex(Animation anim)
```
    Returns:
    
    the index of the specified Animation
  - addAnimation
```
public final void addAnimation(Animation animation)
```
    Parameters:
    
    animation - animation to add
    
    See Also:
    
    removeAnimation(Animation), removeAnimation(int), addAnimation(Animation, JointMotion)
  - removeAnimation
```
public final Animation removeAnimation(int index)
```
    Parameters:
    
    index - index of the Animation to remove.
    
    See Also:
    
    Utils.removeAnimations(Model, Animation[])
  - removeAnimation
```
public final boolean removeAnimation(Animation animation)
```
  - addAnimation
```
public final void addAnimation(Animation animation,
                               JointMotion jointMotion)
```
    Add an Animation to this Model and it's associated JointMotion to this skeleton.
    This method ensure Animation.skeletonMotion is set to use the specified JointMotion, and if the Animation.name is null then it set it using JointMotion name.
    This is equivalent to:
```
  if (animation.name == null) {
        animation.name = jointMotion.getName();
  }
  animation.skeletonMotion = jointMotion.getName();
  addAnimation(animation)
  skeleton.addMotion(jointMotion);
  
```
    Parameters:
    
    animation - an Animation to add
    
    jointMotion - the JointMotion to associated to the specified Animation
    
    Throws:
    
    java.lang.IllegalStateException - if skeleton is null
  - addAnimationBindPose
```
public final void addAnimationBindPose()
```
    Add an Animation that uses the Skeleton bind pose.
    
    Throws:
    
    java.lang.IllegalStateException - if skeleton is null
  - restartAnimations
```
public void restartAnimations()
```
    Restart the animation of this model and all its links.
    This is equivalent of calling getAnimationContext().getTimeline().setTime(0) for this Model and recursively to all of it childs Model#getChilds()
  - getAnimationKeys
```
public void getAnimationKeys(java.util.Set<java.lang.Float> times,
                             Animation anim)
```
    Parameters:
    
    times - storage for animation key times
  - getNumMorphMotions
```
public final int getNumMorphMotions()
```
    Returns:
    
    the number of morph motion
  - getMorphMotion
```
public final MorphMotion getMorphMotion(int index)
```
    Parameters:
    
    index - index of the MorphMotion to get
  - getMorphMotion
```
public final MorphMotion getMorphMotion(java.lang.String motionName)
```
    Parameters:
    
    motionName - name of the motion to get
  - addMorphMotion
```
public final void addMorphMotion(MorphMotion morphMotion)
```
    Parameters:
    
    morphMotion - MorphMotion to add
  - removeMorphMotion
```
public final void removeMorphMotion(MorphMotion morphMotion)
```
    Parameters:
    
    morphMotion - MorphMotion to remove
  - removeMorphMotion
```
public final MorphMotion removeMorphMotion(int index)
```
    Parameters:
    
    index - index of the MorphMotion to remove
    
    Returns:
    
    the MorphMotion removed
  - getCullableNodes
```
public final java.lang.Iterable<? extends ICullableNode> getCullableNodes()
```
    Specified by:
    
    getCullableNodes in interface ICullableNode
    
    Returns:
    
    List of nodes, null can be returned if does not contains any nodes
  - getMatrix
```
public final Mat4x4 getMatrix(Mat4x4 dst)
```
    Specified by:
    
    getMatrix in interface ICullableNode
    
    Parameters:
    
    dst - destination Mat4x4 to store local matrix
    
    Returns:
    
    dst or null if identity
  - getMatrix
```
public final Mat4x4 getMatrix()
```
    Returns:
    
    local matrix of this Model, or null if identity
  - setTransforms
```
public final void setTransforms(KeyFrame<Transform> transforms)
```
  - getTransform
```
public final Transform getTransform(Transform dst)
```
    Specified by:
    
    getTransform in interface ITransformable
    
    Parameters:
    
    dst - destination Transform to store local transform
    
    Returns:
    
    dst or null if identity
  - setTransform
```
public final void setTransform(Transform src)
```
    Specified by:
    
    setTransform in interface ITransformable
  - getTransform
```
public final Transform getTransform()
```
    Returns:
    
    local transform of this Model, or null if identity
  - transform
```
public final void transform(Transform transform)
```
    Post multiplication by the specified transform
    
    Specified by:
    
    transform in interface ITransformable
    
    See Also:
    
    Transform.multiply(Transform, Transform), #getTransforms()
  - isAnimated
```
public boolean isAnimated()
```
    Returns:
    
    true if this model or one of its sub-links is animated
  - getVolume
```
public IVolume<?> getVolume(int bvOptions)
```
    Model Bounding Box
    ==================
    
    By default the bounding box is axis aligned, to get a bounding box oriented relativly to the model use : VolumeOptions.BV_ORIENTED
    
    By default, all model/meshes are included in the bounding box even invisible object.
    To ignore invisible object, use this flag : VolumeOptions.BV_VISIBLE_ONLY
    
    Specified by:
    
    getVolume in interface IBoundable
    
    Parameters:
    
    bvOptions - bounding volume options.
    
    Returns:
    
    bounding volume, cast to BoundingBox or BoundingSphere depending on options.
    
    See Also:
    
    VolumeOptions, Box, Sphere, Cylinder, Capsule
  - update
```
public boolean update(long timePassedMS)
```
    Must be called each frame for the root model to synchronize animation, bounding volumes, etc ...
    
    Specified by:
    
    update in interface IUpdatable
    
    Parameters:
    
    timePassedMS - time passed from last frame in milliseconds
    
    Returns:
    
    true if the something has been changed
  - onAnimationChanged
```
public final void onAnimationChanged()
```
    This method must be called when transforms has been manually modified (add, remove, clear, null, ...).
  - onHierarchyChanged
```
public final void onHierarchyChanged()
```
    This method must be called when childs or #meshes has been manually modified (add, remove, clear, ...).
  - onMaterialChanged
```
public final void onMaterialChanged()
```
    This method must be called when a {Material#name} has been modified.
  - isVisibleAndNotCulled
```
public final boolean isVisibleAndNotCulled()
```
    Returns:
    
    true if visible and not culled
  - isVisible
```
public final boolean isVisible()
```
    Specified by:
    
    isVisible in interface ICullable
    
    Returns:
    
    true if this GeometryData is visible
  - setVisible
```
public final void setVisible(boolean visible)
```
    Parameters:
    
    visible - set new visibility state of this GeometryData
  - isCulled
```
public final boolean isCulled()
```
    Specified by:
    
    isCulled in interface ICullable
    
    Returns:
    
    true if this GeometryData is culled (by visibility algorithm, ...)
  - setCulled
```
public final void setCulled(boolean culled)
```
    Specified by:
    
    setCulled in interface ICullable
    
    Parameters:
    
    culled - new culled state for this GeometryData
  - isDrawBoundingVolume
```
public final boolean isDrawBoundingVolume()
```
    Returns:
    
    true if the renderer must draw a bounding volume around this GeometryData
  - setDrawBoundingVolume
```
public final void setDrawBoundingVolume(boolean drawBoundingVolume)
```
  - getCullFace
```
public RenderState.Cull getCullFace()
```
  - isCullBackFace
```
public final boolean isCullBackFace()
```
    Returns:
    
    true if the Mesh and GeometryData have their back face culled
  - setCullBackFace
```
public final void setCullBackFace(boolean cullBackFace,
                                  boolean propagate)
```
  - isCullFrontFace
```
public final boolean isCullFrontFace()
```
    Returns:
    
    true if the Mesh and GeometryData have their front face culled
  - setCullFrontFace
```
public final void setCullFrontFace(boolean cullFrontFace,
                                   boolean propagate)
```

Class Model

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface com.bonzaiengine.visibility.ILod

Field Detail

name

md3

skeleton

assets

skeletonAbsoluteMatrices

skinMatrices

rendererData

Constructor Detail

Model

Method Detail

toString

compareTo

read

write

readString

writeString

readBoolean

writeBoolean

initialize

duplicate

unreferenceAssets

destroy

onContextLost

getMaterial

setMaterials

addMaterial

removeMaterial

getNumMaterials

getMaterial

getMaterial

indexOfMaterial

getNumChilds

addChild

removeChild

getChild

setChilds

getMeshes

getNumLodLevels

getMeshes

addMesh

removeMesh

setMeshes

getAnimationContext

getNumAnimations

getNumAnimationsRec

getAnimation

getAnimation

getAnimationIndex

addAnimation

removeAnimation

removeAnimation

addAnimation

addAnimationBindPose

restartAnimations

getAnimationKeys

getNumMorphMotions

getMorphMotion

getMorphMotion

addMorphMotion

removeMorphMotion

removeMorphMotion

getCullableNodes

getMatrix

getMatrix

setTransforms

getTransform

setTransform

getTransform

transform

isAnimated

getVolume

update

onAnimationChanged