Geometry (jMonkeyEngine3)

java.lang.Object
- com.jme3.scene.Spatial
- - com.jme3.scene.Geometry

All Implemented Interfaces:

HasLocalTransform, CloneableSmartAsset, Collidable, Savable, JmeCloneable, java.lang.Cloneable

Direct Known Subclasses:

InstancedGeometry, ParticleEmitter, Picture, TerrainPatch
```
public class Geometry
extends Spatial
```
Geometry defines a leaf node of the scene graph. The leaf node contains the geometric data for rendering objects. It manages all rendering information such as a Material object to define how the surface should be shaded and the Mesh data to contain the actual geometry.

Nested Class Summary
- Nested classes/interfaces inherited from class com.jme3.scene.Spatial
  Spatial.BatchHint, Spatial.CullHint, Spatial.DFSMode

Field Summary

Fields
Modifier and Type	Field and Description
`protected Matrix4f`	`cachedWorldMat`
`protected GeometryGroupNode`	`groupNode` Specifies which `GeometryGroupNode` this `Geometry` is managed by.
`protected boolean`	`ignoreTransform` When true, the geometry's transform will not be applied.
`protected int`	`lodLevel`
`protected Material`	`material`
`protected Mesh`	`mesh`
`static int`	`SAVABLE_VERSION`
`protected int`	`startIndex` The start index of this `Geometry's` inside the `GeometryGroupNode`.

Fields inherited from class com.jme3.scene.Spatial
batchHint, controls, cullHint, frustrumIntersects, key, localLights, localOverrides, localTransform, name, parent, queueBucket, queueDistance, refreshFlags, RF_BOUND, RF_CHILD_LIGHTLIST, RF_LIGHTLIST, RF_MATPARAM_OVERRIDE, RF_TRANSFORM, shadowMode, userData, worldBound, worldLights, worldOverrides, worldTransform

Constructor Summary

