Documented MatMath

Added notice of changes to greatest.h
Removed unnecessary install_name_tool call in makefile

ChangeLog

@@ -6,6 +6,7 @@
  OpenRaider (0.1.2) xythobuz <xythobuz@xythobuz.de>
 
 	[ 20140111 ]
+	* Documented MatMath, fixed bug in helRandomNum()
 	* Only one way of conversion between Deg and Rad in MatMath
 	* Use the same style of include guards in all headers
 	* Added memory test to SkeletalModel. Adding to OpenGLMesh causes

Makefile

@@ -365,9 +365,6 @@ Sound.test:
 	$(CC) $(TEST_FLAGS) \
 		-DUSING_OPENAL $(AUDIO_LIBS) $(AUDIO_DEFS) \
 		src/Sound.cpp test/Sound.cpp -o $(BUILD_TEST_DIR)/Sound.test
-ifeq ($(UNAME),Darwin)
-	install_name_tool -change libalut.0.1.0.dylib /opt/local/lib/libalut.0.1.0.dylib $(BUILD_TEST_DIR)/Sound.test
-endif
 
 #################################################################
 

include/MatMath.h

@@ -1,109 +1,81 @@
-/* -*- Mode: C++; tab-width: 3; indent-tabs-mode: t; c-basic-offset: 3 -*- */
-/*================================================================
+/*!
  *
- * Project : Freyja
- * Author  : Terry 'Mongoose' Hendrix II
- * Website : http://www.westga.edu/~stu7440/
- * Email   : stu7440@westga.edu
- * Object  :
- * License : No use w/o permission (C) 2002 Mongoose
- * Comments:
+ * \file include/MatMath.h
+ * \brief Vector and Matrix math
  *
- *
- *           This file was generated using Mongoose's C++
- *           template generator script.  <stu7440@westga.edu>
- *
- *-- History ------------------------------------------------
- *
- * 2002.05.11:
- * Mongoose - Created
- ================================================================*/
-
+ * \author Mongoose
+ */
 
 #ifndef _MATMATH_H
 #define _MATMATH_H
 
-#define HEL_PI           3.14159265358979323846  /* pi */
-#define HEL_PI_OVER_2    1.57079632679489661923  /* pi/2 */
-#define HEL_2_PI         6.28318530717958647692  /* pi*2 */
-#define HEL_PI_OVER_4    0.78539816339744830962  /* pi/4 */
-#define HEL_PI_OVER_180  0.017453292519943295    /* pi/180 */
-#define HEL_180_OVER_PI  57.295779513082323      /* 180/pi */
-
-#define HEL_RAD_TO_DEG(x) ((x) * HEL_180_OVER_PI)
-#define HEL_DEG_TO_RAD(x) ((x) * HEL_PI_OVER_180)
+#define HEL_PI           3.14159265358979323846 //!< pi
+#define HEL_PI_OVER_2    1.57079632679489661923 //!< pi/2
+#define HEL_2_PI         6.28318530717958647692 //!< pi*2
+#define HEL_PI_OVER_4    0.78539816339744830962 //!< pi/4
+#define HEL_PI_OVER_180  0.017453292519943295   //!< pi/180
+#define HEL_180_OVER_PI  57.295779513082323     //!< 180/pi
 
-typedef float vec_t;
-typedef float vec2_t[2];
-typedef float vec3_t[3];
-typedef float vec4_t[4];
-typedef vec_t matrix_t[16];  /* Used as _Column_major_ in every class now! */
+#define HEL_RAD_TO_DEG(x) ((x) * HEL_180_OVER_PI) //!< Convert radians to degrees
+#define HEL_DEG_TO_RAD(x) ((x) * HEL_PI_OVER_180) //!< Convert degrees to radians
 
+typedef float vec_t;        //!< 1D Vector, aka float
+typedef float vec2_t[2];    //!< 2D Vector
+typedef float vec3_t[3];    //!< 3D Vector
+typedef float vec4_t[4];    //!< 4D Vector
+typedef vec_t matrix_t[16]; //!< Used as _Column_major_ in every class now!
 
