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

java.lang.Object
- com.bonzaiengine.BonzaiEngine

public final class BonzaiEngine
extends java.lang.Object

Bonzai engine singleton.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface BonzaiEngine.KeyStore

Nested Classes
Modifier and Type	Class and Description
`static interface`	`BonzaiEngine.KeyStore`

Field Summary

Fields
Modifier and Type Field and Description

static boolean ASSERT

boolean fastLoading
Deprecated.

static int MAX_NUM_HW_MATRICES

static boolean VERIFY

Fields
Modifier and Type	Field and Description
`static boolean`	`ASSERT`
`boolean`	`fastLoading` Deprecated.
`static int`	`MAX_NUM_HW_MATRICES`
`static boolean`	`VERIFY`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addSurfaceType(java.lang.String surfaceTypeName, ISurfaceType surfaceType)`
`static BonzaiEngine`	`get()`
`ShaderGeneratorConfig.LightingAlgo`	`getDefaultLightingAlgo()`
`float`	`getDefaultLodDistance()`
`int`	`getGlslVersion()`
`IWorker`	`getInternalWorker()`
`float`	`getPercentMergeDistance(int level)`
`float`	`getPositionMergeDistance(int level)`
`Renderer`	`getRenderer()`
`float`	`getRotationMergeDistance(int level)`
`float`	`getScaleMergeDistance(int level)`
`ISurfaceType`	`getSurfaceType(java.lang.String surfaceTypeName)`
`java.lang.String[]`	`getSurfaceTypeNames()`
`int`	`getTextureAlphaTestTreshold()`
`IWorker`	`getWorker()`
`boolean`	`isMerge(int level, Transform t1, Transform t2)`
`boolean`	`isMultipleRenderingContext()`
`boolean`	`isParallelizeOnMultipleThreads()`
`boolean`	`isReaderRemoveDegeneratedTriangles()`
`boolean`	`isUseAlphaToCoverage()`
`boolean`	`isWriter3dsSwapPosition()`
`boolean`	`isWriterExportNormals()`
`Model`	`read(AssetManager assets, ModelReaderSettings settings)`
`boolean`	`registerReader(java.lang.Class<? extends IModelReader> reader)`
`boolean`	`registerTextureIO(java.lang.Class<? extends ITextureIO> textureIO)`
`IWorker`	`requestInternalWorker()`
`byte[]`	`requestKey(Stream stream)`
`IWorker`	`requestWorker()`
`void`	`setDefaultLightingAlgo(ShaderGeneratorConfig.LightingAlgo lightingAlgo)`
`void`	`setDefaultLodDistance(float defaultLodDistance)`
`void`	`setGlslVersion(int glVersion)`
`void`	`setInternalWorker(IWorker internalWorker)`
`void`	`setKeyStore(BonzaiEngine.KeyStore keyStore)`
`void`	`setMultipleRenderingContext(boolean multipleRenderingContext)`
`void`	`setParallelizeOnMultipleThreads(boolean dispathWorkerOnMultipleThreads)`
`void`	`setPercentMergeDistance(int level, float percentMergeDistance)`
`void`	`setPositionMergeDistance(int level, float positionMergeDistance)`
`void`	`setReaderRemoveDegeneratedTriangles(boolean readerRemoveDegeneratedTriangles)`
`void`	`setRotationMergeDistance(int level, float rotationMergeDistance)`
`void`	`setScaleMergeDistance(int level, float scaleMergeDistance)`
`void`	`setTextureAlphaTestTreshold(int textureAlphaTestTreshold)`
`void`	`setUseAlphaToCoverage(boolean useAlphaToCoverage)`
`void`	`setWorker(IWorker worker)`
`void`	`setWriter3dsSwapPosition(boolean writer3dsSwapPosition)`
`void`	`setWriterExportNormals(boolean writerExportNormals)`
`boolean`	`unregisterReader(java.lang.Class<? extends IModelReader> reader)`
`boolean`	`unregisterTextureIO(java.lang.Class<? extends ITextureIO> textureIO)`

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

- Field Detail
  - ASSERT
```
public static final boolean ASSERT
```
    See Also:
    
    Constant Field Values
  - VERIFY
```
public static final boolean VERIFY
```
    See Also:
    
    Constant Field Values
  - MAX_NUM_HW_MATRICES
```
public static int MAX_NUM_HW_MATRICES
```
  - fastLoading
```
@Deprecated
public boolean fastLoading
```
    Deprecated.
    
    Force fastest loading
- Method Detail
  - get
```
public static final BonzaiEngine get()
```
  - registerReader
```
public boolean registerReader(java.lang.Class<? extends IModelReader> reader)
```
  - unregisterReader
```
public boolean unregisterReader(java.lang.Class<? extends IModelReader> reader)
```
  - registerTextureIO
```
public boolean registerTextureIO(java.lang.Class<? extends ITextureIO> textureIO)
```
  - unregisterTextureIO
```
public boolean unregisterTextureIO(java.lang.Class<? extends ITextureIO> textureIO)
```
  - setKeyStore
```
public void setKeyStore(BonzaiEngine.KeyStore keyStore)
```
    Parameters:
    
    keyStore -
  - requestKey
```
public byte[] requestKey(Stream stream)
```
  - read
```
public Model read(AssetManager assets,
                  ModelReaderSettings settings)
           throws java.io.IOException
