From: Carsten Niehaus <cniehaus@gmx.de>
Date: Wed, 14 Jun 2006 16:59:18 +0000 (+0000)
Subject: * Add Benoit in the credit-section
X-Git-Tag: v3.80.3~103^2~62
X-Git-Url: https://git.rmz.fi/?a=commitdiff_plain;h=c8cdfbd086fd24eceeae5744af28c581715a48f6;p=libqmvoc.git

* Add Benoit in the credit-section
* Adding apidox and some compile warning-fixes
* Make use of the ui, well, the plugin still does not link and I have not the faintest idea why

svn path=/trunk/KDE/kdeedu/kalzium/src/kalziumglwidget.h; revision=551450
---

diff --git a/kalzium/kalziumglwidget.h b/kalzium/kalziumglwidget.h
index 49e2396..2e775f8 100644
--- a/kalzium/kalziumglwidget.h
+++ b/kalzium/kalziumglwidget.h
@@ -17,9 +17,10 @@
 #include <QGLWidget>
 #include <openbabel/mol.h>
 
-#define FLOAT	double
+#define USE_DOUBLE_PRECISION
 
-#if(FLOAT==double)
+#ifdef USE_DOUBLE_PRECISION
+#define FLOAT		double
 #define GLFLOAT		GLdouble
 #define GLTRANSLATE	glTranslated
 #define GLMULTMATRIX	glMultMatrixd
@@ -27,17 +28,22 @@
 #define COS		cos
 #define SIN		sin
 #define FABS		fabs
-#elif(FLOAT==float)
+#else
+#define FLOAT		float
 #define GLFLOAT		GLfloat
 #define GLTRANSLATE	glTranslatef
 #define GLMULTMATRIX	glMultMatrixf
-#define GLSUFFIX	f
 #define SQRT		sqrtf
 #define COS		cosf
 #define SIN		sinf
 #define FABS		fabsf
 #endif
 
+/**
+ * This is an abstract base class for a GL vertex array
+ *
+ * @author Benoit Jacob
+ */
 class GLVertexArray
 {
 	protected:
@@ -58,6 +64,11 @@ class GLVertexArray
 		void draw();
 };
 
+/**
+ * This class generates and stores a GL vertex array representing a sphere
+ *
+ * @author Benoit Jacob
+ */
 class SphereVertexArray : public GLVertexArray
 {
 	protected:
@@ -74,7 +85,7 @@ class SphereVertexArray : public GLVertexArray
 /**
  * This class displays the 3D-view of a molecule
  * 
- * @autor Benoit Jacob
+ * @author Benoit Jacob
  */
 class KalziumGLWidget : public QGLWidget
 {
@@ -83,8 +94,15 @@ class KalziumGLWidget : public QGLWidget
 	protected:
 		GLuint m_sphereDisplayList;
 		GLuint m_bondDisplayList;
+		
+		/**
+		 * equals true if the user is currently dragging (rotating)
+		 * the view
+		 */
 		bool m_isDragging;
+		
 		QPoint m_lastDraggingPosition;
+
 		GLFLOAT m_RotationMatrix[16];
 
 	public:
@@ -171,14 +189,15 @@ class KalziumGLWidget : public QGLWidget
 		 * The coefficient set by the user, determining the
 		 * radius of atoms.
 		 * 0.0 -> minimum radius -> "sticks-style" rendering
-		 * 1.0 -> maximum radius for which bonds are visible
+		 * 1.0 -> maximum radius for which all bonds are visible
 		 * values larger than 1.0 result in atoms so large
-		 * that they completely hide the bonds.
+		 * that they completely hide some bonds.
 		 */
 		float m_atomsRadiusCoeff;
 };
 
-// tests whether two FLOATs are equal
+// tests whether two FLOATs are approximately equal
+// this is a very vague approximation, it is enough for our needs here
 bool approx_equal( FLOAT a, FLOAT b );
 
 // compute the norm of a vector (dimension 3)