-int helIntersectionLineAndPolygon(vec3_t intersect,
-											 vec3_t p1, vec3_t p2,
-											 unsigned int vertexCount, vec3_t *ploygon);
-/*------------------------------------------------------
- * Pre  : Given P1 and P2 of line segment and
- *        Vertex count and ploygon with count vertices
- *
- *        Only supports triangles and coplanar quads
- *
- * Post : Returns intersect point or 0 if none
- *
- *-- History ------------------------------------------
- *
- * 2003.05.30:
- * Mongoose - Created
- ------------------------------------------------------*/
+/*!
+ * \brief Calculate Intersection of a line and a polygon
+ * \param intersect Where the intersection is stored, if it exists
+ * \param p1 First point of line segment
+ * \param p2 Second point of line segment
+ * \param vertexCount number of vertices in polygon
+ * \param polygon polygon vertex array
+ * \returns 0 if there is no intersection
+ */
+int helIntersectionLineAndPolygon(vec3_t intersect, vec3_t p1, vec3_t p2, unsigned int vertexCount, vec3_t *polygon);
 
+/*!
+ * \brief Calculate the distance from a sphere to a plane
+ * \param center Center of sphere
+ * \param radius Radius of sphere
+ * \param plane Plane
+ * \returns distance
+ */
 vec_t helDistToSphereFromPlane3v(vec3_t center,	vec_t radius, vec4_t plane);
-/*------------------------------------------------------
- * Pre  : Given center and radius of sphere and a plane
- * Post : Returns distance from sphere to plane
- *
- *-- History ------------------------------------------
- *
- * 1999.06.14:
- * Mongoose - Created, from mtk3d
- ------------------------------------------------------*/
 
+/*!
+ * \brief Calculate the distance from a box to a plane
+ * \param min Minimum Point of a bounding box
+ * \param max Maximum Point of a bounding box
+ * \param plane Plane
+ * \returns distance
+ */
 vec_t helDistToBboxFromPlane3v(vec3_t min, vec3_t max, vec4_t plane);
-/*------------------------------------------------------
- * Pre  : Given min and max points of a bounding box
- *        and a plane
- *
- * Post : Returns distance from box to plane
- *
- *-- History ------------------------------------------
- *
- * 1999.06.14:
- * Mongoose - Created, from mtk3d
- ------------------------------------------------------*/
 
+/*!
+ * \brief Calculate the length of a line segment / the distance between two points
+ * \param a First point
+ * \param b Second point
+ * \returns distance/length
+ */
 vec_t helDist3v(vec3_t a, vec3_t b);
-/*------------------------------------------------------
- * Pre  : Given point A and B
- * Post : Returns length of line segment
- *
- *-- History ------------------------------------------
- *
- * 1999.06.14:
- * Mongoose - Created, from mtk3d
- ------------------------------------------------------*/
 
+/*!
+ * \brief Calculates the midpoint between two points / of a line segment
+ * \param a First point
+ * \param b Second point
+ * \param mid Midpoint will be stored here
+ */
 void helMidpoint3v(vec3_t a, vec3_t b, vec3_t mid);
-/*------------------------------------------------------
- * Pre  : Given point A and B
- * Post : Returns midpoint of line segment
- *
- *-- History ------------------------------------------
- *
- * 1999.06.14:
- * Mongoose - Created, from mtk3d
- ------------------------------------------------------*/
-
 
+/*!
+ * \brief Calculates a pseudo-random number
+ * \param from Lower bound of resulting number
+ * \param to Upper bound
+ * \returns random number
+ */
 vec_t helRandomNum(vec_t from, vec_t to);
 
 #endif

src/MatMath.cpp

@@ -1,4 +1,10 @@
-/* -*- Mode: C++; tab-width: 3; indent-tabs-mode: t; c-basic-offset: 3 -*- */
+/*!
+ *
+ * \file src/MatMath.cpp
+ * \brief Vector and Matrix math
+ *
+ * \author Mongoose
+ */
 
 #include <stdlib.h>
 #include <math.h>