```
    Returns:
    
    the Model read
    
    Throws:
    
    java.io.IOException - if the Model can't be read
  - getRenderer
```
public Renderer getRenderer()
```
  - isMultipleRenderingContext
```
public boolean isMultipleRenderingContext()
```
    Returns:
    
    flag to indicates the engine will be used to render in multiple OpenGL context, or true for default
  - setMultipleRenderingContext
```
public void setMultipleRenderingContext(boolean multipleRenderingContext)
```
  - getGlslVersion
```
public int getGlslVersion()
```
    Returns:
    
    the GLSL version previously set with setGlslVersion(int), or -1 for default
  - setGlslVersion
```
public void setGlslVersion(int glVersion)
```
  - getPercentMergeDistance
```
public float getPercentMergeDistance(int level)
```
    Parameters:
    level - Animation compression level:
    
    0 (Light): Light animation compression: compression is very small (close to negligible) so there should be no visual effect.
    
    1 (Medium): Good animation compression with in general no visual side effect
    
    2 (Heavy): Heavy compression which generally causes some slight visual vibration effect.
    See Also:
    
    setPercentMergeDistance(int, float)
  - setPercentMergeDistance
```
public void setPercentMergeDistance(int level,
                                    float percentMergeDistance)
```
    See Also:
    
    getPercentMergeDistance(int)
  - getPositionMergeDistance
```
public float getPositionMergeDistance(int level)
```
    Parameters:
    level - Animation compression level:
    
    0 (Light): Light animation compression: compression is very small (close to negligible) so there should be no visual effect.
    
    1 (Medium): Good animation compression with in general no visual side effect
    
    2 (Heavy): Heavy compression which generally causes some slight visual vibration effect.
    See Also:
    
    setPositionMergeDistance(int, float)
  - setPositionMergeDistance
```
public void setPositionMergeDistance(int level,
                                     float positionMergeDistance)
```
    See Also:
    
    getPositionMergeDistance(int)
  - getRotationMergeDistance
```
public float getRotationMergeDistance(int level)
```
    Parameters:
    level - Animation compression level:
    
    0 (Light): Light animation compression: compression is very small (close to negligible) so there should be no visual effect.
    
    1 (Medium): Good animation compression with in general no visual side effect
    
    2 (Heavy): Heavy compression which generally causes some slight visual vibration effect.
    See Also:
    
    setRotationMergeDistance(int, float)
  - setRotationMergeDistance
```
public void setRotationMergeDistance(int level,
                                     float rotationMergeDistance)
```
    See Also:
    
    getRotationMergeDistance(int)
  - getScaleMergeDistance
```
public float getScaleMergeDistance(int level)
```
    Parameters:
    level - Animation compression level:
    
    0 (Light): Light animation compression: compression is very small (close to negligible) so there should be no visual effect.
    
    1 (Medium): Good animation compression with in general no visual side effect
    
    2 (Heavy): Heavy compression which generally causes some slight visual vibration effect.
    See Also:
    
    setScaleMergeDistance(int, float)
  - setScaleMergeDistance
```
public void setScaleMergeDistance(int level,
                                  float scaleMergeDistance)
```
    See Also:
    
    getScaleMergeDistance(int)
  - isMerge
```
public boolean isMerge(int level,
                       Transform t1,
                       Transform t2)