Constructors
Constructor and Description
`Geometry()` Instantiate a `Geometry` with no name, no mesh, and no material.
`Geometry(java.lang.String name)` Create a geometry node without any mesh data.
`Geometry(java.lang.String name, Mesh mesh)` Create a geometry node with mesh data.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`associateWithGroupNode(GeometryGroupNode node, int startIndex)` Associate this `Geometry` with a `GeometryGroupNode`.
`protected void`	`breadthFirstTraversal(SceneGraphVisitor visitor, java.util.Queue<Spatial> queue)`
`boolean`	`checkCulling(Camera cam)` `checkCulling` checks the spatial with the camera to see if it should be culled.
`Geometry`	`clone()` This version of clone is a shallow clone, in other words, the same mesh is referenced as the original geometry.
`Geometry`	`clone(boolean cloneMaterial)` This version of clone is a shallow clone, in other words, the same mesh is referenced as the original geometry.
`void`	`cloneFields(Cloner cloner, java.lang.Object original)` Called internally by com.jme3.util.clone.Cloner.
`int`	`collideWith(Collidable other, CollisionResults results)` Check collision with another Collidable.
`void`	`computeWorldMatrix()` Recomputes the matrix returned by `getWorldMatrix()`.
`Spatial`	`deepClone()` Create a deep clone of the geometry.
`void`	`depthFirstTraversal(SceneGraphVisitor visitor, Spatial.DFSMode mode)` Visit each scene graph element ordered by DFS.
`MorphTarget`	`getFallbackMorphTarget()`
`int`	`getLodLevel()` Returns the LOD level set with `setLodLevel(int)`.
`Material`	`getMaterial()` Returns the material that is used for this geometry.
`Mesh`	`getMesh()` Returns the mesh to use for this geometry
`BoundingVolume`	`getModelBound()`
`float[]`	`getMorphState()` returns the morph state of this Geometry.
`float`	`getMorphState(java.lang.String morphTarget)` Get the state of a morph
`int`	`getNbSimultaneousGPUMorph()` Return the number of morph targets that can be handled on the GPU simultaneously for this geometry.
`int`	`getTriangleCount()` Returns this geometry's mesh triangle count.
`int`	`getVertexCount()` Returns this geometry's mesh vertex count.
`Matrix4f`	`getWorldMatrix()` A `matrix` that transforms the `mesh` from model space to world space.
`boolean`	`isBatched()` Deprecated. Use `isGrouped()` instead.
`boolean`	`isDirtyMorph()` returns true if the morph state has changed on the last frame.
`boolean`	`isGrouped()` Determine whether this `Geometry` is managed by a `GeometryGroupNode` or not.
`boolean`	`isIgnoreTransform()`
`Spatial`	`oldDeepClone()`
`void`	`read(JmeImporter im)`
`boolean`	`removeFromParent()` `removeFromParent` removes this Spatial from its parent.
`void`	`setDirtyMorph(boolean dirtyMorph)` Setting this to true will stop this geometry morph buffer to be updated, unless the morph state changes
`void`	`setFallbackMorphTarget(MorphTarget fallbackMorphTarget)`
`void`	`setIgnoreTransform(boolean ignoreTransform)`
`void`	`setLodLevel(int lod)` Sets the LOD level to use when rendering the mesh of this geometry.
`void`	`setMaterial(Material material)` Sets the material to use for this geometry.
`void`	`setMesh(Mesh mesh)` Sets the mesh to use for this geometry when rendering.
`void`	`setModelBound(BoundingVolume modelBound)` Sets the model bound to use for this geometry.
`void`	`setMorphState(float[] state)`
`void`	`setMorphState(java.lang.String morphTarget, float state)` Set the state of the morph with the given name.
`void`	`setNbSimultaneousGPUMorph(int nbSimultaneousGPUMorph)` Sets the number of morph targets that can be handled on the GPU simultaneously for this geometry.
`protected void`	`setParent(Node parent)` Called by `Node.attachChild(Spatial)` and `Node.detachChild(Spatial)` - don't call directly.
`void`	`unassociateFromGroupNode()` Removes the `GeometryGroupNode` association from this `Geometry`.
`void`	`updateModelBound()` Updates the bounding volume of the mesh.
`protected void`	`updateWorldBound()` `updateWorldBound` updates the bounding volume that contains this geometry.
`protected void`	`updateWorldLightList()`
`protected void`	`updateWorldTransforms()` Should only be called from updateGeometricState().
`void`	`write(JmeExporter ex)`

Methods inherited from class com.jme3.scene.Spatial
addControl, addControlAt, addLight, addMatParamOverride, breadthFirstTraversal, center, clearMatParamOverrides, depthFirstTraversal, forceRefresh, getBatchHint, getControl, getControl, getCullHint, getKey, getLastFrustumIntersection, getLocalBatchHint, getLocalCullHint, getLocalLightList, getLocalMatParamOverrides, getLocalQueueBucket, getLocalRotation, getLocalScale, getLocalShadowMode, getLocalToWorldMatrix, getLocalTransform, getLocalTranslation, getName, getNumControls, getParent, getQueueBucket, getShadowMode, getUserData, getUserDataKeys, getWorldBound, getWorldLightList, getWorldMatParamOverrides, getWorldRotation, getWorldScale, getWorldTransform, getWorldTranslation, hasAncestor, jmeClone, localToWorld, lookAt, matches, move, move, oldClone, removeControl, removeControl, removeLight, removeMatParamOverride, rotate, rotate, rotateUpTo, runControlRender, scale, scale, setBatchHint, setBoundRefresh, setCullHint, setKey, setLastFrustumIntersection, setLightListRefresh, setLocalRotation, setLocalRotation, setLocalScale, setLocalScale, setLocalScale, setLocalTransform, setLocalTranslation, setLocalTranslation, setMatParamOverrideRefresh, setName, setQueueBucket, setRequiresUpdates, setShadowMode, setTransformRefresh, setUserData, toString, updateGeometricState, updateLogicalState, updateMatParamOverrides, worldToLocal

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

