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

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

All Implemented Interfaces:

ITransformable, IDestroyable, ITree<Mesh>, IBoundable, ICullable, ICullableNode, java.lang.Cloneable, java.lang.Comparable<Mesh>
```
public final class Mesh
extends java.lang.Object
implements IDestroyable, java.lang.Cloneable, java.lang.Comparable<Mesh>, ITransformable, ITree<Mesh>, ICullableNode
```
Mesh geometry datas, sub meshes hierarchy, and rendering properties.

Field Summary

Fields
Modifier and Type Field and Description

java.lang.String name
Mesh name

Fields
Modifier and Type	Field and Description
`java.lang.String`	`name` Mesh name

Constructor Summary

Constructors
Constructor and Description

Mesh()

Constructors
Constructor and Description
`Mesh()`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addChild(Mesh mesh)`
`void`	`addGeometry(GeometryData geometry)`
`int`	`compareTo(Mesh o)`
`void`	`destroy(IGLApi glApi)`
`Mesh`	`duplicate(boolean duplicateHierarchy, boolean duplicateAnimation, boolean duplicateMaterialKey)`
`Mesh`	`getChild(int index)`
`Array<Mesh>`	`getChilds()`
`java.lang.Iterable<? extends ICullable>`	`getCullableNodes()`
`Array<GeometryData>`	`getGeometries()`
`java.lang.String`	`getLinkToJoint()`
`Mat4x4`	`getMatrix()`
`Mat4x4`	`getMatrix(Mat4x4 dst)`
`int`	`getNumChilds()`
`int`	`getNumFaces()`
`int`	`getNumGeometries()`
`int`	`getNumIndices()`
`int`	`getNumVertices()`
`Transform`	`getTransform()`
`Transform`	`getTransform(Transform dst)`
`KeyFrame<Transform>`	`getTransforms()`
`IVolume<?>`	`getVolume(int bvOptions)` By default the bounding box do not includes sub meshes (`childs`), to includes sub meshes uses this flag : VolumeOptions#BV_SUB_OBJECTS By default, all model/meshes are included in the bounding box even invisible object.
`boolean`	`isCulled()`
`boolean`	`isDrawBoundingVolume()`
`boolean`	`isLinkedToJoint()`
`boolean`	`isVisible()`
`boolean`	`isVisibleAndNotCulled()`
`void`	`onAnimationChanged()` This method must be called when `transforms` has been manually modified (add, remove, clear, null, ...).
`void`	`onHierarchyChanged()` This method must be called when `childs` has been manually modified (add, remove, clear, ...).
`boolean`	`removeChild(Mesh mesh)`
`boolean`	`removeGeometry(GeometryData geometry)`
`Array<Mesh>`	`setChilds(Array<Mesh> childs)`
`void`	`setCulled(boolean culled)`
`void`	`setDrawBoundingVolume(boolean drawBoundingVolume)`
`Array<GeometryData>`	`setGeometries(Array<GeometryData> geometries)`
`void`	`setLinkToJoint(java.lang.String jointName)` Link this `Mesh` to a `Skeleton` `Joint`.
`void`	`setTransform(Transform src)`
`void`	`setTransforms(KeyFrame<Transform> keyFrame)`
`void`	`setVisible(boolean visible)`
`java.lang.String`	`toString()`
`void`	`transform(Transform transform)` Post multiply by the transform specified
`void`	`useTangents(boolean[] useTangents)` Deprecated.

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

- Field Detail
  - name
```
public java.lang.String name
```
    Mesh name
- Constructor Detail
  - Mesh
```
public Mesh()
```
- Method Detail
  - toString
```
public final java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - compareTo
```
public final int compareTo(Mesh o)
```
    Specified by:
    
    compareTo in interface java.lang.Comparable<Mesh>
  - duplicate
```
public Mesh duplicate(boolean duplicateHierarchy,
                      boolean duplicateAnimation,
                      boolean duplicateMaterialKey)
```
    Parameters:
    
    duplicateHierarchy -
    
    duplicateAnimation - used if parameter duplicateHierarchy is true
    
    duplicateMaterialKey - used if parameter duplicateHierarchy is true
    
    Returns:
    
    new Mesh
  - destroy
```
public final void destroy(IGLApi glApi)
```
    Specified by:
    
    destroy in interface IDestroyable
  - getNumChilds
```
public final int getNumChilds()
```
    Specified by:
    
    getNumChilds in interface ITree<Mesh>
    
    Returns:
    
    the number of direct childs.
  - addChild
