include/scene.h
branchpyrit
changeset 94 4c8abb8977dc
parent 93 96d65f841791
child 95 ca7d4c665531
--- a/include/scene.h	Tue May 06 09:39:58 2008 +0200
+++ b/include/scene.h	Thu May 08 09:21:25 2008 +0200
@@ -1,5 +1,6 @@
-/*
- * scene.h: classes for objects in scene
+/**
+ * @file  scene.h
+ * @brief Classes for objects in scene (other than shapes).
  *
  * This file is part of Pyrit Ray Tracer.
  *
@@ -36,12 +37,13 @@
 #include "quaternion.h"
 
 /**
- * ray
+ * A ray
  */
 class Ray
 {
 public:
-	Vector o, dir;
+	Vector o;   ///< Origin
+	Vector dir; ///< Normalized direction
 
 	Ray(): o(), dir() {};
 	Ray(const Vector &ao, const Vector &adir):
@@ -50,18 +52,20 @@
 
 #ifndef NO_SIMD
 /**
- * packet of 4 rays
+ * Packet of four rays for SIMD accelerated packet tracing.
  */
 class RayPacket
 {
 public:
-	VectorPacket o, dir, invdir;
+	VectorPacket o;      ///< Packet of four origins
+	VectorPacket dir;    ///< Directions
+	VectorPacket invdir; ///< Inverted directions (1/dir)
 
 	RayPacket(): o(), dir() {};
 	RayPacket(const VectorPacket &ao, const VectorPacket &adir):
 		o(ao), dir(adir), invdir(mOne/adir) {};
 
-	// index operator - get a ray
+	/** Index operator: get ray 'i' */
 	Ray operator[](int i) const
 	{
 		return Ray(
@@ -72,7 +76,7 @@
 #endif
 
 /**
- * a camera
+ * General camera
  */
 class Camera
 {