com.jme3.bullet.collision.shapes

Class MeshCollisionShape

java.lang.Object

com.jme3.bullet.NativePhysicsObject

com.jme3.bullet.collision.shapes.CollisionShape

com.jme3.bullet.collision.shapes.MeshCollisionShape

All Implemented Interfaces:

java.lang.Comparable<NativePhysicsObject>

public class MeshCollisionShape
extends CollisionShape

A mesh collision shape that uses a Bounding Value Hierarchy (BVH), based on Bullet's btBvhTriangleMeshShape. Not for use in dynamic bodies. Collisions between HeightfieldCollisionShape, MeshCollisionShape, and PlaneCollisionShape objects are never detected.

TODO add a shape based on btScaledBvhTriangleMeshShape

Field Summary

Fields

Modifier and Type	Field and Description
static java.util.logging.Logger	logger2 message logger for this class
static int	maxSubmeshes maximum number of submeshes when compression is used
static int	maxTrianglesInAnySubmesh maximum number of triangles in any submesh when compression is used

Fields inherited from class com.jme3.bullet.collision.shapes.CollisionShape

enableContactFilter, logger, margin, scale

Fields inherited from class com.jme3.bullet.NativePhysicsObject

loggerN

Constructor Summary

Constructors

Constructor and Description
MeshCollisionShape(boolean useCompression, java.util.Collection<IndexedMesh> meshes) Instantiate a shape from the specified collection of native meshes.
MeshCollisionShape(boolean useCompression, CompoundMesh mesh) Instantiate a shape based on the specified CompoundMesh.
MeshCollisionShape(boolean useCompression, IndexedMesh... submeshes) Instantiate a shape from the specified native mesh(es).
MeshCollisionShape(byte[] bvhBytes, IndexedMesh... submeshes) Instantiate a shape from the specified native mesh(es) and serialized BVH.

Method Summary

Modifier and Type	Method and Description
boolean	canSplit() Test whether this shape can be split by an arbitrary plane.
int	countMeshTriangles() Count how many triangles are in the mesh.
int	countMeshVertices() Count how many vertices are in the mesh.
int	countSubmeshes() Count how many submeshes are in the mesh.
BoundingValueHierarchy	getBvh() Access the bounding-value hierarchy.
IndexedMesh	getSubmesh(int index) Access the specified submesh.
protected void	recalculateAabb() Recalculate this shape's bounding box if necessary.
byte[]	serializeBvh() Serialize the BVH to a byte array.
void	setScale(Vector3f scale) Alter the scale of this shape.
MeshCollisionShape[]	split(Triangle splittingTriangle) Attempt to divide this shape into 2 shapes.

Methods inherited from class com.jme3.bullet.collision.shapes.CollisionShape

aabbCenter, boundingBox, boundingBox, canScale, getDefaultMargin, getMargin, getScale, getScaleDp, getShapeType, getShapeType, isConcave, isContactFilterEnabled, isConvex, isInfinite, isNonMoving, isPolyhedral, maxRadius, nativeMargin, scaledVolume, setContactFilterEnabled, setDefaultMargin, setMargin, setNativeId, setScale, setUserIndex, setUserIndex2, toSplittableShape, toString, updateScale, userIndex, userIndex2

Methods inherited from class com.jme3.bullet.NativePhysicsObject

compareTo, countTrackers, dumpTrackers, equals, freeUnusedObjects, hasAssignedNativeObject, hashCode, nativeId, reassignNativeId, setNativeIdNotTracked, unassignNativeObject

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

maxSubmeshes

public static final int maxSubmeshes

maximum number of submeshes when compression is used

See Also:

Constant Field Values

maxTrianglesInAnySubmesh

public static final int maxTrianglesInAnySubmesh

maximum number of triangles in any submesh when compression is used

See Also:

Constant Field Values

logger2

public static final java.util.logging.Logger logger2

message logger for this class

Constructor Detail

MeshCollisionShape

public MeshCollisionShape(boolean useCompression,
                          java.util.Collection<IndexedMesh> meshes)

Instantiate a shape from the specified collection of native meshes.

Parameters:

useCompression - true to use quantized AABB compression

meshes - the collection on which to base the shape (must contain at least one triangle)

MeshCollisionShape

public MeshCollisionShape(boolean useCompression,
                          CompoundMesh mesh)

Instantiate a shape based on the specified CompoundMesh.

Parameters:

useCompression - true to use quantized AABB compression

mesh - the mesh on which to base the shape (not null, must contain at least one triangle, unaffected)

MeshCollisionShape

public MeshCollisionShape(boolean useCompression,
                          IndexedMesh... submeshes)

Instantiate a shape from the specified native mesh(es).

Parameters:

useCompression - true to use quantized AABB compression

submeshes - the mesh(es) on which to base the shape (must contain at least one triangle)

MeshCollisionShape

public MeshCollisionShape(byte[] bvhBytes,
                          IndexedMesh... submeshes)

Instantiate a shape from the specified native mesh(es) and serialized BVH. The submeshes must be equivalent to those used to generate the BVH.

Parameters:

bvhBytes - the serialized BVH (not null, unaffected)

submeshes - the mesh(es) on which to base the shape (must contain at least one triangle)

Method Detail

countMeshTriangles

public int countMeshTriangles()

Count how many triangles are in the mesh.

Returns:

the count (≥0)

countMeshVertices

public int countMeshVertices()

Count how many vertices are in the mesh.

Returns:

the count (≥0)

countSubmeshes

public int countSubmeshes()

Count how many submeshes are in the mesh.

Returns:

the count (≥0)

getBvh

public BoundingValueHierarchy getBvh()

Access the bounding-value hierarchy.

Returns:

the pre-existing instance (not null)

getSubmesh

public IndexedMesh getSubmesh(int index)

Access the specified submesh.

Parameters:

index - the index of the desired submesh (in the order the submeshes were added, ≥0)

Returns:

the pre-existing instance (not null)

serializeBvh

public byte[] serializeBvh()

Serialize the BVH to a byte array.

Returns:

a new array containing a serialized version of the BVH

split

public MeshCollisionShape[] split(Triangle splittingTriangle)

Attempt to divide this shape into 2 shapes.

Parameters:

splittingTriangle - to define the splitting plane (in shape coordinates, not null, unaffected)

Returns:

a pair of mesh shapes, the first shape generated by the plane's minus side and the 2nd shape generated by its plus side; either shape may be null, indicating an empty shape

canSplit

public boolean canSplit()

Test whether this shape can be split by an arbitrary plane.

Overrides:

canSplit in class CollisionShape

Returns:

true

recalculateAabb

protected void recalculateAabb()

Recalculate this shape's bounding box if necessary.

Overrides:

recalculateAabb in class CollisionShape

setScale

public void setScale(Vector3f scale)

Alter the scale of this shape.

Note that if shapes are shared (between collision objects and/or compound shapes) changes can have unintended consequences.

Overrides:

setScale in class CollisionShape

Parameters:

scale - the desired scale factor for each local axis (not null, no negative component, unaffected, default=(1,1,1))