Changeset 3446 in orxonox.OLD for orxonox/trunk/src

Timestamp:

Mar 2, 2005, 11:12:55 AM (20 years ago)

Author:

bensch

Message:

orxonox/trunk: light Comments/cleanup→ next step perfection

Location:

orxonox/trunk/src

Files:

• light.cc (modified) (4 diffs)
• light.h (modified) (4 diffs)

orxonox/trunk/src/light.cc

@@ -44 +44 @@
 /**
    \brief standard deconstructor
-   \todo this deconstructor is not jet implemented - do it
-
+   
+   first disables Lighting
+   then deletes all the lights
+   then deletes the rest of the allocated memory
+   and in the end sets the singleton Reference to zero.
 */
 Light::~Light () 
@@ -85 +88 @@
   // set default values
   this->currentLight->lightNumber = lightNumber;
-  this->setPosition(Vector(0.0, 0.0, 0.0));
+  this->setPosition(0.0, 0.0, 0.0);
   this->setDiffuseColor(1.0, 1.0, 1.0);
   this->setSpecularColor(1.0, 1.0, 1.0);
-  //  lmodelAmbient[] = {.1, .1, .1, 1.0};
 }
 
@@ -154 +156 @@
 /**
    \brief delete light.
-   \param lightnumber the number of the light to delete
+   \param lightNumber the number of the light to delete
 */
 void Light::deleteLight(int lightNumber)
@@ -188 +190 @@
 }
 
+/**
+   \brief Sets a Position for the Light.
+   \param x the x-coordinate
+   \param y the y-coordinate
+   \param z the z-coordinate
+*/
 void Light::setPosition(GLfloat x, GLfloat y, GLfloat z)
 {

orxonox/trunk/src/light.h

@@ -14 +14 @@
 #include "glincl.h"
 
+//! The maximum number of Lights this OpenGL-implementation supports
 #define NUMBEROFLIGHTS GL_MAX_LIGHTS
 
+//! Enumerator for the attenuation-Type.
+/**
+   CONSTANT means GL_CONSTANT_ATTENUATION
+   LINEAR means   GL_LINEAR_ATTENUATION
+   QUADRATIC means GL_QUADRATIC_ATTENUATION
+*/
 enum AttenuationType {CONSTANT, LINEAR, QUADRATIC};
 
@@ -33 +40 @@
     int lightNumber;            //!< The number of this Light.
     GLfloat lightPosition[4];   //!< The Position of this Light.
-    GLfloat lmodelAmbient[4];   //!< The general Ambient Color.
     GLfloat diffuseColor[4];    //!< The Diffuse Color this Light emmits.
     GLfloat specularColor[4];   //!< The specular Color of this Light.
@@ -47 +53 @@
 
   void init(int LightNumber);  
-  LightValue** lights;
-  LightValue* currentLight;
+  LightValue** lights;           //!< An array of Lenght NUMBEROFLIGHTS, that holds pointers to all LightValues.
+  LightValue* currentLight;      //!< The current Light, we are working with.
   
  public:
@@ -69 +75 @@
   // get Attributes
   Vector getPosition(void);
-  //! \returns the Position of Light \param lightNumber lightnumber
+  /**
+     \returns the Position of Light 
+     \param lightNumber lightnumber
+  */
   inline Vector getPosition(int lightNumber)
     {