- Field Detail
  - SAVABLE_VERSION
```
public static final int SAVABLE_VERSION
```
    See Also:
    
    Constant Field Values
  - mesh
```
protected Mesh mesh
```
  - lodLevel
```
protected transient int lodLevel
```
  - material
```
protected Material material
```
  - ignoreTransform
```
protected boolean ignoreTransform
```
    When true, the geometry's transform will not be applied.
  - cachedWorldMat
```
protected transient Matrix4f cachedWorldMat
```
  - groupNode
```
protected GeometryGroupNode groupNode
```
    Specifies which GeometryGroupNode this Geometry is managed by.
  - startIndex
```
protected int startIndex
```
    The start index of this Geometry's inside the GeometryGroupNode.
- Constructor Detail
  - Geometry
```
public Geometry()
```
    Instantiate a Geometry with no name, no mesh, and no material. The mesh and material must be set prior to rendering.
  - Geometry
```
public Geometry(java.lang.String name)
```
    Create a geometry node without any mesh data. Both the mesh and the material are null, the geometry cannot be rendered until those are set.
    
    Parameters:
    
    name - The name of this geometry
  - Geometry
```
public Geometry(java.lang.String name,
                Mesh mesh)
```
    Create a geometry node with mesh data. The material of the geometry is null, it cannot be rendered until it is set.
    
    Parameters:
    
    name - The name of this geometry
    
    mesh - The mesh data for this geometry
- Method Detail
  - checkCulling
```
public boolean checkCulling(Camera cam)
```
    Description copied from class: Spatial
    
    checkCulling checks the spatial with the camera to see if it should be culled.
    This method is called by the renderer. Usually it should not be called directly.
    
    Overrides:
    
    checkCulling in class Spatial
    
    Parameters:
    
    cam - The camera to check against.
    
    Returns:
    
    true if inside or intersecting camera frustum (should be rendered), false if outside.
  - isIgnoreTransform
```
public boolean isIgnoreTransform()
```
    Returns:
    
    If ignoreTransform mode is set.
    
    See Also:
    
    setIgnoreTransform(boolean)
  - setIgnoreTransform
```
public void setIgnoreTransform(boolean ignoreTransform)
```
    Parameters:
    
    ignoreTransform - If true, the geometry's transform will not be applied.
  - setLodLevel
```
public void setLodLevel(int lod)
```
    Sets the LOD level to use when rendering the mesh of this geometry. Level 0 indicates that the default index buffer should be used, levels [1, LodLevels + 1] represent the levels set on the mesh with Mesh.setLodLevels(com.jme3.scene.VertexBuffer[]).
    
    Overrides:
    
    setLodLevel in class Spatial
    
    Parameters:
    
    lod - The lod level to set
  - getLodLevel
```
public int getLodLevel()
```
    Returns the LOD level set with setLodLevel(int).
    
    Returns:
    
    the LOD level set
  - getVertexCount
```
public int getVertexCount()
```
    Returns this geometry's mesh vertex count.
    
    Specified by:
    
    getVertexCount in class Spatial
    
    Returns:
    
    this geometry's mesh vertex count.
    
    See Also:
    
    Mesh.getVertexCount()
  - getTriangleCount
```
public int getTriangleCount()
```
    Returns this geometry's mesh triangle count.
    
    Specified by:
    
    getTriangleCount in class Spatial
    
    Returns:
    
    this geometry's mesh triangle count.
    
    See Also:
    
    Mesh.getTriangleCount()
  - setMesh
```
public void setMesh(Mesh mesh)
```
    Sets the mesh to use for this geometry when rendering.
    
    Parameters:
    
    mesh - the mesh to use for this geometry
    
    Throws:
    
    java.lang.IllegalArgumentException - If mesh is null
  - getMesh
