Ignore generated binaries.

[simgear.git] / simgear / math / vector.hxx

diff --git a/simgear/math/vector.hxx b/simgear/math/vector.hxx
index ef97e7de35af8134b0226c68bb00e8f11fb3e20d..e73b8d5fc68f56b29ca6d95acc69b56d6c8d2ffc 100644 (file)
--- a/simgear/math/vector.hxx
+++ b/simgear/math/vector.hxx
@@ -1,8 +1,11 @@
-// vector.hxx -- additional vector routines
-//
+/**
+ * \file vector.hxx
+ * Additional vector routines.
+ */
+
 // Written by Curtis Olson, started December 1997.
 //
-// Copyright (C) 1997  Curtis L. Olson  - curt@infoplane.com
+// Copyright (C) 1997  Curtis L. Olson  - http://www.flightgear.org/~curt
 //
 // This library is free software; you can redistribute it and/or
 // modify it under the terms of the GNU Library General Public
@@ -30,15 +33,18 @@
 # error This library requires C++
 #endif                                   
 
-#ifdef HAVE_CONFIG_H
-#  include <config.h>
-#endif
-
 #include <simgear/compiler.h>
 
 #include <plib/sg.h>
 
 
+/**
+ * Map a vector onto a plane.
+ * @param normal (in) normal vector for the plane
+ * @param v0 (in) a point on the plane
+ * @param vec (in) the vector to map onto the plane
+ * @param result (out) the result vector
+ */
 inline void sgmap_vec_onto_cur_surface_plane( sgVec3 normal, 
                                              sgVec3 v0, 
                                              sgVec3 vec,
@@ -84,6 +90,11 @@ inline void sgmap_vec_onto_cur_surface_plane( sgVec3 normal,
 }
 
 
+/**
+ * Copy and negate a vector.
+ * @param dst (out) result vector
+ * @param src (in) input vector
+ */
 inline void sgCopyNegateVec4( sgVec4 dst, sgVec4 src )
 {
        dst [ 0 ] = -src [ 0 ] ;
@@ -92,21 +103,64 @@ inline void sgCopyNegateVec4( sgVec4 dst, sgVec4 src )
        dst [ 3 ] = -src [ 3 ] ;
 }
 
-// Given a point p, and a line through p0 with direction vector d,
-// find the shortest distance (squared) from the point to the line
-double sgPointLineDistSquared( const sgVec3 p, const sgVec3 p0,
-                              const sgVec3 d );
-
-// Given a point p, and a line through p0 with direction vector d,
-// find the shortest distance (squared) from the point to the line
-double sgdPointLineDistSquared( const sgdVec3 p, const sgdVec3 p0,
-                               const sgdVec3 d );
-
-// This is same as
-// sgMakeMatTrans4( sgMat4 sgTrans, sgVec3 trans )
-// sgPostMultMat4( sgMat, sgTRANS );
+/**
+ * Given a point p, and a line through p0 with direction vector d,
+ * find the closest point (p1) on the line (float version).
+ * @param p1 (out) closest point to p on the line
+ * @param p (in) original point
+ * @param p0 (in) point on the line
+ * @param d (in) vector defining line direction
+ */
+void sgClosestPointToLine( sgVec3 p1, const sgVec3 p, const sgVec3 p0,
+                          const sgVec3 d );
+
+/**
+ * Given a point p, and a line through p0 with direction vector d,
+ * find the closest point (p1) on the line (double version).
+ * @param p1 (out) closest point to p on the line
+ * @param p (in) original point
+ * @param p0 (in) point on the line
+ * @param d (in) vector defining line direction
+ */
+void sgdClosestPointToLine( sgdVec3 p1, const sgdVec3 p, const sgdVec3 p0,
+                           const sgdVec3 d );
+
+/**
+ * Given a point p, and a line through p0 with direction vector d,
+ * find the shortest distance (squared) from the point to the line (float
+ * version.)
+ * @param p (in) original point
+ * @param p0 (in) point on the line
+ * @param d (in) vector defining line direction
+ * @return shortest distance (squared) from p to line
+ */
+double sgClosestPointToLineDistSquared( const sgVec3 p, const sgVec3 p0,
+                                       const sgVec3 d );
+
+/**
+ * Given a point p, and a line through p0 with direction vector d,
+ * find the shortest distance (squared) from the point to the line (double
+ * version.)
+ * @param p (in) original point
+ * @param p0 (in) point on the line
+ * @param d (in) vector defining line direction
+ * @return shortest distance (squared) from p to line
+ */
+double sgdClosestPointToLineDistSquared( const sgdVec3 p, const sgdVec3 p0,
+                                        const sgdVec3 d );
+
+/**
+ * This is same as:
+ *
+ * <li> sgMakeMatTrans4( sgMat4 sgTrans, sgVec3 trans )
+ * <li> sgPostMultMat4( sgMat4 src, sgTRANS );
+ *
+ * @param src starting sgMat4 matrix
+ * @param trans translation vector
+ */
 void sgPostMultMat4ByTransMat4( sgMat4 src, const sgVec3 trans );
 
+
 #endif // _VECTOR_HXX