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

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

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

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

Field Summary

Fields
Modifier and Type Field and Description

RenderOptions renderOptions
Renderer

Fields
Modifier and Type	Field and Description
`RenderOptions`	`renderOptions` Renderer

Constructor Summary

Constructors
Constructor and Description

ModelInstance()

ModelInstance(java.lang.String instanceName)

Constructors
Constructor and Description
`ModelInstance()`
`ModelInstance(java.lang.String instanceName)`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`int`	`compareTo(ModelInstance o)`
`void`	`destroy(IGL gl)` Destroy this `ModelInstance`.
`void`	`destroyAsync()` Destroy this `ModelInstance` asynchronously (destruction delayed)
`SplineAnimator`	`getAnimator()`
`java.lang.Iterable<? extends ICullableNode>`	`getCullableNodes()`
`ModelInstance`	`getFromInstance()`
`AsyncModel`	`getFromModel()`
`java.lang.String`	`getInstanceName()` Deprecated. could be removed in future release
`Model`	`getInternalModelIfLoaded()`
`float`	`getLodDistance()`
`int`	`getLodLevel()`
`Mat4x4`	`getMatrix(Mat4x4 m)`
`Model`	`getModel()`
`java.lang.String`	`getModelID()`
`Model`	`getModelIfLoaded()`
`int`	`getNumLodLevels()`
`Transform`	`getTransform(Transform dst)`
`IVolume<?>`	`getVolume(int boundingVolumeOptions)`
`void`	`instanciate(AsyncModel asyncModel)` Instanciate the geometry from the specified `AsyncModel`
`void`	`instanciate(AsyncModel asyncModel, boolean materialDuplicated)` Instanciate the geometry from the specified `AsyncModel`
`void`	`instanciate(ModelInstance from)` Share the model and animation from the specified `ModelInstance`
`boolean`	`isCreatedFromInstance()`
`boolean`	`isCreatedFromInstance(ModelInstance instance)`
`boolean`	`isCreatedFromModel()`
`boolean`	`isCreatedFromModel(java.lang.String modelId)`
`boolean`	`isCulled()`
`boolean`	`isLoaded()`
`boolean`	`isLoadingFailed()`
`boolean`	`isVisible()`
`boolean`	`isVisibleAndNotCulled()`
`void`	`onContextLost()` Must be called when the OpenGL Context has been lost.
`void`	`onLoad(OnLoadListener<ModelInstance> listener)` Register listeners to receive a one time notification when this `ModelInstance` is loaded.
`void`	`render(Renderer renderer)` Render this `ModelInstance`
`void`	`setAnimator(SplineAnimator animatior)`
`void`	`setCulled(boolean culled)`
`void`	`setLodLevel(int lodLevel)`
`void`	`setTransform(Transform src)`
`void`	`setVisible(boolean visible)`
`java.lang.String`	`toString()`
`void`	`transform(Transform t)`
`boolean`	`update(long timePassedMS)`

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

- Field Detail
  - renderOptions
```
public RenderOptions renderOptions
```
    Renderer
- Constructor Detail
  - ModelInstance
```
public ModelInstance()
```
  - ModelInstance
```
public ModelInstance(java.lang.String instanceName)
```
- Method Detail
  - toString
```
public final java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - compareTo
```
public final int compareTo(ModelInstance o)
```
    Specified by:
    
    compareTo in interface java.lang.Comparable<ModelInstance>
  - getInstanceName
```
@Deprecated
public final java.lang.String getInstanceName()
```
    Deprecated. could be removed in future release
    
    Returns:
    
    the instance name
  - instanciate
```
public final void instanciate(AsyncModel asyncModel)
```
    Instanciate the geometry from the specified AsyncModel
  - instanciate
```
public final void instanciate(AsyncModel asyncModel,
                              boolean materialDuplicated)
