PhysicsHoverControl (jMonkeyEngine3)

java.lang.Object
- com.jme3.bullet.collision.PhysicsCollisionObject
- - com.jme3.bullet.objects.PhysicsRigidBody
  - - com.jme3.bullet.objects.PhysicsVehicle
    - - jme3test.bullet.PhysicsHoverControl

All Implemented Interfaces:

PhysicsControl, PhysicsTickListener, Savable, Control, JmeCloneable, java.lang.Cloneable
```
public class PhysicsHoverControl
extends PhysicsVehicle
implements PhysicsControl, PhysicsTickListener, JmeCloneable
```
PhysicsHoverControl uses a RayCast Vehicle with "slippery wheels" to simulate a hovering tank

Field Summary

Fields
Modifier and Type	Field and Description
`protected float`	`accelerationValue`
`protected boolean`	`enabled`
`protected Vector3f`	`HOVER_HEIGHT_LF`
`protected Vector3f`	`HOVER_HEIGHT_LF_START`
`protected Vector3f`	`HOVER_HEIGHT_LR`
`protected Vector3f`	`HOVER_HEIGHT_LR_START`
`protected Vector3f`	`HOVER_HEIGHT_RF`
`protected Vector3f`	`HOVER_HEIGHT_RF_START`
`protected Vector3f`	`HOVER_HEIGHT_RR`
`protected Vector3f`	`HOVER_HEIGHT_RR_START`
`protected PhysicsSpace`	`space`
`protected Spatial`	`spatial`
`protected float`	`steeringValue`
`protected Vector3f`	`tempVect1`
`protected Vector3f`	`tempVect2`
`protected Vector3f`	`tempVect3`
`protected int`	`xw`
`protected int`	`yw`
`protected int`	`zw`

Fields inherited from class com.jme3.bullet.objects.PhysicsVehicle
physicsSpace, rayCaster, tuning, vehicle, wheels

Fields inherited from class com.jme3.bullet.objects.PhysicsRigidBody
constructionInfo, joints, kinematic, localInertia, mass, motionState, rBody, tempMatrix, tempTrans, tempVec, tempVec2

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

Constructor Summary

Constructors
Constructor and Description
`PhysicsHoverControl()`
`PhysicsHoverControl(CollisionShape shape)` Creates a new PhysicsNode with the supplied collision shape
`PhysicsHoverControl(CollisionShape shape, float mass)`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`accelerate(float accelerationValue)` Apply the given engine force to all wheels, works continuously
`void`	`cloneFields(Cloner cloner, java.lang.Object original)` Implemented to perform deep cloning for this object, resolving local cloned references using the specified cloner.
`Control`	`cloneForSpatial(Spatial spatial)` Deprecated.
`PhysicsSpace`	`getPhysicsSpace()` Access the physics space to which the object is (or would be) added.
`boolean`	`isEnabled()` Test whether this control is enabled.
`java.lang.Object`	`jmeClone()` Performs a regular shallow clone of the object.
`void`	`physicsTick(PhysicsSpace space, float f)` Callback from Bullet, invoked just after the physics has been stepped.
`void`	`prePhysicsTick(PhysicsSpace space, float f)` Callback from Bullet, invoked just before the physics is stepped.
`void`	`read(JmeImporter im)` De-serialize this body, for example when loading from a J3O file.
`void`	`render(RenderManager rm, ViewPort vp)` Should be called prior to queuing the spatial by the RenderManager.
`void`	`setEnabled(boolean enabled)` Enable or disable this control.
`void`	`setPhysicsSpace(PhysicsSpace space)` If enabled, add this control's physics object to the specified physics space.
`void`	`setSpatial(Spatial spatial)`
`void`	`steer(float steeringValue)` Set the given steering value to all front wheels (0 = forward)
`void`	`update(float tpf)` Updates the control.
`void`	`write(JmeExporter ex)` Serialize this body, for example when saving to a J3O file.

Methods inherited from class com.jme3.bullet.objects.PhysicsRigidBody
activate, addJoint, applyCentralForce, applyForce, applyImpulse, applyTorque, applyTorqueImpulse, clearForces, getAngularDamping, getAngularFactor, getAngularSleepingThreshold, getAngularVelocity, getAngularVelocity, getCcdMotionThreshold, getCcdSquareMotionThreshold, getCcdSweptSphereRadius, getFriction, getGravity, getGravity, getInterpolatedPhysicsLocation, getInterpolatedPhysicsRotation, getJoints, getLinearDamping, getLinearSleepingThreshold, getLinearVelocity, getLinearVelocity, getMass, getMotionState, getObjectId, getPhysicsLocation, getPhysicsLocation, getPhysicsRotation, getPhysicsRotation, getPhysicsRotationMatrix, getPhysicsRotationMatrix, getRestitution, isActive, isContactResponse, isKinematic, preRebuild, rebuildRigidBody, removeJoint, setAngularDamping, setAngularFactor, setAngularSleepingThreshold, setAngularVelocity, setCcdMotionThreshold, setCcdSweptSphereRadius, setCollisionShape, setContactResponse, setDamping, setFriction, setGravity, setKinematic, setLinearDamping, setLinearSleepingThreshold, setLinearVelocity, setMass, setPhysicsLocation, setPhysicsRotation, setPhysicsRotation, setRestitution, setSleepingThresholds

