com.jme3.bullet.collision.shapes

Class CylinderCollisionShape

java.lang.Object

com.jme3.bullet.collision.shapes.CollisionShape

com.jme3.bullet.collision.shapes.CylinderCollisionShape

All Implemented Interfaces:

Savable

public class CylinderCollisionShape
extends CollisionShape

A cylindrical collision shape based on Bullet's btCylinderShapeX, new btCylinderShape, or btCylinderShapeZ.

Field Summary

Fields

Modifier and Type	Field and Description
protected int	axis copy of main (height) axis (0→X, 1→Y, 2→Z)
protected Vector3f	halfExtents copy of half-extents of the cylinder on each local axis (not null, no negative component)

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

margin, objectId, scale

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CylinderCollisionShape() No-argument constructor needed by SavableClassUtil.
	CylinderCollisionShape(Vector3f halfExtents) Instantiate a Z-axis cylinder shape with the specified half extents.
	CylinderCollisionShape(Vector3f halfExtents, int axis) Instantiate a cylinder shape around the specified axis.

Method Summary

Modifier and Type	Method and Description
protected void	createShape() Instantiate the configured shape in Bullet.
int	getAxis() Determine the main axis of the cylinder.
Vector3f	getHalfExtents() Access the half extents of the cylinder.
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

Field Detail

halfExtents

protected Vector3f halfExtents

copy of half-extents of the cylinder on each local axis (not null, no negative component)

axis

protected int axis

copy of main (height) axis (0→X, 1→Y, 2→Z)

Constructor Detail

CylinderCollisionShape

protected CylinderCollisionShape()

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

CylinderCollisionShape

public CylinderCollisionShape(Vector3f halfExtents)

Instantiate a Z-axis cylinder shape with the specified half extents.

Parameters:

halfExtents - the desired unscaled half extents (not null, no negative component, alias created)

CylinderCollisionShape

public CylinderCollisionShape(Vector3f halfExtents,
                              int axis)

Instantiate a cylinder shape around the specified axis.

Parameters:

halfExtents - the desired unscaled half extents (not null, no negative component, alias created)

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

Method Detail

getHalfExtents

public final Vector3f getHalfExtents()

Access the half extents of the cylinder.

Returns:

the pre-existing vector (not null, no negative component)

getAxis

public int getAxis()

Determine the main axis of the cylinder.

Returns:

0→X, 1→Y, 2→Z

setScale

public void setScale(Vector3f scale)

Alter the scaling factors of this shape. Scaling is disabled for cylinder 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.