com.jme3.bullet.objects

Class PhysicsGhostObject

java.lang.Object

com.jme3.bullet.collision.PhysicsCollisionObject

com.jme3.bullet.objects.PhysicsGhostObject

All Implemented Interfaces:

com.jme3.export.Savable

Direct Known Subclasses:

GhostControl

public class PhysicsGhostObject
extends PhysicsCollisionObject

A collision object for intangibles, based on Bullet's btPairCachingGhostObject. This is useful for creating a character controller, collision sensors/triggers, explosions etc.

From Bullet manual:
btGhostObject is a special btCollisionObject, useful for fast localized collision queries.

Author:

normenhansen

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	locationDirty
protected com.jme3.math.Quaternion	tmp_inverseWorldRotation

Fields inherited from class com.jme3.bullet.collision.PhysicsCollisionObject

COLLISION_GROUP_01, COLLISION_GROUP_02, COLLISION_GROUP_03, COLLISION_GROUP_04, COLLISION_GROUP_05, COLLISION_GROUP_06, COLLISION_GROUP_07, COLLISION_GROUP_08, COLLISION_GROUP_09, COLLISION_GROUP_10, COLLISION_GROUP_11, COLLISION_GROUP_12, COLLISION_GROUP_13, COLLISION_GROUP_14, COLLISION_GROUP_15, COLLISION_GROUP_16, COLLISION_GROUP_NONE, collisionGroup, collisionGroupsMask, collisionShape, objectId

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	PhysicsGhostObject() No-argument constructor needed by SavableClassUtil.
	PhysicsGhostObject(CollisionShape shape) Instantiate an object with the specified collision shape.
	PhysicsGhostObject(com.jme3.scene.Spatial child, CollisionShape shape)

Method Summary

Modifier and Type	Method and Description
protected void	buildObject() Create the configured object in Bullet.
void	destroy() Has no effect.
float	getCcdMotionThreshold() Read the continuous collision detection (CCD) motion threshold for this object.
float	getCcdSquareMotionThreshold() Read the CCD square motion threshold for this object.
float	getCcdSweptSphereRadius() Read the radius of the sphere used for continuous collision detection (CCD).
PhysicsCollisionObject	getOverlapping(int index) Access an overlapping collision object by its position in the list.
int	getOverlappingCount() Count how many collision objects this object overlaps.
java.util.List<PhysicsCollisionObject>	getOverlappingObjects() Access a list of overlapping objects.
protected void	getOverlappingObjects(long objectId)
com.jme3.math.Vector3f	getPhysicsLocation() Copy the location of this object's center.
com.jme3.math.Vector3f	getPhysicsLocation(com.jme3.math.Vector3f trans) Copy the location of this object's center.
com.jme3.math.Quaternion	getPhysicsRotation() Copy this object's orientation to a quaternion.
com.jme3.math.Quaternion	getPhysicsRotation(com.jme3.math.Quaternion rot) Copy this object's orientation to a quaternion.
com.jme3.math.Matrix3f	getPhysicsRotationMatrix() Copy this object's orientation to a matrix.
com.jme3.math.Matrix3f	getPhysicsRotationMatrix(com.jme3.math.Matrix3f rot) Copy this object's orientation to a matrix.
void	read(com.jme3.export.JmeImporter e) De-serialize this object from the specified importer, for example when loading from a J3O file.
void	setCcdMotionThreshold(float threshold) Alter the amount of motion required to trigger continuous collision detection (CCD).
void	setCcdSweptSphereRadius(float radius) Alter the continuous collision detection (CCD) swept sphere radius for this object.
void	setCollisionShape(CollisionShape collisionShape) Apply the specified CollisionShape to this object.
void	setPhysicsLocation(com.jme3.math.Vector3f location) Directly alter the location of this object's center.
void	setPhysicsRotation(com.jme3.math.Matrix3f rotation) Directly alter this object's orientation.
void	setPhysicsRotation(com.jme3.math.Quaternion rotation) Directly alter this object's orientation.
void	write(com.jme3.export.JmeExporter e) Serialize this object, for example when saving to a J3O file.

Methods inherited from class com.jme3.bullet.collision.PhysicsCollisionObject

addCollideWithGroup, attachCollisionShape, finalize, finalizeNative, getCollideWithGroups, getCollisionFlags, getCollisionGroup, getCollisionShape, getDeactivationTime, getObjectId, getUserObject, initUserPointer, isContactResponse, removeCollideWithGroup, setCollideWithGroups, setCollisionFlags, setCollisionGroup, setUserObject

Methods inherited from class java.lang.Object

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

Field Detail

locationDirty

protected boolean locationDirty

tmp_inverseWorldRotation

protected final com.jme3.math.Quaternion tmp_inverseWorldRotation

Constructor Detail

PhysicsGhostObject

protected PhysicsGhostObject()

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

PhysicsGhostObject

public PhysicsGhostObject(CollisionShape shape)

Instantiate an object with the specified collision shape.

Parameters:

shape - the desired shape (not null, alias created)

