SF.net SVN: openvrml:[4065] trunk

[<br...@us...>]

Revision: 4065
          http://openvrml.svn.sourceforge.net/openvrml/?rev=4065&view=rev
Author:   braden
Date:     2010-01-23 07:16:59 +0000 (Sat, 23 Jan 2010)

Log Message:
-----------
Move documentation concerning rotation normalization from openvrml::sfrotation to openvrml::rotation.

Modified Paths:
--------------
    trunk/ChangeLog
    trunk/src/libopenvrml/openvrml/basetypes.cpp
    trunk/src/libopenvrml/openvrml/field_value.cpp

Modified: trunk/ChangeLog
===================================================================
--- trunk/ChangeLog	2010-01-23 07:09:42 UTC (rev 4064)
+++ trunk/ChangeLog	2010-01-23 07:16:59 UTC (rev 4065)
@@ -1,5 +1,13 @@
 2010-01-23 Braden McDaniel  <br...@en...>
 
+	Move documentation concerning rotation normalization from
+	openvrml::sfrotation to openvrml::rotation.
+
+	* src/libopenvrml/openvrml/basetypes.cpp
+	* src/libopenvrml/openvrml/field_value.cpp
+
+2010-01-23 Braden McDaniel  <br...@en...>
+
 	Doxygen formatting improvements.
 
 	* doc/doxygen-header

Modified: trunk/src/libopenvrml/openvrml/basetypes.cpp
===================================================================
--- trunk/src/libopenvrml/openvrml/basetypes.cpp	2010-01-23 07:09:42 UTC (rev 4064)
+++ trunk/src/libopenvrml/openvrml/basetypes.cpp	2010-01-23 07:16:59 UTC (rev 4065)
@@ -2589,6 +2589,19 @@
  * VRML rotations are represented with four single-precision floating point
  * components. The first three are an axis of rotation, and the last is
  * rotation in radians.
+ *
+ * Per the VRML97 specification, the axis of a @c rotation is a normalized
+ * vector (5.8).  The specification leaves undefined how to deal with an
+ * attempt to construct a @c rotation from an axis vector that is not
+ * normalized.  In order to allow users of the library to minimize the number
+ * of normalizations, OpenVRML takes the following approach:
+ *
+ * - Attempts to construct a @c rotation axis from a vector that is not
+ *   normalized will yield an assertion failure (abort) unless @c NDEBUG is
+ *   defined when compiling the library (in which case truly wacky behavior
+ *   could result).
+ * - Assignment to individual components of the axis will result in the
+ *   axis being renormalized upon each assignment.
  */
 
 /**

Modified: trunk/src/libopenvrml/openvrml/field_value.cpp
===================================================================
--- trunk/src/libopenvrml/openvrml/field_value.cpp	2010-01-23 07:09:42 UTC (rev 4064)
+++ trunk/src/libopenvrml/openvrml/field_value.cpp	2010-01-23 07:16:59 UTC (rev 4065)
@@ -2274,20 +2274,20 @@
 /**
  * @class openvrml::sfrotation openvrml/field_value.h
  *
- * @brief A rotation node field value.
+ * @brief A %rotation node field value.
  *
- * Per the VRML97 specification, the axis of an sfrotation is a normalized
- * vector (5.8). The specification leaves undefined how to deal with an
- * attempt to construct an sfrotation from an axis vector that is not
- * normalized. In order to allow users of the library to minimize the number
+ * Per the VRML97 specification, the axis of an @c sfrotation is a normalized
+ * vector (5.8).  The specification leaves undefined how to deal with an
+ * attempt to construct an @c sfrotation from an axis vector that is not
+ * normalized.  In order to allow users of the library to minimize the number
  * of normalizations, openvrml takes the following approach:
  *
  * - Attempts to construct an sfrotation axis from a vector that is not
- *   normalized will yield an assertion failure (abort) unless NDEBUG is
+ *   normalized will yield an assertion failure (abort) unless @c NDEBUG is
  *   defined when compiling the library (in which case truly wacky behavior
  *   could result).
  * - Assignment to individual components of the axis will result in the
- *   axis being re-normalized upon each assignment.
+ *   axis being renormalized upon each assignment.
  *
  * @par Model of
  * @link openvrml::FieldValueConcept Field Value@endlink


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.