@@ -122,7 +128,7 @@ int helIntersectionOfAbstractSphereAndLine(vec3_t center, vec_t radius,
 
 int helIntersectionLineAndPolygon(vec3_t intersect,
 											 vec3_t p1, vec3_t p2,
-											 unsigned int vertexCount, vec3_t *ploygon)
+											 unsigned int vertexCount, vec3_t *polygon)
 {
 	//	vec3_t normal, a, b;
 	Vector3d a, b, normal, pA, pB;
@@ -134,22 +140,22 @@ int helIntersectionLineAndPolygon(vec3_t intersect,
 	pB = Vector3d(p2);
 
 	// Find normal
-	//mtkVectorSubtract(ploygon[1], ploygon[0], a);
-	a = Vector3d(ploygon[1]) - Vector3d(ploygon[0]);
-	//mtkVectorSubtract(ploygon[2], ploygon[0], b);
-	b = Vector3d(ploygon[2]) - Vector3d(ploygon[0]);
+	//mtkVectorSubtract(polygon[1], polygon[0], a);
+	a = Vector3d(polygon[1]) - Vector3d(polygon[0]);
+	//mtkVectorSubtract(polygon[2], polygon[0], b);
+	b = Vector3d(polygon[2]) - Vector3d(polygon[0]);
 	normal = Vector3d::cross(a, b);
 	//mtkVectorCrossProduct(a, b, normal);
 	normal.normalize();
 	//mtkVectorNormalize(normal, normal);
 
 	// find D
-	//d = (normal[0] * ploygon[0][0] -
-	//	  normal[1] * ploygon[0][1] -
-	//	  normal[2] * ploygon[0][2]);
-	d = (normal.mVec[0] * ploygon[0][0] -
-		  normal.mVec[1] * ploygon[0][1] -
-		  normal.mVec[2] * ploygon[0][2]);
+	//d = (normal[0] * polygon[0][0] -
+	//	  normal[1] * polygon[0][1] -
+	//	  normal[2] * polygon[0][2]);
+	d = (normal.mVec[0] * polygon[0][0] -
+		  normal.mVec[1] * polygon[0][1] -
+		  normal.mVec[2] * polygon[0][2]);
 
 	// line segment parallel to plane?
 	//mtkVectorSubtract(p2, p1, a); // cache p2 - p1 => a
@@ -182,11 +188,11 @@ int helIntersectionLineAndPolygon(vec3_t intersect,
 
 	// See if the intercept is bound by polygon by winding number
 #ifdef WINDING_NUMBERS_TRIANGLE
-	mtkVectorSubtract(ploygon[0], intersect, a);
+	mtkVectorSubtract(polygon[0], intersect, a);
 	mtkVectorNormalize(a, a);
-	mtkVectorSubtract(ploygon[1], intersect, b);
+	mtkVectorSubtract(polygon[1], intersect, b);
 	mtkVectorNormalize(b, b);
-	mtkVectorSubtract(ploygon[2], intersect, c);
+	mtkVectorSubtract(polygon[2], intersect, c);
 	mtkVectorNormalize(c, c);
 
 	t0 = mtkVectorDotProduct(a, b);
@@ -198,9 +204,9 @@ int helIntersectionLineAndPolygon(vec3_t intersect,
 	if (total - 360 < 0.0)
 		return 0;
 #else // assume convex polygons here for sure
-	//mtkVectorSubtract(intersect, ploygon[0], a);
+	//mtkVectorSubtract(intersect, polygon[0], a);
 	//theta = mtkVectorDotProduct(a, normal);
-	theta = Vector3d::dot(b - Vector3d(ploygon[0]), normal); // b = intersect
+	theta = Vector3d::dot(b - Vector3d(polygon[0]), normal); // b = intersect
 
 	if (theta >= 90.0) // Yeah I know
 		return 0;
@@ -285,6 +291,6 @@ vec_t helNorm2v(vec2_t v)
 
 vec_t helRandomNum(vec_t from, vec_t to)
 {
-	return from + (to*rand()/(RAND_MAX+1.0));
+	return from + ((to - from) * rand() / (RAND_MAX + 1.0));
 }
 

test/greatest.h

@@ -1,6 +1,9 @@
 /*
  * Copyright (c) 2011 Scott Vokes <vokes.s@gmail.com>
  *
+ * Modified 2014 by Thomas Buck <xythobuz@xythobuz.de>
+ * --> C++ support
+ *
  * Permission to use, copy, modify, and/or distribute this software for any
  * purpose with or without fee is hereby granted, provided that the above
  * copyright notice and this permission notice appear in all copies.
@@ -18,7 +21,7 @@
 #define GREATEST_H
 
 #ifdef __cplusplus
-#define __STDC_VERSION__ 19901L
+#define __STDC_VERSION__ 19901L // C++ compilers support var args
 extern "C"
 {
 #endif