Methods inherited from class com.jme3.bullet.collision.PhysicsCollisionObject
addCollideWithGroup, getCollideWithGroups, getCollisionGroup, getCollisionShape, getUserObject, removeCollideWithGroup, setCollideWithGroups, setCollisionGroup, setUserObject

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - spatial
```
protected Spatial spatial
```
  - enabled
```
protected boolean enabled
```
  - space
```
protected PhysicsSpace space
```
  - steeringValue
```
protected float steeringValue
```
  - accelerationValue
```
protected float accelerationValue
```
  - xw
```
protected int xw
```
  - zw
```
protected int zw
```
  - yw
```
protected int yw
```
  - HOVER_HEIGHT_LF_START
```
protected Vector3f HOVER_HEIGHT_LF_START
```
  - HOVER_HEIGHT_RF_START
```
protected Vector3f HOVER_HEIGHT_RF_START
```
  - HOVER_HEIGHT_LR_START
```
protected Vector3f HOVER_HEIGHT_LR_START
```
  - HOVER_HEIGHT_RR_START
```
protected Vector3f HOVER_HEIGHT_RR_START
```
  - HOVER_HEIGHT_LF
```
protected Vector3f HOVER_HEIGHT_LF
```
  - HOVER_HEIGHT_RF
```
protected Vector3f HOVER_HEIGHT_RF
```
  - HOVER_HEIGHT_LR
```
protected Vector3f HOVER_HEIGHT_LR
```
  - HOVER_HEIGHT_RR
```
protected Vector3f HOVER_HEIGHT_RR
```
  - tempVect1
```
protected Vector3f tempVect1
```
  - tempVect2
```
protected Vector3f tempVect2
```
  - tempVect3
```
protected Vector3f tempVect3
```
- Constructor Detail
  - PhysicsHoverControl
```
public PhysicsHoverControl()
```
  - PhysicsHoverControl
```
public PhysicsHoverControl(CollisionShape shape)
```
    Creates a new PhysicsNode with the supplied collision shape
    
    Parameters:
    
    shape - the desired collision shape
  - PhysicsHoverControl
```
public PhysicsHoverControl(CollisionShape shape,
                           float mass)
```
- Method Detail
  - cloneForSpatial
```
@Deprecated
public Control cloneForSpatial(Spatial spatial)
```
    Deprecated.
    
    Description copied from interface: Control
    
    Creates a clone of the Control, the given Spatial is the cloned version of the spatial to which this control is attached to.
    
    Specified by:
    
    cloneForSpatial in interface Control
    
    Parameters:
    
    spatial - the Spatial to be controlled by the clone
    
    Returns:
    
    A clone of this control for the spatial
  - jmeClone
```
public java.lang.Object jmeClone()
```
    Description copied from interface: JmeCloneable
    
    Performs a regular shallow clone of the object. Some fields may also be cloned but generally only if they will never be shared with other objects. (For example, local Vector3fs and so on.)
    This method is separate from the regular clone() method so that objects might still maintain their own regular java clone() semantics (perhaps even using Cloner for those methods). However, because Java's clone() has specific features in the sense of Object's clone() implementation, it's usually best to have some path for subclasses to bypass the public clone() method that might be cloning fields and instead get at the superclass protected clone() methods. For example, through super.jmeClone() or another protected clone method that some base class eventually calls super.clone() in.
    
    Specified by:
    
    jmeClone in interface JmeCloneable
    
    Returns:
    
    a new instance
  - cloneFields
```
public void cloneFields(Cloner cloner,
                        java.lang.Object original)
```
    Description copied from interface: JmeCloneable
    
    Implemented to perform deep cloning for this object, resolving local cloned references using the specified cloner. The object can call cloner.clone(fieldValue) to deep clone any of its fields.
    Note: during normal clone operations the original object will not be needed as the clone has already had all of the fields shallow copied.
    
    Specified by:
    
    cloneFields in interface JmeCloneable
    
    Parameters:
    
    cloner - The cloner that is performing the cloning operation. The cloneFields method can call back into the cloner to make clones of its subordinate fields.
    
    original - The original object from which this object was cloned. This is provided for the very rare case that this object needs to refer to its original for some reason. In general, all of the relevant values should have been transferred during the shallow clone, and this object need only clone what it wants.
  - setSpatial
