PhysicsCharacter (jMonkeyEngine3)

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

All Implemented Interfaces:

Savable

Direct Known Subclasses:

CharacterControl
```
public class PhysicsCharacter
extends PhysicsCollisionObject
```
A collision object for simplified character simulation, based on Bullet's btKinematicCharacterController.

Field Summary

Fields
Modifier and Type	Field and Description
`protected long`	`characterId` Unique identifier of btKinematicCharacterController (as opposed to its collision object, which is a ghost).
`protected float`	`fallSpeed`
`protected float`	`jumpSpeed`
`protected boolean`	`locationDirty`
`protected float`	`stepHeight`
`protected Quaternion`	`tmp_inverseWorldRotation`
`protected int`	`upAxis`
`protected Vector3f`	`walkDirection`

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`	`PhysicsCharacter()` No-argument constructor needed by SavableClassUtil.
	`PhysicsCharacter(CollisionShape shape, float stepHeight)` Instantiate a character with the specified collision shape and step height.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`protected void`	`buildObject()` Create the configured character in Bullet.
`void`	`destroy()` Has no effect.
`protected void`	`finalize()` Finalize this physics character just before it is destroyed.
`float`	`getAngularDamping()` Read this character's angular damping.
`Vector3f`	`getAngularVelocity(Vector3f out)` Copy this character's angular velocity.
`float`	`getCcdMotionThreshold()` Calculate this character's continuous collision detection (CCD) motion threshold.
`float`	`getCcdSquareMotionThreshold()` Calculate the square of this character's continuous collision detection (CCD) motion threshold.
`float`	`getCcdSweptSphereRadius()` Read the radius of the sphere used for continuous collision detection (CCD).
`long`	`getControllerId()` used internally
`float`	`getFallSpeed()` Read this character's fall speed.
`float`	`getGravity()` Deprecated. Deprecated in bullet 2.86.1. Use getGravity(Vector3f) instead.
`Vector3f`	`getGravity(Vector3f out)` Copy this character's gravitational acceleration.
`float`	`getJumpSpeed()` Read this character's jump speed.
`float`	`getLinearDamping()` Read this character's linear damping.
`Vector3f`	`getLinearVelocity(Vector3f out)` Copy the linear velocity of this character's center of mass.
`float`	`getMaxPenetrationDepth()` Read this character's maximum penetration depth.
`float`	`getMaxSlope()` Read this character's maximum slope angle.
`Vector3f`	`getPhysicsLocation()` Copy the location of this character's center of mass.
`Vector3f`	`getPhysicsLocation(Vector3f trans)` Copy the location of this character's center of mass.
`float`	`getStepHeight()` Read this character's step height.
`int`	`getUpAxis()` Read the index of the "up" axis.
`Vector3f`	`getWalkDirection()` Access the walk offset.
`void`	`jump()` Deprecated. Deprecated in bullet 2.86.1. Use jump(Vector3f) instead.
`void`	`jump(Vector3f dir)` Jump in the specified direction.
`boolean`	`onGround()` Test whether this character is on the ground.
`void`	`read(JmeImporter e)` De-serialize this character from the specified importer, for example when loading from a J3O file.
`void`	`setAngularDamping(float v)` Alter this character's angular damping.
`void`	`setAngularVelocity(Vector3f v)` Alter this character's angular velocity.
`void`	`setCcdMotionThreshold(float threshold)` Alter the amount of motion required to activate continuous collision detection (CCD).
`void`	`setCcdSweptSphereRadius(float radius)` Alter this character's continuous collision detection (CCD) swept sphere radius.
`void`	`setCollisionShape(CollisionShape collisionShape)` Apply the specified CollisionShape to this character.
`void`	`setContactResponse(boolean responsive)` Enable/disable this character's contact response.
`void`	`setFallSpeed(float fallSpeed)` Alter this character's fall speed.
`void`	`setGravity(float value)` Deprecated. Deprecated in bullet 2.86.1. Use setGravity(Vector3f) instead.
`void`	`setGravity(Vector3f value)` Alter this character's gravitational acceleration.
`void`	`setJumpSpeed(float jumpSpeed)` Alter this character's jump speed.
`void`	`setLinearDamping(float v)` Alter this character's linear damping.
`void`	`setLinearVelocity(Vector3f v)` Alter the linear velocity of this character's center of mass.
`void`	`setMaxPenetrationDepth(float v)` Alter this character's maximum penetration depth.
`void`	`setMaxSlope(float slopeRadians)` Alter this character's maximum slope angle.
`void`	`setPhysicsLocation(Vector3f location)` Directly alter this character's location.
`void`	`setStepHeight(float v)` Alter this character's step height.
`void`	`setUp(Vector3f axis)` Alter this character's "up" direction.
`void`	`setUpAxis(int axis)` Deprecated. Deprecated in bullet 2.86.1 use setUp(Vector3f) instead
`void`	`setWalkDirection(Vector3f vec)` Alter the walk offset.
`void`	`warp(Vector3f location)` Directly alter the location of this character's center of mass.
`void`	`write(JmeExporter e)` Serialize this character, for example when saving to a J3O file.

Methods inherited from class com.jme3.bullet.collision.PhysicsCollisionObject
addCollideWithGroup, attachCollisionShape, 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
  - characterId
```
protected long characterId
```
    Unique identifier of btKinematicCharacterController (as opposed to its collision object, which is a ghost). Constructors are responsible for setting this to a non-zero value. The id might change if the character gets rebuilt.
  - stepHeight
```
protected float stepHeight
```
  - walkDirection
```
protected Vector3f walkDirection
```
  - fallSpeed
```
protected float fallSpeed
```
  - jumpSpeed
```
protected float jumpSpeed
```
  - upAxis
```
protected int upAxis
```
  - locationDirty
```
protected boolean locationDirty
```
  - tmp_inverseWorldRotation
```
protected final Quaternion tmp_inverseWorldRotation
```
- Constructor Detail
  - PhysicsCharacter
```
protected PhysicsCharacter()
```
    No-argument constructor needed by SavableClassUtil. Do not invoke directly!
  - PhysicsCharacter
```
public PhysicsCharacter(CollisionShape shape,
                        float stepHeight)
