From b9e19e076662ae5743b9c81eb238fe11204f6dbd Mon Sep 17 00:00:00 2001
From: Tavian Barnes <tavianator@gmail.com>
Date: Sun, 12 Apr 2009 19:06:50 +0000
Subject: Add some comments.

---
 libdimensionxx/dimensionxx/geometry.hpp | 15 ++++++++++++++-
 1 file changed, 14 insertions(+), 1 deletion(-)

(limited to 'libdimensionxx/dimensionxx/geometry.hpp')

diff --git a/libdimensionxx/dimensionxx/geometry.hpp b/libdimensionxx/dimensionxx/geometry.hpp
index 4295c05..78b9b49 100644
--- a/libdimensionxx/dimensionxx/geometry.hpp
+++ b/libdimensionxx/dimensionxx/geometry.hpp
@@ -21,12 +21,15 @@
 #ifndef DIMENSIONXX_GEOMETRY_HPP
 #define DIMENSIONXX_GEOMETRY_HPP
 
+// Wrappers for geometric types (Scalars, Vectors, Lines (rays)).
+
 #include <dimension.h>
 
 namespace Dimension
 {
-  typedef dmnsn_scalar Scalar;
+  typedef dmnsn_scalar Scalar; // This is really `double'
 
+  // Wrapper for dmnsn_vector
   class Vector
   {
   public:
@@ -37,10 +40,13 @@ namespace Dimension
     // Vector(const Vector& v);
     // ~Vector();
 
+    // Get the x, y, and z components.
     Scalar x() const { return m_vector.x; }
     Scalar y() const { return m_vector.y; }
     Scalar z() const { return m_vector.z; }
 
+    // Vector arithmetic
+
     // Vector& operator=(const Vector& rhs);
     Vector& operator+=(const Vector& rhs)
       { m_vector = dmnsn_vector_add(m_vector, rhs.m_vector); return *this; }
@@ -51,12 +57,14 @@ namespace Dimension
     Vector& operator/=(Scalar rhs)
       { m_vector = dmnsn_vector_div(m_vector, rhs); return *this; }
 
+    // Get the wrapped vector
     dmnsn_vector dmnsn() const { return m_vector; }
 
   private:
     dmnsn_vector m_vector;
   };
 
+  // Wrapper for dmnsn_line
   class line
   {
   public:
@@ -70,8 +78,11 @@ namespace Dimension
     Vector n()  const { return Vector(m_line.n); }
 
     // line& operator=(const line& l);
+
+    // Get the point `t' on the line (x0 + t*n)
     Vector operator()(Scalar t) { return Vector(dmnsn_line_point(m_line, t)); }
 
+    // Get the wrapped line
     dmnsn_line dmnsn() const { return m_line; }
 
   private:
@@ -120,12 +131,14 @@ namespace Dimension
     return r;
   }
 
+  // Dot product
   inline Scalar
   dot(const Vector& lhs, const Vector& rhs)
   {
     return dmnsn_vector_dot(lhs.dmnsn(), rhs.dmnsn());
   }
 
+  // Cross product
   inline Vector
   cross(const Vector& lhs, const Vector& rhs)
   {
-- 
cgit v1.2.3