```
public Mesh getMesh()
```
    Returns the mesh to use for this geometry
    
    Returns:
    
    the mesh to use for this geometry
    
    See Also:
    
    setMesh(com.jme3.scene.Mesh)
  - setMaterial
```
public void setMaterial(Material material)
```
    Sets the material to use for this geometry.
    
    Overrides:
    
    setMaterial in class Spatial
    
    Parameters:
    
    material - the material to use for this geometry
  - getMaterial
```
public Material getMaterial()
```
    Returns the material that is used for this geometry.
    
    Returns:
    
    the material that is used for this geometry
    
    See Also:
    
    setMaterial(com.jme3.material.Material)
  - getModelBound
```
public BoundingVolume getModelBound()
```
    Returns:
    
    The bounding volume of the mesh, in model space.
  - updateModelBound
```
public void updateModelBound()
```
    Updates the bounding volume of the mesh. Should be called when the mesh has been modified.
    
    Specified by:
    
    updateModelBound in class Spatial
  - updateWorldBound
```
protected void updateWorldBound()
```
    updateWorldBound updates the bounding volume that contains this geometry. The location of the geometry is based on the location of all this node's parents.
    
    Overrides:
    
    updateWorldBound in class Spatial
    
    See Also:
    
    Spatial.updateWorldBound()
  - updateWorldTransforms
```
protected void updateWorldTransforms()
```
    Description copied from class: Spatial
    
    Should only be called from updateGeometricState(). In most cases should not be subclassed.
    
    Overrides:
    
    updateWorldTransforms in class Spatial
  - updateWorldLightList
```
protected void updateWorldLightList()
```
    Overrides:
    
    updateWorldLightList in class Spatial
  - associateWithGroupNode
```
public void associateWithGroupNode(GeometryGroupNode node,
                                   int startIndex)
```
    Associate this Geometry with a GeometryGroupNode. Should only be called by the parent GeometryGroupNode.
    
    Parameters:
    
    node - Which GeometryGroupNode to associate with.
    
    startIndex - The starting index of this geometry in the group.
  - unassociateFromGroupNode
```
public void unassociateFromGroupNode()
```
    Removes the GeometryGroupNode association from this Geometry. Should only be called by the parent GeometryGroupNode.
  - removeFromParent
```
public boolean removeFromParent()
```
    Description copied from class: Spatial
    
    removeFromParent removes this Spatial from its parent.
    
    Overrides:
    
    removeFromParent in class Spatial
    
    Returns:
    
    true if it has a parent and performed the remove.
  - setParent
```
protected void setParent(Node parent)
```
    Description copied from class: Spatial
    
    Called by Node.attachChild(Spatial) and Node.detachChild(Spatial) - don't call directly. setParent sets the parent of this node.
    
    Overrides:
    
    setParent in class Spatial
    
    Parameters:
    
    parent - the parent of this node.
  - computeWorldMatrix
```
public void computeWorldMatrix()
```
    Recomputes the matrix returned by getWorldMatrix(). This will require a localized transform update for this geometry.
  - getWorldMatrix
```
public Matrix4f getWorldMatrix()
```
    A matrix that transforms the mesh from model space to world space. This matrix is computed based on the world transform of this geometry. In order to receive updated values, you must call computeWorldMatrix() before using this method.
    
    Returns:
    
    Matrix to transform from local space to world space
  - setModelBound
```
public void setModelBound(BoundingVolume modelBound)
```
    Sets the model bound to use for this geometry. This alters the bound used on the mesh as well via Mesh.setBound(com.jme3.bounding.BoundingVolume) and forces the world bounding volume to be recomputed.
    
    Specified by:
    
    setModelBound in class Spatial
    
    Parameters:
    
    modelBound - The model bound to set
  - collideWith
```
public int collideWith(Collidable other,
                       CollisionResults results)
```
    Description copied from interface: Collidable
    
    Check collision with another Collidable.
    
    Parameters:
    
    other - The object to check collision against
    
    results - Will contain the list of CollisionResults.
    
    Returns:
    
    how many collisions were found between this and other
  - depthFirstTraversal
