com.jme3.bullet.collision.shapes

Class CapsuleCollisionShape

java.lang.Object

com.jme3.bullet.collision.shapes.CollisionShape

com.jme3.bullet.collision.shapes.CapsuleCollisionShape

All Implemented Interfaces:

Savable

public class CapsuleCollisionShape
extends CollisionShape

A capsule collision shape based on Bullet's btCapsuleShapeX, btCapsuleShape, or btCapsuleShapeZ. These shapes have no margin and cannot be scaled.

Field Summary

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

margin, objectId, scale

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CapsuleCollisionShape() No-argument constructor needed by SavableClassUtil.
	CapsuleCollisionShape(float radius, float height) Instantiate a Y-axis capsule shape with the specified radius and height.
	CapsuleCollisionShape(float radius, float height, int axis) Instantiate a capsule shape around the specified main (height) axis.

Method Summary

Modifier and Type	Method and Description
protected void	createShape() Instantiate the configured shape in Bullet.
int	getAxis() Determine the main (height) axis of the capsule.
float	getHeight() Read the height (of the cylindrical portion) of the capsule.
float	getRadius() Read the radius of the capsule.
void	read(JmeImporter im) De-serialize this shape, for example when loading from a J3O file.
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 com.jme3.bullet.collision.shapes.CollisionShape

finalize, getDefaultMargin, getMargin, getObjectId, getScale, isNonMoving, setDefaultMargin, setMargin, setObjectId

Methods inherited from class java.lang.Object

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

Constructor Detail

CapsuleCollisionShape

protected CapsuleCollisionShape()

No-argument constructor needed by SavableClassUtil. Do not invoke directly!

CapsuleCollisionShape

public CapsuleCollisionShape(float radius,
                             float height)

Instantiate a Y-axis capsule shape with the specified radius and height.

Parameters:

radius - the desired radius (≥0)

height - the desired height (of the cylindrical portion) (≥0)

CapsuleCollisionShape

public CapsuleCollisionShape(float radius,
                             float height,
                             int axis)

Instantiate a capsule shape around the specified main (height) axis.

Parameters:

radius - the desired radius (≥0)

height - the desired height (of the cylindrical portion) (≥0)

axis - which local axis: 0→X, 1→Y, 2→Z

Method Detail

getRadius

public float getRadius()

Read the radius of the capsule.

Returns:

the radius (≥0)

getHeight

public float getHeight()

Read the height (of the cylindrical portion) of the capsule.

Returns:

height (≥0)

getAxis

public int getAxis()

Determine the main (height) axis of the capsule.

Returns:

0 for local X, 1 for local Y, or 2 for local Z

setScale

public void setScale(Vector3f scale)

Alter the scaling factors of this shape. Scaling is disabled for capsule shapes.

Overrides:

setScale in class CollisionShape

Parameters:

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

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

Overrides:

write in class CollisionShape

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

Overrides:

read in class CollisionShape

Parameters:

im - importer (not null)

Throws:

java.io.IOException - from importer

createShape

protected void createShape()

Instantiate the configured shape in Bullet.