```
    Instantiate a character with the specified collision shape and step height.
    
    Parameters:
    
    shape - the desired shape (not null, alias created)
    
    stepHeight - the quantization size for vertical movement
- Method Detail
  - buildObject
```
protected void buildObject()
```
    Create the configured character in Bullet.
  - warp
```
public void warp(Vector3f location)
```
    Directly alter the location of this character's center of mass.
    
    Parameters:
    
    location - the desired physics location (not null, unaffected)
  - setWalkDirection
```
public void setWalkDirection(Vector3f vec)
```
    Alter the walk offset. The offset will continue to be applied until altered again.
    
    Parameters:
    
    vec - the desired position increment for each physics tick (not null, unaffected)
  - getWalkDirection
```
public Vector3f getWalkDirection()
```
    Access the walk offset.
    
    Returns:
    
    the pre-existing instance
  - setUpAxis
```
@Deprecated
public void setUpAxis(int axis)
```
    Deprecated. Deprecated in bullet 2.86.1 use setUp(Vector3f) instead
    
    Parameters:
    
    axis - which axis: 0→X, 1→Y, 2→Z
  - setUp
```
public void setUp(Vector3f axis)
```
    Alter this character's "up" direction.
    
    Parameters:
    
    axis - the desired direction (not null, not zero, unaffected)
  - setAngularVelocity
```
public void setAngularVelocity(Vector3f v)
```
    Alter this character's angular velocity.
    
    Parameters:
    
    v - the desired angular velocity vector (not null, unaffected)
  - getAngularVelocity
```
public Vector3f getAngularVelocity(Vector3f out)
```
    Copy this character's angular velocity.
    
    Parameters:
    
    out - storage for the result (modified if not null)
    
    Returns:
    
    the velocity vector (either the provided storage or a new vector, not null)
  - setLinearVelocity
```
public void setLinearVelocity(Vector3f v)
```
    Alter the linear velocity of this character's center of mass.
    
    Parameters:
    
    v - the desired velocity vector (not null)
  - getLinearVelocity
```
public Vector3f getLinearVelocity(Vector3f out)
```
    Copy the linear velocity of this character's center of mass.
    
    Parameters:
    
    out - storage for the result (modified if not null)
    
    Returns:
    
    a vector (either the provided storage or a new vector, not null)
  - getUpAxis
```
public int getUpAxis()
```
    Read the index of the "up" axis.
    
    Returns:
    
    which axis: 0→X, 1→Y, 2→Z
  - setFallSpeed
```
public void setFallSpeed(float fallSpeed)
```
    Alter this character's fall speed.
    
    Parameters:
    
    fallSpeed - the desired speed (default=55)
  - getFallSpeed
```
public float getFallSpeed()
```
    Read this character's fall speed.
    
    Returns:
    
    speed
  - setJumpSpeed
```
public void setJumpSpeed(float jumpSpeed)
```
    Alter this character's jump speed.
    
    Parameters:
    
    jumpSpeed - the desired speed (default=10)
  - getJumpSpeed
```
public float getJumpSpeed()
```
    Read this character's jump speed.
    
    Returns:
    
    speed
  - setGravity
```
@Deprecated
public void setGravity(float value)
```
    Deprecated. Deprecated in bullet 2.86.1. Use setGravity(Vector3f) instead.
    
    Parameters:
    
    value - the desired downward (-Y) component of the acceleration (typically positive)
  - setGravity
```
public void setGravity(Vector3f value)
```
    Alter this character's gravitational acceleration.
    
    Parameters:
    
    value - the desired acceleration vector (not null, unaffected)
  - getGravity
```
@Deprecated
public float getGravity()
```
    Deprecated. Deprecated in bullet 2.86.1. Use getGravity(Vector3f) instead.
    
    Returns:
    
    the downward (-Y) component of the acceleration (typically positive)
  - getGravity
```
public Vector3f getGravity(Vector3f out)
```
    Copy this character's gravitational acceleration.
    
    Parameters:
    
    out - storage for the result (modified if not null)
    
    Returns:
    
    the acceleration vector (either the provided storage or a new vector, not null)
  - getLinearDamping
```
public float getLinearDamping()
```
    Read this character's linear damping.
    
    Returns:
    
    the viscous damping ratio (0→no damping, 1→critically damped)
  - setLinearDamping
```
public void setLinearDamping(float v)
```
    Alter this character's linear damping.
    
    Parameters:
    
    v - the desired viscous damping ratio (0→no damping, 1→critically damped)
  - getAngularDamping
```
public float getAngularDamping()
```
    Read this character's angular damping.
    
    Returns:
    
    the viscous damping ratio (0→no damping, 1→critically damped)
  - setAngularDamping
```
public void setAngularDamping(float v)
```
    Alter this character's angular damping.
    
    Parameters:
    
    v - the desired viscous damping ratio (0→no damping, 1→critically damped, default=0)
  - getStepHeight
```
public float getStepHeight()
```
    Read this character's step height.
    
    Returns:
    
    the height (in physics-space units)
  - setStepHeight
```
public void setStepHeight(float v)
```
    Alter this character's step height.
    
    Parameters:
    
    v - the desired height (in physics-space units)
  - getMaxPenetrationDepth
```
public float getMaxPenetrationDepth()
```
    Read this character's maximum penetration depth.
    
    Returns:
    
    the depth (in physics-space units)
  - setMaxPenetrationDepth
```
public void setMaxPenetrationDepth(float v)
```
    Alter this character's maximum penetration depth.
    
    Parameters:
    
    v - the desired depth (in physics-space units)
  - setMaxSlope
```
public void setMaxSlope(float slopeRadians)
```
    Alter this character's maximum slope angle.
    
    Parameters:
    
    slopeRadians - the desired angle (in radians)
  - getMaxSlope
```
public float getMaxSlope()
```
    Read this character's maximum slope angle.
    
    Returns:
    
    the angle (in radians)
  - setContactResponse
```
public void setContactResponse(boolean responsive)
```
    Enable/disable this character's contact response.
    
    Parameters:
    
    responsive - true to respond to contacts, false to ignore them (default=true)
  - onGround
```
public boolean onGround()
```
    Test whether this character is on the ground.
    
    Returns:
    
    true if on the ground, otherwise false
  - jump
```
@Deprecated
public void jump()
```
    Deprecated. Deprecated in bullet 2.86.1. Use jump(Vector3f) instead.
  - jump
```
public void jump(Vector3f dir)
```
    Jump in the specified direction.
    
    Parameters:
    
    dir - desired jump direction (not null, unaffected)
  - setCollisionShape
```
public void setCollisionShape(CollisionShape collisionShape)
```
    Apply the specified CollisionShape to this character. Note that the character should not be in any physics space while changing shape; the character 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(Vector3f location)
```
    Directly alter this character's location. (Same as warp(com.jme3.math.Vector3f)).)
    
    Parameters:
    
    location - the desired location (not null, unaffected)
  - getPhysicsLocation