```
    Instanciate the geometry from the specified AsyncModel
    
    Parameters:
    
    materialDuplicated - true to allow instance having different materials, default false
  - instanciate
```
public final void instanciate(ModelInstance from)
```
    Share the model and animation from the specified ModelInstance
  - onLoad
```
public final void onLoad(OnLoadListener<ModelInstance> listener)
```
    Register listeners to receive a one time notification when this ModelInstance is loaded.
    If this ModelInstance is already loaded, the notification is send instantly.
  - update
```
public boolean update(long timePassedMS)
```
    Parameters:
    
    timePassedMS - time passed in milli-seconds
  - render
```
public final void render(Renderer renderer)
```
    Render this ModelInstance
  - destroy
```
public final void destroy(IGL gl)
```
    Destroy this ModelInstance.
    
    Specified by:
    
    destroy in interface IDestroyable
  - destroyAsync
```
public final void destroyAsync()
```
    Destroy this ModelInstance asynchronously (destruction delayed)
  - onContextLost
```
public final void onContextLost()
```
    Must be called when the OpenGL Context has been lost.
  - getModel
```
public final Model getModel()
```
    Returns:
    
    the instanced Model, which is always not null (even when loading is not complete). When asynchronous loading is complete, the instance Model will receive the loaded model and store it in its childs.
    
    See Also:
    
    Model.getChilds()
  - getModelIfLoaded
```
public final Model getModelIfLoaded()
```
    Returns:
    
    the instanced Model or null if loading is not complete.
  - getInternalModelIfLoaded
```
public final Model getInternalModelIfLoaded()
```
    Returns:
    
    the internal model if loaded.
    
    See Also:
    
    getModel()
  - isLoaded
```
public final boolean isLoaded()
```
    Returns:
    
    true if loaded
  - isLoadingFailed
```
public final boolean isLoadingFailed()
```
    Returns:
    
    true if loaded
  - isCreatedFromInstance
```
public final boolean isCreatedFromInstance()
```
    Returns:
    
    true if the model was instanced from a ModelInstance
  - isCreatedFromInstance
```
public final boolean isCreatedFromInstance(ModelInstance instance)
```
    Returns:
    
    true if the model was instanced from a ModelInstance
  - getFromInstance
```
public final ModelInstance getFromInstance()
```
    Returns:
    
    the ModelInstance name if the model has been instanced
  - isCreatedFromModel
```
public final boolean isCreatedFromModel()
```
    Returns:
    
    true if the model was instanced from a Model
  - isCreatedFromModel
```
public final boolean isCreatedFromModel(java.lang.String modelId)
```
    Parameters:
    
    modelId - identifier of the Model
  - getFromModel
```
public final AsyncModel getFromModel()
```
    Returns:
    
    the ModelInstance name if the model has been instanced
  - getModelID
```
public final java.lang.String getModelID()
```
    Returns:
    
    the model id of this instance
  - getLodDistance
```
public final float getLodDistance()
```
    Specified by:
    
    getLodDistance in interface ILod
    
    Returns:
    
    the distance between lod levels
  - getLodLevel
```
public final int getLodLevel()
```
    Specified by:
    
    getLodLevel in interface ILod
    
    Returns:
    
    the current lod level
  - getNumLodLevels
```
public final int getNumLodLevels()
```
    Specified by:
    
    getNumLodLevels in interface ILod
    
    Returns:
    
    the number of LOD levels
  - setLodLevel
```
public final void setLodLevel(int lodLevel)
```
    Specified by:
    
    setLodLevel in interface ILod
    
    Parameters:
    
    lodLevel - lod level to set
  - getAnimator
```
public SplineAnimator getAnimator()
```
  - setAnimator
```
public void setAnimator(SplineAnimator animatior)
```
  - isVisibleAndNotCulled
```
public final boolean isVisibleAndNotCulled()
```
  - isVisible
```
public final boolean isVisible()
```
    Specified by:
    
    isVisible in interface ICullable
  - setVisible
```
public final void setVisible(boolean visible)
```
  - isCulled
```
public final boolean isCulled()
```
    Specified by:
    
    isCulled in interface ICullable
    
    Returns:
    
    the cull value. true if the object is culled (hidden)
  - setCulled
```
public final void setCulled(boolean culled)
```
    Specified by:
    
    setCulled in interface ICullable
    
    Parameters:
    
    culled - cull state value. true if the object is to be culled (hidden)
  - getVolume
```
public final IVolume<?> getVolume(int boundingVolumeOptions)
```
    Specified by:
    
    getVolume in interface IBoundable
    
    Parameters:
    
    boundingVolumeOptions - bounding volume options.
    
    Returns:
    
    bounding volume, cast to BoundingBox or BoundingSphere depending on options.
    
    See Also:
    
    VolumeOptions, Box, Sphere, Cylinder, Capsule
  - 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 m)
```
    Specified by:
    
    getMatrix in interface ICullableNode
    
    Parameters:
    
    m - destination Mat4x4 to store local matrix
    
    Returns:
    
    dst or null if identity
  - getTransform
```
public final Transform getTransform(Transform dst)
```
    Specified by:
    
    getTransform in interface ITransformable
    
    Parameters:
    
    dst - storage of the Transform value (or the identity if the value is null)
    
    Returns:
    
    dst (or null if the value is null)
  - setTransform
```
public final void setTransform(Transform src)
```
    Specified by:
    
    setTransform in interface ITransformable
  - transform
```
public final void transform(Transform t)
```
    Specified by:
    
    transform in interface ITransformable

Class ModelInstance

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

renderOptions

Constructor Detail

ModelInstance

ModelInstance

Method Detail

toString

compareTo

getInstanceName

instanciate

instanciate

instanciate

onLoad

update

render

destroy

destroyAsync

onContextLost

getModel

getModelIfLoaded

getInternalModelIfLoaded

isLoaded

isLoadingFailed

isCreatedFromInstance

isCreatedFromInstance

getFromInstance

isCreatedFromModel

isCreatedFromModel

getFromModel

getModelID

getLodDistance

getLodLevel

getNumLodLevels

setLodLevel

getAnimator

setAnimator

isVisibleAndNotCulled

isVisible

setVisible

isCulled

setCulled

getVolume

getCullableNodes

getMatrix

getTransform

setTransform

transform