```
public final void addChild(Mesh mesh)
```
    Specified by:
    
    addChild in interface ITree<Mesh>
    
    Parameters:
    
    mesh - new child to add this this Mesh
  - removeChild
```
public final boolean removeChild(Mesh mesh)
```
    Parameters:
    
    mesh - a Mesh to remove
    
    Returns:
    
    true if the Mesh has been removed from this Mesh
  - getChilds
```
public final Array<Mesh> getChilds()
```
  - getChild
```
public final Mesh getChild(int index)
```
    Specified by:
    
    getChild in interface ITree<Mesh>
    
    Parameters:
    
    index - in the range [0; ITree.getNumChilds()[
    
    Returns:
    
    the child at the specified index
  - setChilds
```
public final Array<Mesh> setChilds(Array<Mesh> childs)
```
    Parameters:
    
    childs -
    
    Returns:
    
    old value
  - getNumGeometries
```
public final int getNumGeometries()
```
    Returns:
    
    the number of geometries of this Mesh.
  - addGeometry
```
public final void addGeometry(GeometryData geometry)
```
    Parameters:
    
    geometry - new GeometryData to add this this Mesh
  - removeGeometry
```
public final boolean removeGeometry(GeometryData geometry)
```
    Parameters:
    
    geometry - a GeometryData to remove
    
    Returns:
    
    true if the GeometryData has been removed from this Mesh
  - getGeometries
```
public final Array<GeometryData> getGeometries()
```
  - setGeometries
```
public final Array<GeometryData> setGeometries(Array<GeometryData> geometries)
```
    Parameters:
    
    geometries -
    
    Returns:
    
    old value
  - getNumFaces
```
public int getNumFaces()
```
    Returns:
    
    the number of faces of this mesh.
  - getNumIndices
```
public int getNumIndices()
```
    Returns:
    
    the number of vertices of this mesh.
  - getNumVertices
```
public int getNumVertices()
```
    Returns:
    
    the number of vertices indexed of this mesh. This is equivalent to vertices.positions.length
  - getCullableNodes
```
public final java.lang.Iterable<? extends ICullable> 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 Mesh, or null if identity
  - isLinkedToJoint
```
public final boolean isLinkedToJoint()
```
    Returns:
    
    true if this Mesh is linked to a Joint.
    
    See Also:
    
    getLinkToJoint(), setLinkToJoint(String)
  - getLinkToJoint
```
public final java.lang.String getLinkToJoint()
```
    Returns:
    
    the Joint name the Mesh is linked to, or null
    
    See Also:
    
    setLinkToJoint(String)
  - setLinkToJoint
```
public final void setLinkToJoint(java.lang.String jointName)
```
    Link this Mesh to a Skeleton Joint.
    This is used for static mesh to follow a skeleton motion.
    
    Parameters:
    
    jointName - a Joint name
  - getTransforms
```
public final KeyFrame<Transform> getTransforms()
```
  - setTransforms
```
public final void setTransforms(KeyFrame<Transform> keyFrame)
```
  - 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 Mesh, or null if identity
  - transform
```
public final void transform(Transform transform)
```
    Post multiply by the transform specified
    
    Specified by:
    
    transform in interface ITransformable
  - getVolume
```
public IVolume<?> getVolume(int bvOptions)
```
    By default the bounding box do not includes sub meshes (childs), to includes sub meshes uses this flag : VolumeOptions#BV_SUB_OBJECTS
    
    By default, all model/meshes are included in the bounding box even invisible object.
    To ignore invisible object, uses : VolumeOptions#BV_VISIBLE
    
    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
  - 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 has been manually modified (add, remove, clear, ...).
  - useTangents
```
@Deprecated
public final void useTangents(boolean[] useTangents)
```
    Deprecated.
    
    Internal
  - 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)
```

Class Mesh

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

name

Constructor Detail

Mesh

Method Detail

toString

compareTo

duplicate

destroy

getNumChilds

addChild

removeChild

getChilds

getChild

setChilds

getNumGeometries

addGeometry

removeGeometry

getGeometries

setGeometries

getNumFaces

getNumIndices

getNumVertices

getCullableNodes

getMatrix

getMatrix

isLinkedToJoint

getLinkToJoint

setLinkToJoint

getTransforms

setTransforms

getTransform

setTransform

getTransform

transform

getVolume

onAnimationChanged

onHierarchyChanged

useTangents

isVisibleAndNotCulled

isVisible

setVisible

isCulled

setCulled

isDrawBoundingVolume

setDrawBoundingVolume