```
public Vector3f getPhysicsLocation(Vector3f trans)
```
    Copy the location of this character's center of mass.
    
    Parameters:
    
    trans - storage for the result (modified if not null)
    
    Returns:
    
    the location vector (either the provided storage or a new vector, not null)
  - getPhysicsLocation
```
public Vector3f getPhysicsLocation()
```
    Copy the location of this character's center of mass.
    
    Returns:
    
    a new location vector (not null)
  - setCcdSweptSphereRadius
```
public void setCcdSweptSphereRadius(float radius)
```
    Alter this character's continuous collision detection (CCD) swept sphere radius.
    
    Parameters:
    
    radius - (≥0, default=0)
  - setCcdMotionThreshold
```
public void setCcdMotionThreshold(float threshold)
```
    Alter the amount of motion required to activate continuous collision detection (CCD).
    This addresses the issue of fast objects passing through other objects with no collision detected.
    
    Parameters:
    
    threshold - the desired threshold 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()
```
    Calculate this character's continuous collision detection (CCD) motion threshold.
    
    Returns:
    
    the threshold velocity (≥0)
  - getCcdSquareMotionThreshold
```
public float getCcdSquareMotionThreshold()
```
    Calculate the square of this character's continuous collision detection (CCD) motion threshold.
    
    Returns:
    
    the threshold velocity squared (≥0)
  - getControllerId
```
public long getControllerId()
```
    used internally
    
    Returns:
    
    the Bullet id
  - destroy
```
public void destroy()
```
    Has no effect.
  - write
```
public void write(JmeExporter e)
           throws java.io.IOException
