* In general, the smaller the time step, the more accurate (and * compute-intensive) the simulation will be. Bullet works best with a - * timestep of no more than 1/60 second. + * time step of no more than 1/60 second. * * @param accuracy the desired time step (in seconds, >0, default=1/60) */ diff --git a/jme3-bullet/src/main/java/com/jme3/bullet/collision/PhysicsCollisionEvent.java b/jme3-bullet/src/main/java/com/jme3/bullet/collision/PhysicsCollisionEvent.java index 2c81bee35..bb6276002 100644 --- a/jme3-bullet/src/main/java/com/jme3/bullet/collision/PhysicsCollisionEvent.java +++ b/jme3-bullet/src/main/java/com/jme3/bullet/collision/PhysicsCollisionEvent.java @@ -36,7 +36,7 @@ import com.jme3.scene.Spatial; import java.util.EventObject; /** - * An event that describes a collision in the physics world. + * Describe a collision in the physics world. *
* Do not retain this object, as it will be reused after the collision() method * returns. Copy any data you need during the collide() method. diff --git a/jme3-bullet/src/main/java/com/jme3/bullet/collision/PhysicsCollisionObject.java b/jme3-bullet/src/main/java/com/jme3/bullet/collision/PhysicsCollisionObject.java index 9c9a1338f..443433623 100644 --- a/jme3-bullet/src/main/java/com/jme3/bullet/collision/PhysicsCollisionObject.java +++ b/jme3-bullet/src/main/java/com/jme3/bullet/collision/PhysicsCollisionObject.java @@ -236,7 +236,8 @@ public abstract class PhysicsCollisionObject implements Savable { } /** - * Initialize the user pointer and collision-group information of this object. + * Initialize the user pointer and collision-group information of this + * object. */ protected void initUserPointer() { Logger.getLogger(this.getClass().getName()).log(Level.FINE, "initUserPointer() objectId = {0}", Long.toHexString(objectId)); diff --git a/jme3-bullet/src/main/java/com/jme3/bullet/collision/PhysicsRayTestResult.java b/jme3-bullet/src/main/java/com/jme3/bullet/collision/PhysicsRayTestResult.java index d00c58df5..02bf0162e 100644 --- a/jme3-bullet/src/main/java/com/jme3/bullet/collision/PhysicsRayTestResult.java +++ b/jme3-bullet/src/main/java/com/jme3/bullet/collision/PhysicsRayTestResult.java @@ -76,7 +76,7 @@ public class PhysicsRayTestResult { /** * Access the normal vector at the point of contact. * - * @return the pre-existing vector (not null) + * @return a pre-existing unit vector (not null) */ public Vector3f getHitNormalLocal() { return hitNormalLocal; diff --git a/jme3-bullet/src/main/java/com/jme3/bullet/collision/PhysicsSweepTestResult.java b/jme3-bullet/src/main/java/com/jme3/bullet/collision/PhysicsSweepTestResult.java index 7a00f2f49..9becbb1c7 100644 --- a/jme3-bullet/src/main/java/com/jme3/bullet/collision/PhysicsSweepTestResult.java +++ b/jme3-bullet/src/main/java/com/jme3/bullet/collision/PhysicsSweepTestResult.java @@ -34,7 +34,7 @@ package com.jme3.bullet.collision; import com.jme3.math.Vector3f; /** - * Contains the results of a PhysicsSpace rayTest + * Represent the results of a Bullet sweep test. * * @author normenhansen */ @@ -57,6 +57,10 @@ public class PhysicsSweepTestResult { */ private boolean normalInWorldSpace; + /** + * A private constructor to inhibit instantiation of this class by Java. + * These results are instantiated exclusively by native code. + */ public PhysicsSweepTestResult() { } @@ -86,7 +90,8 @@ public class PhysicsSweepTestResult { } /** - * Read the hit fraction. + * Read the fraction of fraction of the way between the transforms (from=0, + * to=1, ≥0, ≤1) * * @return fraction (from=0, to=1, ≥0, ≤1) */ diff --git a/jme3-bullet/src/main/java/com/jme3/bullet/collision/shapes/BoxCollisionShape.java b/jme3-bullet/src/main/java/com/jme3/bullet/collision/shapes/BoxCollisionShape.java index a967143c3..bec41ff97 100644 --- a/jme3-bullet/src/main/java/com/jme3/bullet/collision/shapes/BoxCollisionShape.java +++ b/jme3-bullet/src/main/java/com/jme3/bullet/collision/shapes/BoxCollisionShape.java @@ -63,8 +63,8 @@ public class BoxCollisionShape extends CollisionShape { /** * Instantiate a box shape with the specified half extents. * - * @param halfExtents the desired half extents (not null, no negative - * component, alias created) + * @param halfExtents the desired unscaled half extents (not null, no + * negative component, alias created) */ public BoxCollisionShape(Vector3f halfExtents) { this.halfExtents = halfExtents; @@ -72,7 +72,7 @@ public class BoxCollisionShape extends CollisionShape { } /** - * Access the half extents. + * Access the half extents of the box. * * @return the pre-existing instance (not null, no negative component) */ diff --git a/jme3-bullet/src/main/java/com/jme3/bullet/collision/shapes/CapsuleCollisionShape.java b/jme3-bullet/src/main/java/com/jme3/bullet/collision/shapes/CapsuleCollisionShape.java index 2aa81f954..0a15b343e 100644 --- a/jme3-bullet/src/main/java/com/jme3/bullet/collision/shapes/CapsuleCollisionShape.java +++ b/jme3-bullet/src/main/java/com/jme3/bullet/collision/shapes/CapsuleCollisionShape.java @@ -42,7 +42,7 @@ import java.util.logging.Logger; /** * A capsule collision shape based on Bullet's btCapsuleShapeX, btCapsuleShape, - * or btCapsuleShapeZ. + * or btCapsuleShapeZ. These shapes have no margin and cannot be scaled. * * @author normenhansen */ @@ -97,7 +97,7 @@ public class CapsuleCollisionShape extends CollisionShape{ /** * Read the radius of the capsule. * - * @return radius (≥0) + * @return the radius (≥0) */ public float getRadius() { return radius; diff --git a/jme3-bullet/src/main/java/com/jme3/bullet/collision/shapes/CollisionShape.java b/jme3-bullet/src/main/java/com/jme3/bullet/collision/shapes/CollisionShape.java index abd46e607..ea6f11be9 100644 --- a/jme3-bullet/src/main/java/com/jme3/bullet/collision/shapes/CollisionShape.java +++ b/jme3-bullet/src/main/java/com/jme3/bullet/collision/shapes/CollisionShape.java @@ -50,7 +50,7 @@ import java.util.logging.Logger; public abstract class CollisionShape implements Savable { /** - * unique identifier of the Bullet shape + * unique identifier of the btCollisionShape *
* Constructors are responsible for setting this to a non-zero value. After * that, the id never changes. @@ -61,8 +61,7 @@ public abstract class CollisionShape implements Savable { */ protected Vector3f scale = new Vector3f(1, 1, 1); /** - * copy of collision margin (in physics-space units, >0, - * default=0) + * copy of collision margin (in physics-space units, >0, default=0) */ protected float margin = 0.0f; @@ -87,7 +86,7 @@ public abstract class CollisionShape implements Savable { // private native void calculateLocalInertia(long objectId, long shapeId, float mass); /** - * Read the id of the Bullet shape. + * Read the id of the btCollisionShape. * * @return the unique identifier (not zero) */ @@ -128,7 +127,7 @@ public abstract class CollisionShape implements Savable { /** * Read the collision margin for this shape. * - * @return the margin distance (in physics-space units, >0) + * @return the margin distance (in physics-space units, ≥0) */ public float getMargin() { return getMargin(objectId); @@ -137,7 +136,7 @@ public abstract class CollisionShape implements Savable { private native float getMargin(long objectId); /** - * Alter the collision margin for this shape. CAUTION: Margin is applied + * Alter the collision margin of this shape. CAUTION: Margin is applied * differently, depending on the type of shape. Generally the collision * margin expands the object, creating a gap. Don't set the collision margin * to zero. diff --git a/jme3-bullet/src/main/java/com/jme3/bullet/collision/shapes/CylinderCollisionShape.java b/jme3-bullet/src/main/java/com/jme3/bullet/collision/shapes/CylinderCollisionShape.java index 807516fff..2178899f7 100644 --- a/jme3-bullet/src/main/java/com/jme3/bullet/collision/shapes/CylinderCollisionShape.java +++ b/jme3-bullet/src/main/java/com/jme3/bullet/collision/shapes/CylinderCollisionShape.java @@ -54,7 +54,7 @@ public class CylinderCollisionShape extends CollisionShape { */ protected Vector3f halfExtents; /** - * main (height) axis (0→X, 1→Y, 2→Z) + * copy of main (height) axis (0→X, 1→Y, 2→Z) */ protected int axis; @@ -68,8 +68,8 @@ public class CylinderCollisionShape extends CollisionShape { /** * Instantiate a Z-axis cylinder shape with the specified half extents. * - * @param halfExtents the desired half extents (not null, no negative - * component, alias created) + * @param halfExtents the desired unscaled half extents (not null, no + * negative component, alias created) */ public CylinderCollisionShape(Vector3f halfExtents) { this.halfExtents = halfExtents; @@ -80,8 +80,8 @@ public class CylinderCollisionShape extends CollisionShape { /** * Instantiate a cylinder shape around the specified axis. * - * @param halfExtents the desired half extents (not null, no negative - * component, alias created) + * @param halfExtents the desired unscaled half extents (not null, no + * negative component, alias created) * @param axis which local axis: 0→X, 1→Y, 2→Z */ public CylinderCollisionShape(Vector3f halfExtents, int axis) { diff --git a/jme3-bullet/src/main/java/com/jme3/bullet/collision/shapes/HeightfieldCollisionShape.java b/jme3-bullet/src/main/java/com/jme3/bullet/collision/shapes/HeightfieldCollisionShape.java index 43f764fb5..f4fcaef6d 100644 --- a/jme3-bullet/src/main/java/com/jme3/bullet/collision/shapes/HeightfieldCollisionShape.java +++ b/jme3-bullet/src/main/java/com/jme3/bullet/collision/shapes/HeightfieldCollisionShape.java @@ -84,7 +84,7 @@ public class HeightfieldCollisionShape extends CollisionShape { * buffer for passing height data to Bullet *
* A Java reference must persist after createShape() completes, or else the - * buffer might get garbaged collected. + * buffer might get garbage collected. */ protected ByteBuffer bbuf; // protected FloatBuffer fbuf; diff --git a/jme3-bullet/src/main/java/com/jme3/bullet/collision/shapes/HullCollisionShape.java b/jme3-bullet/src/main/java/com/jme3/bullet/collision/shapes/HullCollisionShape.java index 527024fa9..d20e0e51e 100644 --- a/jme3-bullet/src/main/java/com/jme3/bullet/collision/shapes/HullCollisionShape.java +++ b/jme3-bullet/src/main/java/com/jme3/bullet/collision/shapes/HullCollisionShape.java @@ -64,7 +64,8 @@ public class HullCollisionShape extends CollisionShape { * performance and stability, use the mesh should have no more than 100 * vertices. * - * @param mesh a mesh on which to base the shape (not null) + * @param mesh a mesh on which to base the shape (not null, at least one + * vertex) */ public HullCollisionShape(Mesh mesh) { this.points = getPoints(mesh); @@ -72,10 +73,11 @@ public class HullCollisionShape extends CollisionShape { } /** - * Instantiate a collision shape based on the specified JME mesh. + * Instantiate a collision shape based on the specified array of + * coordinates. * * @param points an array of coordinates on which to base the shape (not - * null, length a multiple of 3) + * null, not empty, length a multiple of 3) */ public HullCollisionShape(float[] points) { this.points = points; diff --git a/jme3-bullet/src/main/java/com/jme3/bullet/collision/shapes/SphereCollisionShape.java b/jme3-bullet/src/main/java/com/jme3/bullet/collision/shapes/SphereCollisionShape.java index 1f0ab7e29..dd4228e37 100644 --- a/jme3-bullet/src/main/java/com/jme3/bullet/collision/shapes/SphereCollisionShape.java +++ b/jme3-bullet/src/main/java/com/jme3/bullet/collision/shapes/SphereCollisionShape.java @@ -41,7 +41,8 @@ import java.util.logging.Level; import java.util.logging.Logger; /** - * A spherical collision shape based on Bullet's btSphereShape. + * A spherical collision shape based on Bullet's btSphereShape. These shapes + * have no margin and cannot be scaled. * * @author normenhansen */ @@ -70,7 +71,7 @@ public class SphereCollisionShape extends CollisionShape { } /** - * Read the radius of this shape. + * Read the radius of the sphere. * * @return the radius (≥0) */ diff --git a/jme3-bullet/src/main/java/com/jme3/bullet/joints/PhysicsJoint.java b/jme3-bullet/src/main/java/com/jme3/bullet/joints/PhysicsJoint.java index b78e9fb3d..f3087dfae 100644 --- a/jme3-bullet/src/main/java/com/jme3/bullet/joints/PhysicsJoint.java +++ b/jme3-bullet/src/main/java/com/jme3/bullet/joints/PhysicsJoint.java @@ -162,7 +162,7 @@ public abstract class PhysicsJoint implements Savable { /** * Access the local offset of the joint connection point in node A. * - * @return the pre-existing vector + * @return the pre-existing vector (not null) */ public Vector3f getPivotA() { return pivotA; @@ -171,7 +171,7 @@ public abstract class PhysicsJoint implements Savable { /** * Access the local offset of the joint connection point in node A. * - * @return the pre-existing vector + * @return the pre-existing vector (not null) */ public Vector3f getPivotB() { return pivotB; diff --git a/jme3-bullet/src/main/java/com/jme3/bullet/objects/PhysicsCharacter.java b/jme3-bullet/src/main/java/com/jme3/bullet/objects/PhysicsCharacter.java index ad6cf96b6..148199b75 100644 --- a/jme3-bullet/src/main/java/com/jme3/bullet/objects/PhysicsCharacter.java +++ b/jme3-bullet/src/main/java/com/jme3/bullet/objects/PhysicsCharacter.java @@ -287,7 +287,8 @@ public class PhysicsCharacter extends PhysicsCollisionObject { } /** - * @deprecated Deprecated in bullet 2.86.1. Use setGravity(Vector3f) instead. + * @deprecated Deprecated in bullet 2.86.1. Use setGravity(Vector3f) + * instead. * @param value the desired upward component of the acceleration (typically * negative) */ @@ -308,7 +309,8 @@ public class PhysicsCharacter extends PhysicsCollisionObject { private native void setGravity(long characterId, Vector3f gravity); /** - * @deprecated Deprecated in bullet 2.86.1. Use getGravity(Vector3f) instead. + * @deprecated Deprecated in bullet 2.86.1. Use getGravity(Vector3f) + * instead. * @return the upward component of the acceleration (typically negative) */ @Deprecated diff --git a/jme3-bullet/src/main/java/com/jme3/bullet/objects/PhysicsGhostObject.java b/jme3-bullet/src/main/java/com/jme3/bullet/objects/PhysicsGhostObject.java index 0ba0034cc..acb3752e6 100644 --- a/jme3-bullet/src/main/java/com/jme3/bullet/objects/PhysicsGhostObject.java +++ b/jme3-bullet/src/main/java/com/jme3/bullet/objects/PhysicsGhostObject.java @@ -128,7 +128,8 @@ public class PhysicsGhostObject extends PhysicsCollisionObject { /** * Directly alter the location of this object's center. * - * @param location the desired location (not null, unaffected) + * @param location the desired location (in physics-space coordinates, not + * null, unaffected) */ public void setPhysicsLocation(Vector3f location) { setPhysicsLocation(objectId, location); @@ -139,8 +140,8 @@ public class PhysicsGhostObject extends PhysicsCollisionObject { /** * Directly alter this object's orientation. * - * @param rotation the desired orientation (rotation matrix, not null, - * unaffected) + * @param rotation the desired orientation (a rotation matrix in + * physics-space coordinates, not null, unaffected) */ public void setPhysicsRotation(Matrix3f rotation) { setPhysicsRotation(objectId, rotation); @@ -164,8 +165,8 @@ public class PhysicsGhostObject extends PhysicsCollisionObject { * Copy the location of this object's center. * * @param trans storage for the result (modified if not null) - * @return the physics location (either the provided storage or a new - * vector, not null) + * @return a location vector (in physics-space coordinates, either + * the provided storage or a new vector, not null) */ public Vector3f getPhysicsLocation(Vector3f trans) { if (trans == null) { @@ -181,8 +182,8 @@ public class PhysicsGhostObject extends PhysicsCollisionObject { * Copy this object's orientation to a quaternion. * * @param rot storage for the result (modified if not null) - * @return the physics orientation (either the provided storage or a new - * quaternion, not null) + * @return an orientation (in physics-space coordinates, either the provided + * storage or a new quaternion, not null) */ public Quaternion getPhysicsRotation(Quaternion rot) { if (rot == null) { @@ -198,8 +199,8 @@ public class PhysicsGhostObject extends PhysicsCollisionObject { * Copy this object's orientation to a matrix. * * @param rot storage for the result (modified if not null) - * @return the orientation (either the provided storage or a new matrix, not - * null) + * @return an orientation (in physics-space coordinates, either the provided + * storage or a new matrix, not null) */ public Matrix3f getPhysicsRotationMatrix(Matrix3f rot) { if (rot == null) { @@ -258,9 +259,6 @@ public class PhysicsGhostObject extends PhysicsCollisionObject { /** * Access a list of overlapping objects. - *
- * Another object overlaps with this one if and if only their - * CollisionShapes overlap. * * @return an internal list which may get reused (not null) */ @@ -285,7 +283,7 @@ public class PhysicsGhostObject extends PhysicsCollisionObject { } /** - * Count how many CollisionObjects this object overlaps. + * Count how many collision objects this object overlaps. * * @return count (≥0) */ diff --git a/jme3-bullet/src/main/java/com/jme3/bullet/objects/PhysicsRigidBody.java b/jme3-bullet/src/main/java/com/jme3/bullet/objects/PhysicsRigidBody.java index 80e3728f1..7a82e67cf 100644 --- a/jme3-bullet/src/main/java/com/jme3/bullet/objects/PhysicsRigidBody.java +++ b/jme3-bullet/src/main/java/com/jme3/bullet/objects/PhysicsRigidBody.java @@ -198,8 +198,8 @@ public class PhysicsRigidBody extends PhysicsCollisionObject { /** * Directly alter this body's orientation. * - * @param rotation the desired orientation (quaternion, not null, - * unaffected) + * @param rotation the desired orientation (quaternion, in physics-space + * coordinates, not null, unaffected) */ public void setPhysicsRotation(Quaternion rotation) { setPhysicsRotation(objectId, rotation); @@ -211,8 +211,8 @@ public class PhysicsRigidBody extends PhysicsCollisionObject { * Copy the location of this body's center of mass. * * @param trans storage for the result (modified if not null) - * @return the location (either the provided storage or a new vector, not - * null) + * @return the location (in physics-space coordinates, either the provided + * storage or a new vector, not null) */ public Vector3f getPhysicsLocation(Vector3f trans) { if (trans == null) { @@ -250,7 +250,7 @@ public class PhysicsRigidBody extends PhysicsCollisionObject { private native void setInverseInertiaLocal(long objectId, Vector3f gravity); /** - * Read the principal components of the local inverse inertia tensor. + * Copy the principal components of the local inverse inertia tensor. * * @param trans storage for the result (modified if not null) * @return a vector (either the provided storage or a new vector, not null) @@ -271,8 +271,8 @@ public class PhysicsRigidBody extends PhysicsCollisionObject { * Copy this body's orientation to a matrix. * * @param rot storage for the result (modified if not null) - * @return the orientation (either the provided storage or a new matrix, not - * null) + * @return the orientation (in physics-space coordinates, either the + * provided storage or a new matrix, not null) */ public Matrix3f getPhysicsRotationMatrix(Matrix3f rot) { if (rot == null) { @@ -473,7 +473,8 @@ public class PhysicsRigidBody extends PhysicsCollisionObject { /** * Copy this body's gravitational acceleration. * - * @return a new acceleration vector (not null) + * @return a new acceleration vector (in physics-space coordinates, not + * null) */ public Vector3f getGravity() { return getGravity(null); @@ -483,8 +484,8 @@ public class PhysicsRigidBody extends PhysicsCollisionObject { * Copy this body's gravitational acceleration. * * @param gravity storage for the result (modified if not null) - * @return an acceleration vector (either the provided storage or a new - * vector, not null) + * @return an acceleration vector (in physics-space coordinates, either the + * provided storage or a new vector, not null) */ public Vector3f getGravity(Vector3f gravity) { if (gravity == null) { @@ -619,7 +620,7 @@ public class PhysicsRigidBody extends PhysicsCollisionObject { /** * Copy this body's angular velocity. * - * @return a new velocity vector (not null) + * @return a new velocity vector (in physics-space coordinates, not null) */ public Vector3f getAngularVelocity() { Vector3f vec = new Vector3f(); @@ -632,7 +633,8 @@ public class PhysicsRigidBody extends PhysicsCollisionObject { /** * Copy this body's angular velocity. * - * @param vec storage for the result (not null, modified) + * @param vec storage for the result (in physics-space coordinates, not + * null, modified) */ public void getAngularVelocity(Vector3f vec) { getAngularVelocity(objectId, vec); @@ -653,7 +655,7 @@ public class PhysicsRigidBody extends PhysicsCollisionObject { /** * Copy the linear velocity of this body's center of mass. * - * @return a new velocity vector (not null) + * @return a new velocity vector (in physics-space coordinates, not null) */ public Vector3f getLinearVelocity() { Vector3f vec = new Vector3f(); @@ -666,7 +668,8 @@ public class PhysicsRigidBody extends PhysicsCollisionObject { /** * Copy the linear velocity of this body's center of mass. * - * @param vec storage for the result (not null, modified) + * @param vec storage for the result (in physics-space coordinates, not + * null, modified) */ public void getLinearVelocity(Vector3f vec) { getLinearVelocity(objectId, vec); @@ -691,7 +694,7 @@ public class PhysicsRigidBody extends PhysicsCollisionObject { * To apply an impulse, use applyImpulse, use applyContinuousForce to apply * continuous force. * - * @param force the force + * @param force the force (not null, unaffected) * @param location the location of the force */ public void applyForce(Vector3f force, Vector3f location) { @@ -708,7 +711,7 @@ public class PhysicsRigidBody extends PhysicsCollisionObject { * To apply an impulse, use * {@link #applyImpulse(com.jme3.math.Vector3f, com.jme3.math.Vector3f)}. * - * @param force the force + * @param force the force (not null, unaffected) */ public void applyCentralForce(Vector3f force) { applyCentralForce(objectId, force); @@ -724,7 +727,7 @@ public class PhysicsRigidBody extends PhysicsCollisionObject { * To apply an impulse, use * {@link #applyImpulse(com.jme3.math.Vector3f, com.jme3.math.Vector3f)}. * - * @param torque the torque + * @param torque the torque (not null, unaffected) */ public void applyTorque(Vector3f torque) { applyTorque(objectId, torque); @@ -736,8 +739,8 @@ public class PhysicsRigidBody extends PhysicsCollisionObject { /** * Apply an impulse to the body the next physics update. * - * @param impulse applied impulse - * @param rel_pos location relative to object + * @param impulse applied impulse (not null, unaffected) + * @param rel_pos location relative to object (not null, unaffected) */ public void applyImpulse(Vector3f impulse, Vector3f rel_pos) { applyImpulse(objectId, impulse, rel_pos); @@ -870,9 +873,9 @@ public class PhysicsRigidBody extends PhysicsCollisionObject { private native float getAngularSleepingThreshold(long objectId); /** - * Read the X-component of this body's angular factor. + * Read this body's angular factor for the X axis. * - * @return the X-component of the angular factor + * @return the angular factor */ public float getAngularFactor() { return getAngularFactor(null).getX(); @@ -882,7 +885,8 @@ public class PhysicsRigidBody extends PhysicsCollisionObject { * Copy this body's angular factors. * * @param store storage for the result (modified if not null) - * @return a vector (either the provided storage or a new vector, not null) + * @return the angular factor for each axis (either the provided storage or + * new vector, not null) */ public Vector3f getAngularFactor(Vector3f store) { // Done this way to prevent breaking the API. @@ -920,7 +924,7 @@ public class PhysicsRigidBody extends PhysicsCollisionObject { /** * Copy this body's linear factors. * - * @return a new vector (not null) + * @return the linear factor for each axis (not null) */ public Vector3f getLinearFactor() { Vector3f vec = new Vector3f(); diff --git a/jme3-bullet/src/main/java/com/jme3/bullet/objects/PhysicsVehicle.java b/jme3-bullet/src/main/java/com/jme3/bullet/objects/PhysicsVehicle.java index c59884102..541f68281 100644 --- a/jme3-bullet/src/main/java/com/jme3/bullet/objects/PhysicsVehicle.java +++ b/jme3-bullet/src/main/java/com/jme3/bullet/objects/PhysicsVehicle.java @@ -74,7 +74,7 @@ public class PhysicsVehicle extends PhysicsRigidBody { */ protected long rayCasterId = 0; /** - * tuning parameters + * tuning parameters applied when a wheel is created */ protected VehicleTuning tuning = new VehicleTuning(); /** @@ -615,7 +615,7 @@ public class PhysicsVehicle extends PhysicsRigidBody { * * @param vector storage for the result (modified if not null) * @return a direction vector (in physics-space coordinates, either the - * provided storage or a new vector) + * provided storage or a new vector, not null) */ public Vector3f getForwardVector(Vector3f vector) { if (vector == null) { diff --git a/jme3-bullet/src/main/java/com/jme3/bullet/objects/infos/RigidBodyMotionState.java b/jme3-bullet/src/main/java/com/jme3/bullet/objects/infos/RigidBodyMotionState.java index 51a7f4698..bee3bf78d 100644 --- a/jme3-bullet/src/main/java/com/jme3/bullet/objects/infos/RigidBodyMotionState.java +++ b/jme3-bullet/src/main/java/com/jme3/bullet/objects/infos/RigidBodyMotionState.java @@ -168,7 +168,7 @@ public class RigidBodyMotionState { * coordinates. * * @param applyPhysicsLocal true→match local coordinates, - * false→match world coordinates (default is false) + * false→match world coordinates (default=false) */ public void setApplyPhysicsLocal(boolean applyPhysicsLocal) { this.applyPhysicsLocal = applyPhysicsLocal; diff --git a/jme3-bullet/src/main/java/com/jme3/bullet/util/NativeMeshUtil.java b/jme3-bullet/src/main/java/com/jme3/bullet/util/NativeMeshUtil.java index fc3ad53d6..caf172c82 100644 --- a/jme3-bullet/src/main/java/com/jme3/bullet/util/NativeMeshUtil.java +++ b/jme3-bullet/src/main/java/com/jme3/bullet/util/NativeMeshUtil.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 2009-2012 jMonkeyEngine + * Copyright (c) 2009-2018 jMonkeyEngine * All rights reserved. * * Redistribution and use in source and binary forms, with or without @@ -39,18 +39,26 @@ import java.nio.ByteBuffer; import java.nio.FloatBuffer; /** + * A utility class for interfacing with Native Bullet. * * @author normenhansen */ public class NativeMeshUtil { + /** + * Pass a mesh to Native Bullet. + * + * @param mesh the JME mesh to pass (not null) + * @return the unique identifier of the resulting btTriangleIndexVertexArray + * (not 0) + */ public static long getTriangleIndexVertexArray(Mesh mesh){ ByteBuffer triangleIndexBase = BufferUtils.createByteBuffer(mesh.getTriangleCount() * 3 * 4); ByteBuffer vertexBase = BufferUtils.createByteBuffer(mesh.getVertexCount() * 3 * 4); int numVertices = mesh.getVertexCount(); - int vertexStride = 12; //3 verts * 4 bytes per. + int vertexStride = 12; //3 verts * 4 bytes each int numTriangles = mesh.getTriangleCount(); - int triangleIndexStride = 12; //3 index entries * 4 bytes each. + int triangleIndexStride = 12; //3 index entries * 4 bytes each IndexBuffer indices = mesh.getIndicesAsList(); FloatBuffer vertices = mesh.getFloatBuffer(Type.Position); @@ -72,6 +80,18 @@ public class NativeMeshUtil { return createTriangleIndexVertexArray(triangleIndexBase, vertexBase, numTriangles, numVertices, vertexStride, triangleIndexStride); } + /** + * Instantiate a btTriangleIndexVertexArray. Native method. + * + * @param triangleIndexBase index buffer (not null) + * @param vertexBase vertex buffer (not null) + * @param numTraingles the number of triangles in the mesh (≥0) + * @param numVertices the number of vertices in the mesh (≥0) + * @param vertextStride (in bytes, >0) + * @param triangleIndexStride (in bytes, >0) + * @return the unique identifier of the resulting btTriangleIndexVertexArray + * (not 0) + */ public static native long createTriangleIndexVertexArray(ByteBuffer triangleIndexBase, ByteBuffer vertexBase, int numTraingles, int numVertices, int vertextStride, int triangleIndexStride); }