From 7ea2aa3644de40e68d00b1df25318e2424d1b13f Mon Sep 17 00:00:00 2001
From: Josh Holtrop <jholtrop+git@gmail.com>
Date: Fri, 17 Sep 2010 14:57:39 +0000
Subject: [PATCH] updated documentation for ag.pickObjects() and ag.pickOne()

git-svn-id: svn://anubis/anaglym/trunk@312 99a6e188-d820-4881-8870-2d33a10e2619
---
 doc/index.html | 28 ++++++++++++++++++++++++++++
 1 file changed, 28 insertions(+)

diff --git a/doc/index.html b/doc/index.html
index a3feb52..022c1d3 100644
--- a/doc/index.html
+++ b/doc/index.html
@@ -513,6 +513,34 @@ This function allows for 3D object "picking."
 "pick line" (the line from the camera through the "pick point" on the
 screen.
 Upon error, <tt>pickObjects</tt> returns <tt>nil</tt>.
+For each object in the "pick line", the following properties are set:
+<ul>
+    <li><tt>pick_dist</tt> - the distance to the object along the pick line</li>
+    <li><tt>pick_pos</tt> - the 3D coordinates of the pick point</li>
+    <li><tt>pick_normal</tt> - the normal of the object at the pick point</li>
+</ul>
+</p>
+
+<a name="ag_pickOne" />
+<h3>pickOne</h3>
+<p><tt>objects = ag.pickOne(x, y, obj)</tt></p>
+<p>
+This function allows for 3D object "picking," but only tests the given
+object for intersection with the pick line and is thus much more efficient
+than <a href="#ag_pickObjects">pickObjects()</a> if you only care about
+selecting on a given object.
+<tt>x</tt> and <tt>y</tt> should be the 2D screen coordinates of the
+"pick point."
+<tt>obj</tt> indicates which object to be tested.
+<tt>pickOne</tt> returns a boolean for whether or not the given object
+was hit by the "pick line."
+If the return value is <tt>true</tt>, then the following properties are
+set on <tt>obj</tt>:
+<ul>
+    <li><tt>pick_dist</tt> - the distance to the object along the pick line</li>
+    <li><tt>pick_pos</tt> - the 3D coordinates of the pick point</li>
+    <li><tt>pick_normal</tt> - the normal of the object at the pick point</li>
+</ul>
 </p>
 
 <a name="ag_print" />