Changeset 3598 in orxonox.OLD for orxonox/trunk/src/light.h

Timestamp:

Mar 18, 2005, 12:00:42 AM (20 years ago)

Author:

bensch

Message:

orxonox/trunk: doxygen-tags

File:

• orxonox/trunk/src/light.h (modified) (6 diffs)

orxonox/trunk/src/light.h

@@ -14 +14 @@
 #include "glincl.h"
 
-//! The maximum number of Lights this OpenGL-implementation supports
+//! The maximum number of Lights this OpenGL-implementation supports.
 #define NUMBEROFLIGHTS GL_MAX_LIGHTS
 
@@ -20 +20 @@
 class Vector;
 
-//! A struct that holds information about a Light
+//! A class that handles Lights. The LightManager operates on this.
 class Light : public WorldEntity
 {
  public:
   Light(int lightNumber);
-  ~Light(void);
+  virtual ~Light(void);
 
   void setPosition(Vector position);
@@ -35 +35 @@
   void setSpotCutoff(GLfloat cutoff);
 
+  Vector getPosition();
+  /** \returns the lightNumber*/
+  int getLightNumber(void) {return this->lightNumber;}
+  
   virtual void draw();
 
+  void debug(void);
+
   // attributes
-
+ private:
   int lightNumber;            //!< The number of this Light.
   GLfloat lightPosition[4];   //!< The Position of this Light.
@@ -48 +54 @@
   GLfloat spotDirection[4];   //!< The direction of the Spot Light.
   GLfloat spotCutoff;         //!< The cutoff Angle of the Light Source
-
-  void debug(void);
 };
 
@@ -81 +85 @@
   void setAmbientColor(GLfloat r, GLfloat g, GLfloat b);
 
+  void draw();
+
   //set Attributes
   void setPosition(Vector position);
@@ -92 +98 @@
   // get Attributes
   Vector getPosition(void);
-  /**
-     \returns the Position of Light 
-     \param lightNumber lightnumber
-  */
-  inline Vector getPosition(int lightNumber)
-    {
-      if (!this->lights[lightNumber])
-        return Vector(.0,.0,.0);
-      return Vector(this->lights[lightNumber]->lightPosition[0],
-                    this->lights[lightNumber]->lightPosition[1],
-                    this->lights[lightNumber]->lightPosition[2]);
-    }
-
+  Vector getPosition(int lightNumber);
+  
   void debug(void);
 };