PhysicsRigidBody (jMonkeyEngine 3.1 jme3-bullet Javadoc)

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

All Implemented Interfaces:

com.jme3.export.Savable

Direct Known Subclasses:

PhysicsVehicle, RigidBodyControl
```
public class PhysicsRigidBody
extends PhysicsCollisionObject
```
PhysicsRigidBody - Basic physics object

Author:

normenhansen

Field Summary

Fields
Modifier and Type	Field and Description
`protected java.util.ArrayList<PhysicsJoint>`	`joints`
`protected boolean`	`kinematic`
`protected float`	`mass`
`protected RigidBodyMotionState`	`motionState`

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
Constructor and Description
`PhysicsRigidBody()`
`PhysicsRigidBody(CollisionShape shape)` Creates a new PhysicsRigidBody with the supplied collision shape
`PhysicsRigidBody(CollisionShape shape, float mass)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`activate()` reactivates this PhysicsRigidBody when it has been deactivated because it was not moving
`void`	`addJoint(PhysicsJoint joint)` do not use manually, joints are added automatically
`void`	`applyCentralForce(com.jme3.math.Vector3f force)` Apply a force to the PhysicsRigidBody, only applies force if the next physics update call updates the physics space. To apply an impulse, use applyImpulse.
`void`	`applyForce(com.jme3.math.Vector3f force, com.jme3.math.Vector3f location)` Apply a force to the PhysicsRigidBody, only applies force if the next physics update call updates the physics space. To apply an impulse, use applyImpulse, use applyContinuousForce to apply continuous force.
`void`	`applyImpulse(com.jme3.math.Vector3f impulse, com.jme3.math.Vector3f rel_pos)` Apply an impulse to the PhysicsRigidBody in the next physics update.
`void`	`applyTorque(com.jme3.math.Vector3f torque)` Apply a force to the PhysicsRigidBody, only applies force if the next physics update call updates the physics space. To apply an impulse, use applyImpulse.
`void`	`applyTorqueImpulse(com.jme3.math.Vector3f vec)` Apply a torque impulse to the PhysicsRigidBody in the next physics update.
`void`	`clearForces()` Clear all forces from the PhysicsRigidBody
`float`	`getAngularDamping()`
`float`	`getAngularFactor()`
`com.jme3.math.Vector3f`	`getAngularFactor(com.jme3.math.Vector3f store)`
`float`	`getAngularSleepingThreshold()`
`com.jme3.math.Vector3f`	`getAngularVelocity()` Get the current angular velocity of this PhysicsRigidBody
`void`	`getAngularVelocity(com.jme3.math.Vector3f vec)` Get the current angular velocity of this PhysicsRigidBody
`float`	`getCcdMotionThreshold()`
`float`	`getCcdSquareMotionThreshold()`
`float`	`getCcdSweptSphereRadius()`
`float`	`getFriction()`
`com.jme3.math.Vector3f`	`getGravity()`
`com.jme3.math.Vector3f`	`getGravity(com.jme3.math.Vector3f gravity)`
`java.util.List<PhysicsJoint>`	`getJoints()` Returns a list of connected joints.
`float`	`getLinearDamping()`
`com.jme3.math.Vector3f`	`getLinearFactor()`
`float`	`getLinearSleepingThreshold()`
`com.jme3.math.Vector3f`	`getLinearVelocity()` Get the current linear velocity of this PhysicsRigidBody
`void`	`getLinearVelocity(com.jme3.math.Vector3f vec)` Get the current linear velocity of this PhysicsRigidBody
`float`	`getMass()`
`RigidBodyMotionState`	`getMotionState()`
`com.jme3.math.Vector3f`	`getPhysicsLocation()`
`com.jme3.math.Vector3f`	`getPhysicsLocation(com.jme3.math.Vector3f trans)`
`com.jme3.math.Quaternion`	`getPhysicsRotation()`
`com.jme3.math.Quaternion`	`getPhysicsRotation(com.jme3.math.Quaternion rot)`
`com.jme3.math.Matrix3f`	`getPhysicsRotationMatrix()`
`com.jme3.math.Matrix3f`	`getPhysicsRotationMatrix(com.jme3.math.Matrix3f rot)`
`float`	`getRestitution()`
`boolean`	`isActive()`
`boolean`	`isInWorld()`
`boolean`	`isKinematic()`
`protected void`	`postRebuild()`
`protected void`	`preRebuild()`
`void`	`read(com.jme3.export.JmeImporter e)`
`protected void`	`rebuildRigidBody()` Builds/rebuilds the phyiscs body when parameters have changed
`void`	`removeJoint(PhysicsJoint joint)`
`void`	`setAngularDamping(float angularDamping)`
`void`	`setAngularFactor(float factor)`
`void`	`setAngularFactor(com.jme3.math.Vector3f factor)`
`void`	`setAngularSleepingThreshold(float angularSleepingThreshold)`
`void`	`setAngularVelocity(com.jme3.math.Vector3f vec)` Sets the angular velocity of this PhysicsRigidBody
`void`	`setCcdMotionThreshold(float threshold)` Sets the amount of motion that has to happen in one physics tick to trigger the continuous motion detection This avoids the problem of fast objects moving through other objects, set to zero to disable (default)
`void`	`setCcdSweptSphereRadius(float radius)`
`void`	`setCollisionShape(CollisionShape collisionShape)` Sets a CollisionShape to this physics object, note that the object should not be in the physics space when adding a new collision shape as it is rebuilt on the physics side.
`void`	`setDamping(float linearDamping, float angularDamping)`
`void`	`setFriction(float friction)` Sets the friction of this physics object
`void`	`setGravity(com.jme3.math.Vector3f gravity)` Set the local gravity of this PhysicsRigidBody Set this after adding the node to the PhysicsSpace, the PhysicsSpace assigns its current gravity to the physics node when its added.
`void`	`setKinematic(boolean kinematic)` Sets the node to kinematic mode.
`void`	`setLinearDamping(float linearDamping)`
`void`	`setLinearFactor(com.jme3.math.Vector3f factor)`
`void`	`setLinearSleepingThreshold(float linearSleepingThreshold)`
`void`	`setLinearVelocity(com.jme3.math.Vector3f vec)` Sets the linear velocity of this PhysicsRigidBody
`void`	`setMass(float mass)` Sets the mass of this PhysicsRigidBody, objects with mass=0 are static.
`void`	`setPhysicsLocation(com.jme3.math.Vector3f location)` Sets the physics object location
`void`	`setPhysicsRotation(com.jme3.math.Matrix3f rotation)` Sets the physics object rotation
`void`	`setPhysicsRotation(com.jme3.math.Quaternion rotation)` Sets the physics object rotation
`void`	`setRestitution(float restitution)` The "bouncyness" of the PhysicsRigidBody, best performance if restitution=0
`void`	`setSleepingThresholds(float linear, float angular)` sets the sleeping thresholds, these define when the object gets deactivated to save ressources.
`void`	`write(com.jme3.export.JmeExporter e)`

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

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

- Field Detail
  - motionState
```
protected RigidBodyMotionState motionState
```
  - mass
```
protected float mass
```
  - kinematic
```
protected boolean kinematic
```
  - joints
```
protected java.util.ArrayList<PhysicsJoint> joints
```
- Constructor Detail
  - PhysicsRigidBody
```
public PhysicsRigidBody()
```
  - PhysicsRigidBody
```
public PhysicsRigidBody(CollisionShape shape)
```
    Creates a new PhysicsRigidBody with the supplied collision shape
    
    Parameters:
    child -
    shape -
  - PhysicsRigidBody
```
public PhysicsRigidBody(CollisionShape shape,
                float mass)