```
    Serialize this character, for example when saving to a J3O file.
    
    Specified by:
    
    write in interface Savable
    
    Overrides:
    
    write in class PhysicsCollisionObject
    
    Parameters:
    
    e - exporter (not null)
    
    Throws:
    
    java.io.IOException - from exporter
  - read
```
public void read(JmeImporter e)
          throws java.io.IOException
```
    De-serialize this character from the specified importer, for example when loading from a J3O file.
    
    Specified by:
    
    read in interface Savable
    
    Overrides:
    
    read in class PhysicsCollisionObject
    
    Parameters:
    
    e - importer (not null)
    
    Throws:
    
    java.io.IOException - from importer
  - finalize
```
protected void finalize()
                 throws java.lang.Throwable
```
    Finalize this physics character just before it is destroyed. Should be invoked only by a subclass or by the garbage collector.
    
    Overrides:
    
    finalize in class PhysicsCollisionObject
    
    Throws:
    
    java.lang.Throwable - ignored by the garbage collector

Class PhysicsCharacter

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

characterId

stepHeight

walkDirection

fallSpeed

jumpSpeed

upAxis

locationDirty

tmp_inverseWorldRotation

Constructor Detail

PhysicsCharacter

PhysicsCharacter

Method Detail

buildObject

warp

setWalkDirection

getWalkDirection

setUpAxis

setUp

setAngularVelocity

getAngularVelocity

setLinearVelocity

getLinearVelocity

getUpAxis

setFallSpeed

getFallSpeed

setJumpSpeed

getJumpSpeed

setGravity

setGravity

getGravity

getGravity

getLinearDamping

setLinearDamping

getAngularDamping

setAngularDamping

getStepHeight

setStepHeight

getMaxPenetrationDepth

setMaxPenetrationDepth

setMaxSlope

getMaxSlope

setContactResponse

onGround

jump

jump

setCollisionShape

setPhysicsLocation

getPhysicsLocation

getPhysicsLocation

setCcdSweptSphereRadius

setCcdMotionThreshold

getCcdSweptSphereRadius

getCcdMotionThreshold

getCcdSquareMotionThreshold

getControllerId

destroy

write

read

finalize