From abfc4d6c4580fb71a7563e8398f5636093a6afc5 Mon Sep 17 00:00:00 2001 From: "nor..67" Date: Wed, 22 Aug 2012 20:24:02 +0000 Subject: [PATCH] - add some javadoc to PhysicsRayTestResult git-svn-id: https://jmonkeyengine.googlecode.com/svn/trunk@9678 75d07b2b-3a1a-0410-a2c5-0572b91ccdca --- .../com/jme3/bullet/collision/PhysicsRayTestResult.java | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/engine/src/jbullet/com/jme3/bullet/collision/PhysicsRayTestResult.java b/engine/src/jbullet/com/jme3/bullet/collision/PhysicsRayTestResult.java index 1941344c3..744f1d64c 100644 --- a/engine/src/jbullet/com/jme3/bullet/collision/PhysicsRayTestResult.java +++ b/engine/src/jbullet/com/jme3/bullet/collision/PhysicsRayTestResult.java @@ -34,7 +34,8 @@ package com.jme3.bullet.collision; import com.jme3.math.Vector3f; /** - * Contains the results of a PhysicsSpace rayTest + * Contains the results of a PhysicsSpace rayTest. + * Read data only in callback method, object is reused * @author normenhansen */ public class PhysicsRayTestResult { @@ -55,20 +56,22 @@ public class PhysicsRayTestResult { } /** - * @return the collisionObject + * @return the PhysicsObject the ray collided with */ public PhysicsCollisionObject getCollisionObject() { return collisionObject; } /** - * @return the hitNormalLocal + * @return the normal of the collision in the objects local space */ public Vector3f getHitNormalLocal() { return hitNormalLocal; } /** + * The hitFraction is the fraction of the ray length (yeah, I know) at which the collision occurred. + * If e.g. the raytest was from 0,0,0 to 0,6,0 and the hitFraction is 0.5 then the collision occurred at 0,3,0 * @return the hitFraction */ public float getHitFraction() {