```
- Method Detail
  - rebuildRigidBody
```
protected void rebuildRigidBody()
```
    Builds/rebuilds the phyiscs body when parameters have changed
  - preRebuild
```
protected void preRebuild()
```
  - postRebuild
```
protected void postRebuild()
```
  - getMotionState
```
public RigidBodyMotionState getMotionState()
```
    Returns:
    the motionState
  - isInWorld
```
public boolean isInWorld()
```
  - setPhysicsLocation
```
public void setPhysicsLocation(com.jme3.math.Vector3f location)
```
    Sets the physics object location
    
    Parameters:
    location - the location of the actual physics object
  - setPhysicsRotation
```
public void setPhysicsRotation(com.jme3.math.Matrix3f rotation)
```
    Sets the physics object rotation
    
    Parameters:
    rotation - the rotation of the actual physics object
  - setPhysicsRotation
```
public void setPhysicsRotation(com.jme3.math.Quaternion rotation)
```
    Sets the physics object rotation
    
    Parameters:
    rotation - the rotation of the actual physics object
  - getPhysicsLocation
```
public com.jme3.math.Vector3f getPhysicsLocation(com.jme3.math.Vector3f trans)
```
    Returns:
    the physicsLocation
  - getPhysicsRotation
```
public com.jme3.math.Quaternion getPhysicsRotation(com.jme3.math.Quaternion rot)
```
    Returns:
    the physicsLocation
  - getPhysicsRotationMatrix
```
public com.jme3.math.Matrix3f getPhysicsRotationMatrix(com.jme3.math.Matrix3f rot)
```
    Returns:
    the physicsLocation
  - getPhysicsLocation
```
public com.jme3.math.Vector3f getPhysicsLocation()
```
    Returns:
    the physicsLocation
  - getPhysicsRotation
```
public com.jme3.math.Quaternion getPhysicsRotation()
```
    Returns:
    the physicsLocation
  - getPhysicsRotationMatrix
```
public com.jme3.math.Matrix3f getPhysicsRotationMatrix()
```
  - setKinematic
```
public void setKinematic(boolean kinematic)
```
    Sets the node to kinematic mode. in this mode the node is not affected by physics but affects other physics objects. Iits kinetic force is calculated by the amount of movement it is exposed to and its weight.
    
    Parameters:
    kinematic -
  - isKinematic
```
public boolean isKinematic()
```
  - setCcdSweptSphereRadius
```
public void setCcdSweptSphereRadius(float radius)
```
  - setCcdMotionThreshold
```
public void setCcdMotionThreshold(float threshold)
```
    Sets the amount of motion that has to happen in one physics tick to trigger the continuous motion detection
    This avoids the problem of fast objects moving through other objects, set to zero to disable (default)
    
    Parameters:
    threshold -
  - getCcdSweptSphereRadius
```
public float getCcdSweptSphereRadius()
```
  - getCcdMotionThreshold
```
public float getCcdMotionThreshold()
```
  - getCcdSquareMotionThreshold
```
public float getCcdSquareMotionThreshold()
```
  - getMass
```
public float getMass()
```
  - setMass
```
public void setMass(float mass)
```
    Sets the mass of this PhysicsRigidBody, objects with mass=0 are static.
    
    Parameters:
    mass -
  - getGravity
```
public com.jme3.math.Vector3f getGravity()
```
  - getGravity
```
public com.jme3.math.Vector3f getGravity(com.jme3.math.Vector3f gravity)
```
  - setGravity
```
public void setGravity(com.jme3.math.Vector3f gravity)
```
    Set the local gravity of this PhysicsRigidBody
    Set this after adding the node to the PhysicsSpace, the PhysicsSpace assigns its current gravity to the physics node when its added.
    
    Parameters:
    gravity - the gravity vector to set
  - getFriction
```
public float getFriction()
```
  - setFriction
```
public void setFriction(float friction)
```
    Sets the friction of this physics object
    
    Parameters:
    friction - the friction of this physics object
  - setDamping
```
public void setDamping(float linearDamping,
              float angularDamping)