```
    See Also:
    
    setPositionMergeDistance(int, float), setRotationMergeDistance(int, float), setScaleMergeDistance(int, float)
  - isWriterExportNormals
```
public boolean isWriterExportNormals()
```
    Returns:
    
    true is normal are written by exporters.
  - setWriterExportNormals
```
public void setWriterExportNormals(boolean writerExportNormals)
```
    See Also:
    
    isWriterExportNormals()
  - isWriter3dsSwapPosition
```
public boolean isWriter3dsSwapPosition()
```
    Returns:
    
    true if writer swap position. Default: false
  - setWriter3dsSwapPosition
```
public void setWriter3dsSwapPosition(boolean writer3dsSwapPosition)
```
    See Also:
    
    isWriter3dsSwapPosition()
  - isReaderRemoveDegeneratedTriangles
```
public boolean isReaderRemoveDegeneratedTriangles()
```
    Returns:
    
    true if reader ermove degenerated triangle (time consuming). Default: false
  - setReaderRemoveDegeneratedTriangles
```
public void setReaderRemoveDegeneratedTriangles(boolean readerRemoveDegeneratedTriangles)
```
    See Also:
    
    isReaderRemoveDegeneratedTriangles()
  - isUseAlphaToCoverage
```
public boolean isUseAlphaToCoverage()
```
    Returns:
    
    true if alpha to coverage is used (alpha antialiasing). Default: false
  - setUseAlphaToCoverage
```
public void setUseAlphaToCoverage(boolean useAlphaToCoverage)
```
    See Also:
    
    isUseAlphaToCoverage()
  - getDefaultLodDistance
```
public float getDefaultLodDistance()
```
    Returns:
    
    the distance threshold to switch lod level. Default: 40
  - setDefaultLodDistance
```
public void setDefaultLodDistance(float defaultLodDistance)
```
    See Also:
    
    getDefaultLodDistance()
  - getTextureAlphaTestTreshold
```
public int getTextureAlphaTestTreshold()
```
    Returns:
    
    the threshold to consider texture us alpha test instead of blending. Default: 5
  - setTextureAlphaTestTreshold
```
public void setTextureAlphaTestTreshold(int textureAlphaTestTreshold)
```
    See Also:
    
    getTextureAlphaTestTreshold()
  - isParallelizeOnMultipleThreads
```
public boolean isParallelizeOnMultipleThreads()
```
    Returns:
    
    true if algorithms are allowed to use internal threads to parallelize efficiently computation on multiple threads (for efficient of multiprocessor cpu).
    Default: true
    
    See Also:
    
    setInternalWorker(IWorker)
  - setParallelizeOnMultipleThreads
```
public void setParallelizeOnMultipleThreads(boolean dispathWorkerOnMultipleThreads)
```
    See Also:
    
    isParallelizeOnMultipleThreads()
  - getWorker
```
public IWorker getWorker()
```
    Returns:
    
    shared IWorker to dispatch asynchronous work (used by the engine for asset loading)
  - setWorker
```
public void setWorker(IWorker worker)
```
    See Also:
    
    getWorker()
  - requestWorker
```
public IWorker requestWorker()
```
    Throws:
    
    java.lang.IllegalStateException - if worker is not set
    
    See Also:
    
    getWorker()
  - getInternalWorker
```
public IWorker getInternalWorker()
```
    Returns:
    
    IWorker use by internal implementation for asynchronous/parallel work
  - setInternalWorker
```
public void setInternalWorker(IWorker internalWorker)
```
    See Also:
    
    getInternalWorker()
  - requestInternalWorker
```
public IWorker requestInternalWorker()
```
    Throws:
    
    java.lang.IllegalStateException - if internal worker is not set
    
    See Also:
    
    getInternalWorker()
  - getDefaultLightingAlgo
```
public ShaderGeneratorConfig.LightingAlgo getDefaultLightingAlgo()
```
  - setDefaultLightingAlgo
```
public void setDefaultLightingAlgo(ShaderGeneratorConfig.LightingAlgo lightingAlgo)
```
  - addSurfaceType
```
public void addSurfaceType(java.lang.String surfaceTypeName,
                           ISurfaceType surfaceType)
```
  - getSurfaceType
```
public ISurfaceType getSurfaceType(java.lang.String surfaceTypeName)
```
  - getSurfaceTypeNames
```
public java.lang.String[] getSurfaceTypeNames()
```

Class BonzaiEngine

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ASSERT

VERIFY

MAX_NUM_HW_MATRICES

fastLoading

Method Detail

get

registerReader

unregisterReader

registerTextureIO

unregisterTextureIO

setKeyStore

requestKey

read

getRenderer

isMultipleRenderingContext

setMultipleRenderingContext

getGlslVersion

setGlslVersion

getPercentMergeDistance

setPercentMergeDistance

getPositionMergeDistance

setPositionMergeDistance

getRotationMergeDistance

setRotationMergeDistance

getScaleMergeDistance

setScaleMergeDistance

isMerge

isWriterExportNormals

setWriterExportNormals

isWriter3dsSwapPosition

setWriter3dsSwapPosition

isReaderRemoveDegeneratedTriangles

setReaderRemoveDegeneratedTriangles

isUseAlphaToCoverage

setUseAlphaToCoverage

getDefaultLodDistance

setDefaultLodDistance

getTextureAlphaTestTreshold

setTextureAlphaTestTreshold

isParallelizeOnMultipleThreads

setParallelizeOnMultipleThreads

getWorker

setWorker

requestWorker

getInternalWorker

setInternalWorker

requestInternalWorker

getDefaultLightingAlgo

setDefaultLightingAlgo

addSurfaceType

getSurfaceType

getSurfaceTypeNames