com.jme3.bullet.control

Class GhostControl

java.lang.Object

com.jme3.bullet.collision.PhysicsCollisionObject

com.jme3.bullet.objects.PhysicsGhostObject

com.jme3.bullet.control.GhostControl

All Implemented Interfaces:

PhysicsControl, com.jme3.export.Savable, com.jme3.scene.control.Control, com.jme3.util.clone.JmeCloneable, java.lang.Cloneable

public class GhostControl
extends PhysicsGhostObject
implements PhysicsControl, com.jme3.util.clone.JmeCloneable

A physics control to link a PhysicsGhostObject to a spatial.

The ghost object moves with the spatial it is attached to and can be used to detect overlaps with other physics objects (e.g. aggro radius).

This class is shared between JBullet and Native Bullet.

Author:

normenhansen

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	added true→body is added to the physics space, false→not added
protected boolean	applyLocal true → physics coordinates match local transform, false → physics coordinates match world transform
protected boolean	enabled true→control is enabled, false→control is disabled
protected PhysicsSpace	space space to which the ghost object is (or would be) added
protected com.jme3.scene.Spatial	spatial spatial to which this control is added, or null if none

Fields inherited from class com.jme3.bullet.objects.PhysicsGhostObject

locationDirty, 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	GhostControl() No-argument constructor needed by SavableClassUtil.
	GhostControl(CollisionShape shape) Instantiate an enabled control with the specified shape.

Method Summary

Modifier and Type	Method and Description
void	cloneFields(com.jme3.util.clone.Cloner cloner, java.lang.Object original) Callback from Cloner to convert this shallow-cloned control into a deep-cloned one, using the specified cloner and original to resolve copied fields.
com.jme3.scene.control.Control	cloneForSpatial(com.jme3.scene.Spatial spatial) Deprecated.
PhysicsSpace	getPhysicsSpace() Access the physics space to which the ghost object is (or would be) added.
com.jme3.scene.Spatial	getSpatial()
boolean	isApplyPhysicsLocal() Test whether physics-space coordinates should match the spatial's local coordinates.
boolean	isEnabled() Test whether this control is enabled.
java.lang.Object	jmeClone() Create a shallow clone for the JME cloner.
void	read(com.jme3.export.JmeImporter im) De-serialize this control, for example when loading from a J3O file.
void	render(com.jme3.renderer.RenderManager rm, com.jme3.renderer.ViewPort vp) Render this control.
void	setApplyPhysicsLocal(boolean applyPhysicsLocal) Alter whether physics-space coordinates should match the spatial's local coordinates.
void	setEnabled(boolean enabled) Enable or disable this control.
void	setPhysicsSpace(PhysicsSpace newSpace) If enabled, add this control's physics object to the specified physics space.
void	setSpatial(com.jme3.scene.Spatial spatial) Alter which spatial is controlled.
void	update(float tpf) Update this control.
void	write(com.jme3.export.JmeExporter ex) Serialize this control, for example when saving to a J3O file.

Methods inherited from class com.jme3.bullet.objects.PhysicsGhostObject

buildObject, destroy, getCcdMotionThreshold, getCcdSquareMotionThreshold, getCcdSweptSphereRadius, getOverlapping, getOverlappingCount, getOverlappingObjects, getOverlappingObjects, getPhysicsLocation, getPhysicsLocation, getPhysicsRotation, getPhysicsRotation, getPhysicsRotationMatrix, getPhysicsRotationMatrix, setCcdMotionThreshold, setCcdSweptSphereRadius, setCollisionShape, setPhysicsLocation, setPhysicsRotation, setPhysicsRotation

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

spatial

protected com.jme3.scene.Spatial spatial

spatial to which this control is added, or null if none

enabled

protected boolean enabled

true→control is enabled, false→control is disabled

added

protected boolean added

true→body is added to the physics space, false→not added

space

protected PhysicsSpace space

space to which the ghost object is (or would be) added

applyLocal

protected boolean applyLocal

true → physics coordinates match local transform, false → physics coordinates match world transform

Constructor Detail

GhostControl

protected GhostControl()

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

GhostControl

public GhostControl(CollisionShape shape)

Instantiate an enabled control with the specified shape.

Parameters:

shape - (not null)