PhysicsGhostObject

public PhysicsGhostObject(com.jme3.scene.Spatial child,
                          CollisionShape shape)

Method Detail

buildObject

protected void buildObject()

Create the configured object in Bullet.

setCollisionShape

public void setCollisionShape(CollisionShape collisionShape)

Apply the specified CollisionShape to this object. Note that the object should not be in any physics space while changing shape; the object gets rebuilt on the physics side.

Overrides:

setCollisionShape in class PhysicsCollisionObject

Parameters:

collisionShape - the shape to apply (not null, alias created)

setPhysicsLocation

public void setPhysicsLocation(com.jme3.math.Vector3f location)

Directly alter the location of this object's center.

Parameters:

location - the desired location (in physics-space coordinates, not null, unaffected)

setPhysicsRotation

public void setPhysicsRotation(com.jme3.math.Matrix3f rotation)

Directly alter this object's orientation.

Parameters:

rotation - the desired orientation (a rotation matrix in physics-space coordinates, not null, unaffected)

setPhysicsRotation

public void setPhysicsRotation(com.jme3.math.Quaternion rotation)

Directly alter this object's orientation.

Parameters:

rotation - the desired orientation (quaternion, not null, unaffected)

getPhysicsLocation

public com.jme3.math.Vector3f getPhysicsLocation(com.jme3.math.Vector3f trans)

Copy the location of this object's center.

Parameters:

trans - storage for the result (modified if not null)

Returns:

a location vector (in physics-space coordinates, either the provided storage or a new vector, not null)

getPhysicsRotation

public com.jme3.math.Quaternion getPhysicsRotation(com.jme3.math.Quaternion rot)

Copy this object's orientation to a quaternion.

Parameters:

rot - storage for the result (modified if not null)

Returns:

an orientation (in physics-space coordinates, either the provided storage or a new quaternion, not null)

getPhysicsRotationMatrix

public com.jme3.math.Matrix3f getPhysicsRotationMatrix(com.jme3.math.Matrix3f rot)

Copy this object's orientation to a matrix.

Parameters:

rot - storage for the result (modified if not null)

Returns:

an orientation (in physics-space coordinates, either the provided storage or a new matrix, not null)

getPhysicsLocation

public com.jme3.math.Vector3f getPhysicsLocation()

Copy the location of this object's center.

Returns:

a new location vector (not null)

getPhysicsRotation

public com.jme3.math.Quaternion getPhysicsRotation()

Copy this object's orientation to a quaternion.

Returns:

a new quaternion (not null)

getPhysicsRotationMatrix

public com.jme3.math.Matrix3f getPhysicsRotationMatrix()

Copy this object's orientation to a matrix.

Returns:

a new matrix (not null)

destroy

public void destroy()

Has no effect.

getOverlappingObjects

public java.util.List<PhysicsCollisionObject> getOverlappingObjects()

Access a list of overlapping objects.

Returns:

an internal list which may get reused (not null)

getOverlappingObjects

protected void getOverlappingObjects(long objectId)

getOverlappingCount

public int getOverlappingCount()

Count how many collision objects this object overlaps.

Returns:

count (≥0)

getOverlapping

public PhysicsCollisionObject getOverlapping(int index)

Access an overlapping collision object by its position in the list.

Parameters:

index - which list position (≥0, <count)

Returns:

the pre-existing object

setCcdSweptSphereRadius

public void setCcdSweptSphereRadius(float radius)

Alter the continuous collision detection (CCD) swept sphere radius for this object.

Parameters:

radius - (≥0)

setCcdMotionThreshold

public void setCcdMotionThreshold(float threshold)

Alter the amount of motion required to trigger continuous collision detection (CCD).

This addresses the issue of fast objects passing through other objects with no collision detected.

Parameters:

threshold - the desired threshold value (squared velocity, >0) or zero to disable CCD (default=0)

getCcdSweptSphereRadius

public float getCcdSweptSphereRadius()

Read the radius of the sphere used for continuous collision detection (CCD).

Returns:

radius (≥0)

getCcdMotionThreshold

public float getCcdMotionThreshold()

Read the continuous collision detection (CCD) motion threshold for this object.

Returns:

threshold value (squared velocity, ≥0)

getCcdSquareMotionThreshold

public float getCcdSquareMotionThreshold()

Read the CCD square motion threshold for this object.

Returns:

threshold value (≥0)

write

public void write(com.jme3.export.JmeExporter e)
           throws java.io.IOException

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

Specified by:

write in interface com.jme3.export.Savable

Overrides:

write in class PhysicsCollisionObject

Parameters:

e - exporter (not null)

Throws:

java.io.IOException - from exporter

read

public void read(com.jme3.export.JmeImporter e)
          throws java.io.IOException

De-serialize this object from the specified importer, for example when loading from a J3O file.

Specified by:

read in interface com.jme3.export.Savable

Overrides:

read in class PhysicsCollisionObject

Parameters:

e - importer (not null)

Throws:

java.io.IOException - from importer