com.jme3.bullet.collision.shapes

Class CollisionShape

java.lang.Object

com.jme3.bullet.collision.shapes.CollisionShape

All Implemented Interfaces:

Savable

Direct Known Subclasses:

BoxCollisionShape, CapsuleCollisionShape, CompoundCollisionShape, ConeCollisionShape, CylinderCollisionShape, GImpactCollisionShape, HeightfieldCollisionShape, HullCollisionShape, MeshCollisionShape, PlaneCollisionShape, SimplexCollisionShape, SphereCollisionShape

public abstract class CollisionShape
extends java.lang.Object
implements Savable

The abstract base class for collision shapes based on Bullet's btCollisionShape.

Collision shapes include BoxCollisionShape and CapsuleCollisionShape. As suggested in the Bullet manual, a single collision shape can be shared among multiple collision objects.

Field Summary

Fields

Modifier and Type	Field and Description
protected float	margin copy of collision margin (in physics-space units, >0, default=0)
protected long	objectId unique identifier of the btCollisionShape
protected Vector3f	scale copy of scaling factors: one for each local axis (default=1,1,1)

Constructor Summary

Constructors

Constructor and Description
CollisionShape()

Method Summary

Modifier and Type	Method and Description
protected void	finalize() Finalize this shape just before it is destroyed.
static float	getDefaultMargin() Read the default margin for new shapes.
float	getMargin() Read the collision margin for this shape.
long	getObjectId() Read the id of the btCollisionShape.
Vector3f	getScale() Access the scaling factors.
boolean	isNonMoving() Test whether this shape can be applied to a dynamic rigid body.
void	read(JmeImporter im) De-serialize this shape, for example when loading from a J3O file.
static void	setDefaultMargin(float margin) Alter the default margin for new shapes that are neither capsules nor spheres.
void	setMargin(float margin) Alter the collision margin of this shape.
void	setObjectId(long id) used internally
void	setScale(Vector3f scale) Alter the scaling factors of this shape.
void	write(JmeExporter ex) Serialize this shape, for example when saving to a J3O file.

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

objectId

protected long objectId

unique identifier of the btCollisionShape

Constructors are responsible for setting this to a non-zero value. After that, the id never changes.

scale

protected Vector3f scale

copy of scaling factors: one for each local axis (default=1,1,1)

margin

protected float margin

copy of collision margin (in physics-space units, >0, default=0)

Constructor Detail

CollisionShape

public CollisionShape()

Method Detail

getObjectId

public long getObjectId()

Read the id of the btCollisionShape.

Returns:

the unique identifier (not zero)

setObjectId

public void setObjectId(long id)

used internally

setScale

public void setScale(Vector3f scale)

Alter the scaling factors of this shape. CAUTION: Not all shapes can be scaled.

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

Parameters:

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

getScale

public Vector3f getScale()

Access the scaling factors.

Returns:

the pre-existing vector (not null)

isNonMoving

public boolean isNonMoving()

Test whether this shape can be applied to a dynamic rigid body. The only non-moving shapes are the heightfield, mesh, and plane shapes.

Returns:

true if non-moving, false otherwise

getMargin

public float getMargin()

Read the collision margin for this shape.

Returns:

the margin distance (in physics-space units, ≥0)

setDefaultMargin

public static void setDefaultMargin(float margin)

Alter the default margin for new shapes that are neither capsules nor spheres.

Parameters:

margin - the desired margin distance (in physics-space units, >0, default=0.04)

getDefaultMargin

public static float getDefaultMargin()

Read the default margin for new shapes.

Returns:

margin the default margin distance (in physics-space units, >0)

setMargin

public void setMargin(float margin)

Alter the collision margin of this shape. CAUTION: Margin is applied differently, depending on the type of shape. Generally the collision margin expands the object, creating a gap. Don't set the collision margin to zero.

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

Parameters:

margin - the desired margin distance (in physics-space units, >0, default=0.04)

write

public void write(JmeExporter ex)
           throws java.io.IOException

Serialize this shape, for example when saving to a J3O file.

Specified by:

write in interface Savable

Parameters:

ex - exporter (not null)

Throws:

java.io.IOException - from exporter

read

public void read(JmeImporter im)
          throws java.io.IOException

De-serialize this shape, for example when loading from a J3O file.

Specified by:

read in interface Savable

Parameters:

im - importer (not null)

Throws:

java.io.IOException - from importer

finalize

protected void finalize()
                 throws java.lang.Throwable

Finalize this shape just before it is destroyed. Should be invoked only by a subclass or by the garbage collector.

Overrides:

finalize in class java.lang.Object

Throws:

java.lang.Throwable - ignored by the garbage collector