From c9573ad511d85c9a28aadfead2767f9978cb6d38 Mon Sep 17 00:00:00 2001 From: Corey Richardson Date: Sun, 25 May 2014 03:04:44 -0700 Subject: [PATCH] Touch up the Plane docs --- src/cgmath/plane.rs | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/src/cgmath/plane.rs b/src/cgmath/plane.rs index eb3b5fa..adf9cd0 100644 --- a/src/cgmath/plane.rs +++ b/src/cgmath/plane.rs @@ -26,7 +26,7 @@ use vector::{Vector, EuclideanVector}; use partial_ord::PartOrdFloat; -/// A 3-dimensional plane formed from the equation: `a*x + b*y + c*z - d = 0`. +/// A 3-dimensional plane formed from the equation: `A*x + B*y + C*z - D = 0`. /// /// # Fields /// @@ -38,8 +38,8 @@ use partial_ord::PartOrdFloat; /// /// # Notes /// -/// The `a*x + b*y + c*z - d = 0` form is preferred over the other common -/// alternative, `a*x + b*y + c*z + d = 0`, because it tends to avoid +/// The `A*x + B*y + C*z - D = 0` form is preferred over the other common +/// alternative, `A*x + B*y + C*z + D = 0`, because it tends to avoid /// superfluous negations (see _Real Time Collision Detection_, p. 55). #[deriving(Clone, Eq)] pub struct Plane { @@ -49,7 +49,9 @@ pub struct Plane { impl> Plane { - /// Construct a plane from a normal vector and a scalar distance + /// Construct a plane from a normal vector and a scalar distance. The + /// plane will be perpendicular to `n`, and `d` units offset from the + /// origin. pub fn new(n: Vector3, d: S) -> Plane { Plane { n: n, d: d } }