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

java.lang.Object
- com.bonzaiengine.io.ReaderSettings
- - com.bonzaiengine.model.reader.ModelReaderSettings

All Implemented Interfaces:

java.lang.Cloneable
```
public class ModelReaderSettings
extends ReaderSettings
```
All settings related to the model loading.

Field Summary

Fields
Modifier and Type	Field and Description
`boolean`	`addPathInTextureFinder` Register model location as a search path for texture.
`boolean`	`animated` Flag for animation.
`Stream[]`	`animationAdditional` Animation file name: extra files.
`AnimationSplitInfo[]`	`animationSplit` Split skeleton animation utility Usefull for MS3D, Collada/DAE and other model format which stores in one combined/merged animation.
`int`	`animationSplitIndex` Index of the motion to split Ignore for JMF/JMA models
`Stream`	`animationStream` Animation file name.
`int`	`boundingVolumeGenerated` Bounding volume pre-generated.
`boolean`	`character` Load as character.
`static java.lang.String`	`DEFAULT_ANIM_NAME`
`IExtraAsset`	`extraAsset`
`float`	`heightmapGridDepth` Terrain grid height unit, along z.
`float`	`heightmapGridWidth` Terrain grid width unit, along x.
`float`	`heightmapHeight` Height of the terrain, along y.
`int`	`heightmapOctreeMaxFaces` Heightmap integrated space partitioning.
`boolean`	`keepTextureRelPath` Keep texture relative path
`LightingMode`	`lighting` Lighting mode.
`float`	`lightingSmoothAngle` Smooth angle in radians used by `LightingMode.Default`, `LightingMode.SmoothAngle` and `LightingMode.SmoothGroupAndAngle` Ignored for JMF/JMA models
`ModelReaderSettings`	`lod1` Level Of Details (LOD) 1
`ModelReaderSettings`	`lod2` Level Of Details (LOD) 2
`ModelReaderSettings`	`lod3` Level Of Details (LOD) 3
`int`	`octreeMaxFaces` Maximum number of face per octree.
`int`	`octreeMaxSubdivisions` Maximum number of subdivision.
`float`	`octreeMinVolume` Maximum volume of an octree.
`boolean`	`octreeOptimizeMesh` Optimize mesh for octree.
`Optimizer`	`optimizer` Optimization options Ignored for JMF/JMA models
`Options`	`options` Reader and other options
`java.lang.String`	`prependTexturePath` Path to prepend to the texture name.
`java.lang.String`	`qualityName` Model quality identifier.
`java.lang.String`	`skinName` Model skin name.
`boolean`	`spacePartitioning` Space partitioning of the model.
`Stream`	`textureStream` Texture file folder.
`Stream`	`weaponStream` Weapon model file folder.

Fields inherited from class com.bonzaiengine.io.ReaderSettings
formatExt, id, key, stream

Constructor Summary

Constructors
Constructor and Description

ModelReaderSettings()

Constructors
Constructor and Description
`ModelReaderSettings()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ModelReaderSettings`	`clone()`
`boolean`	`equals(java.lang.Object obj)`
`java.lang.String`	`getDefaultSkinAnimName()` Internal use `IModelReader`
`static java.lang.String`	`materialName(java.lang.String s)` Internal use `IModelReader`
`static java.lang.String`	`materialName(java.lang.String s, boolean removeFolderSeparator, boolean removeFileSeparator)` Internal use `IModelReader`
`void`	`postProcess(Model model)` Internal use
`static void`	`precomputeBv(Model model, int bvOptions)`
`void`	`registerPath(AssetManager assets, java.lang.String path)` Internal use `IModelReader`
`static void`	`split(Model model, AnimationSplitInfo[] splitInfos, int motionIndex)` Split model skeleton animation.
`java.lang.String`	`textureName(java.lang.String textureName)` Internal use `IModelReader`

Methods inherited from class com.bonzaiengine.io.ReaderSettings
addStreamListener, fireStreamAccess_, getFormatExtension, getId, setStreamListeners

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

- Field Detail
  - DEFAULT_ANIM_NAME
```
public static final java.lang.String DEFAULT_ANIM_NAME
```
    See Also:
    
    Constant Field Values
  - weaponStream
```
public Stream weaponStream
```
    Weapon model file folder. Used with MD3 models.
  - animated
```
public boolean animated
```
    Flag for animation. By default false, with ignore animation informations.
    Ignored for JMF/JMA models
  - animationStream
```
public Stream animationStream
```
    Animation file name. Used with LWO, MD5, JMF, JMA.
  - animationAdditional
```
public Stream[] animationAdditional
```
    Animation file name: extra files. Used with MD5, JMF, JMA.
  - animationSplit
```
public AnimationSplitInfo[] animationSplit
```
    Split skeleton animation utility
    Usefull for MS3D, Collada/DAE and other model format which stores in one combined/merged animation.
    Ignored for JMF/JMA models
    
    See Also:
    
    animationSplitIndex
  - animationSplitIndex
```
public int animationSplitIndex
```
    Index of the motion to split Ignore for JMF/JMA models
    
    See Also:
    
    animationSplit, Skeleton.getMotion(int)
  - textureStream
```
public Stream textureStream
```
    Texture file folder.
    Used with MD2 and Heightmap.
  - character
```
public boolean character
```
    Load as character.
    Used with MD3 to link head, lower and upper models.
  - qualityName
```
public java.lang.String qualityName
```
    Model quality identifier.
    Used with MD3.
  - skinName
```
public java.lang.String skinName
```
    Model skin name.
    Used with MD3.
  - heightmapHeight