```
public void depthFirstTraversal(SceneGraphVisitor visitor,
                                Spatial.DFSMode mode)
```
    Description copied from class: Spatial
    
    Visit each scene graph element ordered by DFS. There are two modes: pre order and post order.
    
    Specified by:
    
    depthFirstTraversal in class Spatial
    
    Parameters:
    
    visitor - the action to take for each visited Spatial
    
    mode - the traversal mode: pre order or post order
  - breadthFirstTraversal
```
protected void breadthFirstTraversal(SceneGraphVisitor visitor,
                                     java.util.Queue<Spatial> queue)
```
    Specified by:
    
    breadthFirstTraversal in class Spatial
  - isGrouped
```
public boolean isGrouped()
```
    Determine whether this Geometry is managed by a GeometryGroupNode or not.
    
    Returns:
    
    True if managed by a GeometryGroupNode.
  - isBatched
```
@Deprecated
public boolean isBatched()
```
    Deprecated. Use isGrouped() instead.
    
    Returns:
    
    true if managed by a GeometryGroupNode
  - clone
```
public Geometry clone(boolean cloneMaterial)
```
    This version of clone is a shallow clone, in other words, the same mesh is referenced as the original geometry. Exception: if the mesh is marked as being a software animated mesh, (bind pose is set) then the positions and normals are deep copied.
    
    Overrides:
    
    clone in class Spatial
    
    Parameters:
    
    cloneMaterial - true to clone materials, false to share them
    
    Returns:
    
    A clone of this Spatial, the scene graph in its entirety is cloned and can be altered independently of the original scene graph. Note that meshes of geometries are not cloned explicitly, they are shared if static, or specially cloned if animated.
    
    See Also:
    
    Mesh.cloneForAnim()
  - clone
```
public Geometry clone()
```
    This version of clone is a shallow clone, in other words, the same mesh is referenced as the original geometry. Exception: if the mesh is marked as being a software animated mesh, (bind pose is set) then the positions and normals are deep copied.
    
    Specified by:
    
    clone in interface CloneableSmartAsset
    
    Overrides:
    
    clone in class Spatial
    
    Returns:
    
    A clone of this Spatial, the scene graph in its entirety is cloned and can be altered independently of the original scene graph. Note that meshes of geometries are not cloned explicitly, they are shared if static, or specially cloned if animated.
    
    See Also:
    
    Mesh.cloneForAnim()
  - deepClone
```
public Spatial deepClone()
```
    Create a deep clone of the geometry. This creates an identical copy of the mesh with the vertex buffer data duplicated.
    
    Overrides:
    
    deepClone in class Spatial
    
    Returns:
    
    Similar to Spatial.clone() except will create a deep clone of all geometries' meshes. Normally this method shouldn't be used. Instead, use Spatial.clone()
    
    See Also:
    
    Spatial.clone()
  - oldDeepClone
```
public Spatial oldDeepClone()
```
  - cloneFields
```
public void cloneFields(Cloner cloner,
                        java.lang.Object original)
```
    Called internally by com.jme3.util.clone.Cloner. Do not call directly.
    
    Specified by:
    
    cloneFields in interface JmeCloneable
    
    Overrides:
    
    cloneFields in class Spatial
    
    Parameters:
    
    cloner - The cloner that is performing the cloning operation. The cloneFields method can call back into the cloner to make clones of its subordinate fields.
    
    original - The original object from which this object was cloned. This is provided for the very rare case that this object needs to refer to its original for some reason. In general, all of the relevant values should have been transferred during the shallow clone, and this object need only clone what it wants.
  - setMorphState
```
public void setMorphState(float[] state)
```
  - setMorphState
```
public void setMorphState(java.lang.String morphTarget,
                          float state)
```
    Set the state of the morph with the given name. If the name of the morph is not found, no state will be set.
    
    Parameters:
    
    morphTarget - The name of the morph to set the state of
    
    state - The state to set the morph to
  - isDirtyMorph