```
  - setLinearDamping
```
public void setLinearDamping(float linearDamping)
```
  - setAngularDamping
```
public void setAngularDamping(float angularDamping)
```
  - getLinearDamping
```
public float getLinearDamping()
```
  - getAngularDamping
```
public float getAngularDamping()
```
  - getRestitution
```
public float getRestitution()
```
  - setRestitution
```
public void setRestitution(float restitution)
```
    The "bouncyness" of the PhysicsRigidBody, best performance if restitution=0
    
    Parameters:
    restitution -
  - getAngularVelocity
```
public com.jme3.math.Vector3f getAngularVelocity()
```
    Get the current angular velocity of this PhysicsRigidBody
    
    Returns:
    the current linear velocity
  - getAngularVelocity
```
public void getAngularVelocity(com.jme3.math.Vector3f vec)
```
    Get the current angular velocity of this PhysicsRigidBody
    
    Parameters:
    vec - the vector to store the velocity in
  - setAngularVelocity
```
public void setAngularVelocity(com.jme3.math.Vector3f vec)
```
    Sets the angular velocity of this PhysicsRigidBody
    
    Parameters:
    vec - the angular velocity of this PhysicsRigidBody
  - getLinearVelocity
```
public com.jme3.math.Vector3f getLinearVelocity()
```
    Get the current linear velocity of this PhysicsRigidBody
    
    Returns:
    the current linear velocity
  - getLinearVelocity
```
public void getLinearVelocity(com.jme3.math.Vector3f vec)
```
    Get the current linear velocity of this PhysicsRigidBody
    
    Parameters:
    vec - the vector to store the velocity in
  - setLinearVelocity
```
public void setLinearVelocity(com.jme3.math.Vector3f vec)
```
    Sets the linear velocity of this PhysicsRigidBody
    
    Parameters:
    vec - the linear velocity of this PhysicsRigidBody
  - applyForce
```
public void applyForce(com.jme3.math.Vector3f force,
              com.jme3.math.Vector3f location)