```
public float heightmapHeight
```
    Height of the terrain, along y.
    Used with Heightmap.
  - heightmapGridWidth
```
public float heightmapGridWidth
```
    Terrain grid width unit, along x.
    Used with Heightmap.
  - heightmapGridDepth
```
public float heightmapGridDepth
```
    Terrain grid height unit, along z.
    Used with Heightmap.
  - heightmapOctreeMaxFaces
```
public int heightmapOctreeMaxFaces
```
    Heightmap integrated space partitioning.
    Used with Heightmap.
  - lighting
```
public LightingMode lighting
```
    Lighting mode. If LightingMode.None is specified, normals will not be read/computed and realtime lighting will not be available for the model.
    Ignored for JMF/JMA models
    
    See Also:
    
    LightingMode, LightingMode.Default
  - lightingSmoothAngle
```
public float lightingSmoothAngle
```
    Smooth angle in radians used by LightingMode.Default, LightingMode.SmoothAngle and LightingMode.SmoothGroupAndAngle
    Ignored for JMF/JMA models
    
    See Also:
    
    LightingMode.Default, LightingMode.SmoothAngle, LightingMode.SmoothGroupAndAngle
  - boundingVolumeGenerated
```
public int boundingVolumeGenerated
```
    Bounding volume pre-generated.
    Usage: boundingVolumeOptions = BoundingVolume_Box [| BoundingVolume_Sphere] [| BoundingVolume_Cylinder] [| BoundingVolume_Capsule]
    Default value: BoundingVolume_Box
  - spacePartitioning
```
public boolean spacePartitioning
```
    Space partitioning of the model. By default: false.
    Ignored for JMF/JMA models
  - octreeOptimizeMesh
```
public boolean octreeOptimizeMesh
```
    Optimize mesh for octree. By default: on
    Ignored for JMF/JMA models
  - octreeMaxSubdivisions
```
public int octreeMaxSubdivisions
```
    Maximum number of subdivision. Must be specified. By default: -1 (no subdivision)
    Ignored for JMF/JMA models
  - octreeMaxFaces
```
public int octreeMaxFaces
```
    Maximum number of face per octree. By default: -1 (no face limitation)
    Ignored for JMF/JMA models
  - octreeMinVolume
```
public float octreeMinVolume
```
    Maximum volume of an octree. By default: -1 (no volume limitation)
    Ignored for JMF/JMA models
  - addPathInTextureFinder
```
public boolean addPathInTextureFinder
```
    Register model location as a search path for texture. Default: true
  - prependTexturePath
```
public java.lang.String prependTexturePath
```
    Path to prepend to the texture name. Default: null
    Ignored for JMF/JMA models
  - keepTextureRelPath
```
public boolean keepTextureRelPath
```
    Keep texture relative path
  - optimizer
```
public Optimizer optimizer
```
    Optimization options
    Ignored for JMF/JMA models
  - options
```
public final Options options
```
    Reader and other options
  - lod1
```
public ModelReaderSettings lod1
```
    Level Of Details (LOD) 1
  - lod2
```
public ModelReaderSettings lod2
```
    Level Of Details (LOD) 2
  - lod3
```
public ModelReaderSettings lod3
```
    Level Of Details (LOD) 3
  - extraAsset
```
public IExtraAsset extraAsset
```
- Constructor Detail
  - ModelReaderSettings
```
public ModelReaderSettings()
```
- Method Detail
  - clone
```
public final ModelReaderSettings clone()
```
    Overrides:
    
    clone in class ReaderSettings
  - equals
```
public final boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class ReaderSettings
  - registerPath
```
public final void registerPath(AssetManager assets,
                               java.lang.String path)
```
    Internal use IModelReader
  - textureName
```
public final java.lang.String textureName(java.lang.String textureName)
```
    Internal use IModelReader
  - getDefaultSkinAnimName
```
public final java.lang.String getDefaultSkinAnimName()
```
    Internal use IModelReader
  - materialName
```
public static final java.lang.String materialName(java.lang.String s)
```
    Internal use IModelReader
  - materialName
```
public static final java.lang.String materialName(java.lang.String s,
                                                  boolean removeFolderSeparator,
                                                  boolean removeFileSeparator)
```
    Internal use IModelReader
  - postProcess
```
public final void postProcess(Model model)
```
    Internal use
  - precomputeBv
```
public static void precomputeBv(Model model,
                                int bvOptions)
```
  - split
```
public static void split(Model model,
                         AnimationSplitInfo[] splitInfos,
                         int motionIndex)
```
    Split model skeleton animation.
    This is usefull for model format such as MS3D and Collada.
    
    Parameters:
    
    model -
    
    splitInfos -

Class ModelReaderSettings

Field Summary

Fields inherited from class com.bonzaiengine.io.ReaderSettings

Constructor Summary

Method Summary

Methods inherited from class com.bonzaiengine.io.ReaderSettings

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_ANIM_NAME

weaponStream

animated

animationStream

animationAdditional

animationSplit

animationSplitIndex

textureStream

character

qualityName

skinName

heightmapHeight

heightmapGridWidth

heightmapGridDepth

heightmapOctreeMaxFaces

lighting

lightingSmoothAngle

boundingVolumeGenerated

spacePartitioning

octreeOptimizeMesh

octreeMaxSubdivisions

octreeMaxFaces

octreeMinVolume

addPathInTextureFinder

prependTexturePath

keepTextureRelPath

optimizer

options

lod1

lod2

lod3

extraAsset

Constructor Detail

ModelReaderSettings

Method Detail

clone

equals

registerPath

textureName

getDefaultSkinAnimName

materialName

materialName

postProcess

precomputeBv

split