```
public void setSpatial(Spatial spatial)
```
    Specified by:
    
    setSpatial in interface Control
    
    Parameters:
    
    spatial - the spatial to be controlled. This should not be called from user code.
  - setEnabled
```
public void setEnabled(boolean enabled)
```
    Description copied from interface: PhysicsControl
    
    Enable or disable this control.
    The physics object is removed from its physics space when the control is disabled. When the control is enabled again, the physics 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()
```
    Description copied from interface: PhysicsControl
    
    Test whether this control is enabled.
    
    Specified by:
    
    isEnabled in interface PhysicsControl
    
    Returns:
    
    true if enabled, otherwise false
  - prePhysicsTick
```
public void prePhysicsTick(PhysicsSpace space,
                           float f)
```
    Description copied from interface: PhysicsTickListener
    
    Callback from Bullet, invoked just before the physics is stepped. A good time to clear/apply forces.
    
    Specified by:
    
    prePhysicsTick in interface PhysicsTickListener
    
    Parameters:
    
    space - the space that is about to be stepped (not null)
    
    f - the time per physics step (in seconds, ≥0)
  - physicsTick
```
public void physicsTick(PhysicsSpace space,
                        float f)
```
    Description copied from interface: PhysicsTickListener
    
    Callback from Bullet, invoked just after the physics has been stepped. Use it to check for forces etc.
    
    Specified by:
    
    physicsTick in interface PhysicsTickListener
    
    Parameters:
    
    space - the space that was just stepped (not null)
    
    f - the time per physics step (in seconds, ≥0)
  - update
```
public void update(float tpf)
```
    Description copied from interface: Control
    
    Updates the control. This should not be called from user code.
    
    Specified by:
    
    update in interface Control
    
    Parameters:
    
    tpf - Time per frame.
  - render
```
public void render(RenderManager rm,
                   ViewPort vp)
```
    Description copied from interface: Control
    
    Should be called prior to queuing the spatial by the RenderManager. This should not be called from user code.
    
    Specified by:
    
    render in interface Control
    
    Parameters:
    
    rm - the caller (not null)
    
    vp - the relevant ViewPort (not null)
  - setPhysicsSpace
```
public void setPhysicsSpace(PhysicsSpace space)
```
    Description copied from interface: PhysicsControl
    
    If enabled, add this control's physics object to the specified physics space. In 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:
    
    space - where to add, or null to simply remove
  - getPhysicsSpace
```
public PhysicsSpace getPhysicsSpace()
```
    Description copied from interface: PhysicsControl
    
    Access the physics space to which the 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(JmeExporter ex)
           throws java.io.IOException
```
    Description copied from class: PhysicsRigidBody
    
    Serialize this body, for example when saving to a J3O file.
    
    Specified by:
    
    write in interface Savable
    
    Overrides:
    
    write in class PhysicsVehicle
    
    Parameters:
    
    ex - exporter (not null)
    
    Throws:
    
    java.io.IOException - from exporter
  - read
```
public void read(JmeImporter im)
          throws java.io.IOException
```
    Description copied from class: PhysicsRigidBody
    
    De-serialize this body, for example when loading from a J3O file.
    
    Specified by:
    
    read in interface Savable
    
    Overrides:
    
    read in class PhysicsVehicle
    
    Parameters:
    
    im - importer (not null)
    
    Throws:
    
    java.io.IOException - from importer
  - steer
```
public void steer(float steeringValue)
```
    Description copied from class: PhysicsVehicle
    
    Set the given steering value to all front wheels (0 = forward)
    
    Overrides:
    
    steer in class PhysicsVehicle
    
    Parameters:
    
    steeringValue - the steeringValue to set
  - accelerate
```
public void accelerate(float accelerationValue)
```
    Description copied from class: PhysicsVehicle
    
    Apply the given engine force to all wheels, works continuously
    
    Overrides:
    
    accelerate in class PhysicsVehicle
    
    Parameters:
    
    accelerationValue - the accelerationValue to set

Class PhysicsHoverControl

Field Summary

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

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

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

Constructor Summary

Method Summary

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

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

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

Methods inherited from class java.lang.Object

Field Detail

spatial

enabled

space

steeringValue

accelerationValue

xw

zw

yw

HOVER_HEIGHT_LF_START

HOVER_HEIGHT_RF_START

HOVER_HEIGHT_LR_START

HOVER_HEIGHT_RR_START

HOVER_HEIGHT_LF

HOVER_HEIGHT_RF

HOVER_HEIGHT_LR

HOVER_HEIGHT_RR

tempVect1

tempVect2

tempVect3

Constructor Detail

PhysicsHoverControl

PhysicsHoverControl

PhysicsHoverControl

Method Detail

cloneForSpatial

jmeClone

cloneFields

setSpatial

setEnabled

isEnabled

prePhysicsTick

physicsTick

update

render

setPhysicsSpace

getPhysicsSpace

write

read

steer

accelerate