```
    Apply a force to the PhysicsRigidBody, only applies force if the next physics update call updates the physics space.
    To apply an impulse, use applyImpulse, use applyContinuousForce to apply continuous force.
    
    Parameters:
    force - the force
    location - the location of the force
  - applyCentralForce
```
public void applyCentralForce(com.jme3.math.Vector3f force)
```
    Apply a force to the PhysicsRigidBody, only applies force if the next physics update call updates the physics space.
    To apply an impulse, use applyImpulse.
    
    Parameters:
    force - the force
  - applyTorque
```
public void applyTorque(com.jme3.math.Vector3f torque)
```
    Apply a force to the PhysicsRigidBody, only applies force if the next physics update call updates the physics space.
    To apply an impulse, use applyImpulse.
    
    Parameters:
    torque - the torque
  - applyImpulse
```
public void applyImpulse(com.jme3.math.Vector3f impulse,
                com.jme3.math.Vector3f rel_pos)
```
    Apply an impulse to the PhysicsRigidBody in the next physics update.
    
    Parameters:
    impulse - applied impulse
    rel_pos - location relative to object
  - applyTorqueImpulse
```
public void applyTorqueImpulse(com.jme3.math.Vector3f vec)
```
    Apply a torque impulse to the PhysicsRigidBody in the next physics update.
    
    Parameters:
    vec -
  - clearForces
```
public void clearForces()
```
    Clear all forces from the PhysicsRigidBody
  - setCollisionShape
```
public void setCollisionShape(CollisionShape collisionShape)
```
    Description copied from class: PhysicsCollisionObject
    
    Sets a CollisionShape to this physics object, note that the object should not be in the physics space when adding a new collision shape as it is rebuilt on the physics side.
    
    Overrides:
    
    setCollisionShape in class PhysicsCollisionObject
    
    Parameters:
    collisionShape - the CollisionShape to set
  - activate
```
public void activate()
```
    reactivates this PhysicsRigidBody when it has been deactivated because it was not moving
  - isActive
```
public boolean isActive()
```
  - setSleepingThresholds
```
public void setSleepingThresholds(float linear,
                         float angular)