Method Detail

isApplyPhysicsLocal

public boolean isApplyPhysicsLocal()

Test whether physics-space coordinates should match the spatial's local coordinates.

Returns:

true if matching local coordinates, false if matching world coordinates

setApplyPhysicsLocal

public void setApplyPhysicsLocal(boolean applyPhysicsLocal)

Alter whether physics-space coordinates should match the spatial's local coordinates.

Parameters:

applyPhysicsLocal - true→match local coordinates, false→match world coordinates (default=false)

cloneForSpatial

@Deprecated
public com.jme3.scene.control.Control cloneForSpatial(com.jme3.scene.Spatial spatial)

Deprecated.

Clone this control for a different spatial. No longer used as of JME 3.1.

Specified by:

cloneForSpatial in interface com.jme3.scene.control.Control

Parameters:

spatial - the spatial for the clone to control (or null)

Returns:

a new control (not null)

jmeClone

public java.lang.Object jmeClone()

Create a shallow clone for the JME cloner.

Specified by:

jmeClone in interface com.jme3.util.clone.JmeCloneable

Returns:

a new control (not null)

cloneFields

public void cloneFields(com.jme3.util.clone.Cloner cloner,
                        java.lang.Object original)

Callback from Cloner to convert this shallow-cloned control into a deep-cloned one, using the specified cloner and original to resolve copied fields.

Specified by:

cloneFields in interface com.jme3.util.clone.JmeCloneable

Parameters:

cloner - the cloner that's cloning this control (not null)

original - the control from which this control was shallow-cloned (unused)

setSpatial

public void setSpatial(com.jme3.scene.Spatial spatial)

Alter which spatial is controlled. Invoked when the control is added to or removed from a spatial. Should be invoked only by a subclass or from Spatial. Do not invoke directly from user code.

Specified by:

setSpatial in interface com.jme3.scene.control.Control

Parameters:

spatial - the spatial to control (or null)

getSpatial

public com.jme3.scene.Spatial getSpatial()

Returns:

returns the spatial the control is added to, or null if the control is not attached to a spatial yet.

setEnabled

public void setEnabled(boolean enabled)

Enable or disable this control.

When the control is disabled, the ghost object is removed from physics space. When the control is enabled again, the object is moved to the current location of the spatial and then added to the physics space.

Specified by:

setEnabled in interface PhysicsControl

Parameters:

enabled - true→enable the control, false→disable it

isEnabled

public boolean isEnabled()

Test whether this control is enabled.

Specified by:

isEnabled in interface PhysicsControl

Returns:

true if enabled, otherwise false

update

public void update(float tpf)

Update this control. Invoked once per frame during the logical-state update, provided the control is added to a scene. Do not invoke directly from user code.

Specified by:

update in interface com.jme3.scene.control.Control

Parameters:

tpf - the time interval between frames (in seconds, ≥0)

render

public void render(com.jme3.renderer.RenderManager rm,
                   com.jme3.renderer.ViewPort vp)

Render this control. Invoked once per view port per frame, provided the control is added to a scene. Should be invoked only by a subclass or by the RenderManager.

Specified by:

render in interface com.jme3.scene.control.Control

Parameters:

rm - the render manager (not null)

vp - the view port to render (not null)

setPhysicsSpace

public void setPhysicsSpace(PhysicsSpace newSpace)

If enabled, add this control's physics object to the specified physics space. If not enabled, alter where the object would be added. The object is removed from any other space it's currently in.

Specified by:

setPhysicsSpace in interface PhysicsControl

Parameters:

newSpace - where to add, or null to simply remove

getPhysicsSpace

public PhysicsSpace getPhysicsSpace()

Access the physics space to which the ghost object is (or would be) added.

Specified by:

getPhysicsSpace in interface PhysicsControl

Returns:

the pre-existing space, or null for none

write

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

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

Specified by:

write in interface com.jme3.export.Savable

Overrides:

write in class PhysicsGhostObject

Parameters:

ex - exporter (not null)

Throws:

java.io.IOException - from exporter

read

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

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

Specified by:

read in interface com.jme3.export.Savable

Overrides:

read in class PhysicsGhostObject

Parameters:

im - importer (not null)

Throws:

java.io.IOException - from importer