```
public boolean isDirtyMorph()
```
    returns true if the morph state has changed on the last frame.
    
    Returns:
    
    true if changed, otherwise false
  - setDirtyMorph
```
public void setDirtyMorph(boolean dirtyMorph)
```
    Setting this to true will stop this geometry morph buffer to be updated, unless the morph state changes
    
    Parameters:
    
    dirtyMorph - true→prevent updating, false→allow updating
  - getMorphState
```
public float[] getMorphState()
```
    returns the morph state of this Geometry. Used internally by the MorphControl.
    
    Returns:
    
    an array
  - getMorphState
```
public float getMorphState(java.lang.String morphTarget)
```
    Get the state of a morph
    
    Parameters:
    
    morphTarget - the name of the morph to get the state of
    
    Returns:
    
    the state of the morph, or -1 if the morph is not found
  - getNbSimultaneousGPUMorph
```
public int getNbSimultaneousGPUMorph()
```
    Return the number of morph targets that can be handled on the GPU simultaneously for this geometry. Note that it depends on the material set on this geometry. This number is computed and set by the MorphControl, so it might be available only after the first frame. Else it's set to -1.
    
    Returns:
    
    the number of simultaneous morph targets handled on the GPU
  - setNbSimultaneousGPUMorph
```
public void setNbSimultaneousGPUMorph(int nbSimultaneousGPUMorph)
```
    Sets the number of morph targets that can be handled on the GPU simultaneously for this geometry. Note that it depends on the material set on this geometry. This number is computed and set by the MorphControl, so it might be available only after the first frame. Else it's set to -1. WARNING: setting this manually might crash the shader compilation if set too high. Do it at your own risk.
    
    Parameters:
    
    nbSimultaneousGPUMorph - the number of simultaneous morph targets to be handled on the GPU.
  - getFallbackMorphTarget
```
public MorphTarget getFallbackMorphTarget()
```
  - setFallbackMorphTarget
```
public void setFallbackMorphTarget(MorphTarget fallbackMorphTarget)
```
  - write
```
public void write(JmeExporter ex)
           throws java.io.IOException
```
    Specified by:
    
    write in interface Savable
    
    Overrides:
    
    write in class Spatial
    
    Throws:
    
    java.io.IOException
  - read
```
public void read(JmeImporter im)
          throws java.io.IOException
```
    Specified by:
    
    read in interface Savable
    
    Overrides:
    
    read in class Spatial
    
    Throws:
    
    java.io.IOException

Class Geometry

Nested Class Summary

Nested classes/interfaces inherited from class com.jme3.scene.Spatial

Field Summary

Fields inherited from class com.jme3.scene.Spatial

Constructor Summary

Method Summary

Methods inherited from class com.jme3.scene.Spatial

Methods inherited from class java.lang.Object

Field Detail

SAVABLE_VERSION

mesh

lodLevel

material

ignoreTransform

cachedWorldMat

groupNode

startIndex

Constructor Detail

Geometry

Geometry

Geometry

Method Detail

checkCulling

isIgnoreTransform

setIgnoreTransform

setLodLevel

getLodLevel

getVertexCount

getTriangleCount

setMesh

getMesh

setMaterial

getMaterial

getModelBound

updateModelBound

updateWorldBound

updateWorldTransforms

updateWorldLightList

associateWithGroupNode

unassociateFromGroupNode

removeFromParent

setParent

computeWorldMatrix

getWorldMatrix

setModelBound

collideWith

depthFirstTraversal

breadthFirstTraversal

isGrouped

isBatched

clone

clone

deepClone

oldDeepClone

cloneFields

setMorphState

setMorphState

isDirtyMorph

setDirtyMorph

getMorphState

getMorphState

getNbSimultaneousGPUMorph

setNbSimultaneousGPUMorph

getFallbackMorphTarget

setFallbackMorphTarget

write

read