```
    sets the sleeping thresholds, these define when the object gets deactivated to save ressources. Low values keep the object active when it barely moves
    
    Parameters:
    linear - the linear sleeping threshold
    angular - the angular sleeping threshold
  - setLinearSleepingThreshold
```
public void setLinearSleepingThreshold(float linearSleepingThreshold)
```
  - setAngularSleepingThreshold
```
public void setAngularSleepingThreshold(float angularSleepingThreshold)
```
  - getLinearSleepingThreshold
```
public float getLinearSleepingThreshold()
```
  - getAngularSleepingThreshold
```
public float getAngularSleepingThreshold()
```
  - getAngularFactor
```
public float getAngularFactor()
```
  - getAngularFactor
```
public com.jme3.math.Vector3f getAngularFactor(com.jme3.math.Vector3f store)
```
  - setAngularFactor
```
public void setAngularFactor(float factor)
```
  - setAngularFactor
```
public void setAngularFactor(com.jme3.math.Vector3f factor)
```
  - getLinearFactor
```
public com.jme3.math.Vector3f getLinearFactor()
```
  - setLinearFactor
```
public void setLinearFactor(com.jme3.math.Vector3f factor)
```
  - addJoint
```
public void addJoint(PhysicsJoint joint)
```
    do not use manually, joints are added automatically
  - removeJoint
```
public void removeJoint(PhysicsJoint joint)
```
  - getJoints
```
public java.util.List<PhysicsJoint> getJoints()
```
    Returns a list of connected joints. This list is only filled when the PhysicsRigidBody is actually added to the physics space or loaded from disk.
    
    Returns:
    list of active joints connected to this PhysicsRigidBody
  - write
```
public void write(com.jme3.export.JmeExporter e)
           throws java.io.IOException
```
    Specified by:
    
    write in interface com.jme3.export.Savable
    
    Overrides:
    
    write in class PhysicsCollisionObject
    
    Throws:
    
    java.io.IOException
  - read
```
public void read(com.jme3.export.JmeImporter e)
          throws java.io.IOException
```
    Specified by:
    
    read in interface com.jme3.export.Savable
    
    Overrides:
    
    read in class PhysicsCollisionObject
    
    Throws:
    
    java.io.IOException

Class PhysicsRigidBody

Field Summary

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Field Detail

motionState

mass

kinematic

joints

Constructor Detail

PhysicsRigidBody

PhysicsRigidBody

PhysicsRigidBody

Method Detail

rebuildRigidBody

preRebuild

postRebuild

getMotionState

isInWorld

setPhysicsLocation

setPhysicsRotation

setPhysicsRotation

getPhysicsLocation

getPhysicsRotation

getPhysicsRotationMatrix

getPhysicsLocation

getPhysicsRotation

getPhysicsRotationMatrix

setKinematic

isKinematic

setCcdSweptSphereRadius

setCcdMotionThreshold

getCcdSweptSphereRadius

getCcdMotionThreshold

getCcdSquareMotionThreshold

getMass

setMass

getGravity

getGravity

setGravity

getFriction

setFriction

setDamping

setLinearDamping

setAngularDamping

getLinearDamping

getAngularDamping

getRestitution

setRestitution

getAngularVelocity

getAngularVelocity

setAngularVelocity

getLinearVelocity

getLinearVelocity

setLinearVelocity

applyForce

applyCentralForce

applyTorque

applyImpulse

applyTorqueImpulse

clearForces

setCollisionShape

activate

isActive

setSleepingThresholds

setLinearSleepingThreshold

setAngularSleepingThreshold

getLinearSleepingThreshold

getAngularSleepingThreshold

getAngularFactor

getAngularFactor

setAngularFactor

setAngularFactor

getLinearFactor

setLinearFactor

addJoint

removeJoint