Changeset 4738 in orxonox.OLD

Timestamp:

Jun 30, 2005, 1:29:59 AM (19 years ago)

Author:

bensch

Message:

orxonox/trunk: cleanup, renice, and other stuff (doxygen-tags, loadparam)

Location:

orxonox/trunk/src/lib/graphics

Files:

• light.cc (modified) (9 diffs)
• light.h (modified) (2 diffs)

orxonox/trunk/src/lib/graphics/light.cc

@@ -31 +31 @@
 CREATE_FACTORY(Light);
 
-//! Definition of the Lights
+//! Definition of the Lights and their Names
 int lightsV[] =
 {
@@ -46 +46 @@
 /**
  * \param root The XML-element to load the Light from
+
+  \todo what to do, if no Light-Slots are open anymore ???
  */
  Light::Light(const TiXmlElement* root)
 {
+  PRINTF(4)("initializing Light number %d.\n", this->lightNumber);
+
   this->lightNumber = LightManager::getInstance()->registerLight(this);
 
@@ -56 +60 @@
   this->setName(tmpName);
 
-  PRINTF(4)("initializing Light number %d.\n", this->lightNumber);
   // enable The light
   glEnable(lightsV[this->lightNumber]); // postSpawn
@@ -65 +68 @@
 
   this->loadParams(root);
-
 }
 
@@ -90 +92 @@
   LoadParam<Light>(root, "specular-color", this, &Light::setSpecularColor)
       .describe("sets the specular color of the Light (red [0-1], green [0-1], blue [0-1])");
+
+  LoadParam<Light>(root, "attenuation", this, &Light::setAttenuation)
+      .describe("sets the Attenuation of the LightSource (constant Factor, linear Factor, quadratic Factor).");
 
   LoadParam<Light>(root, "spot-direction", this, &Light::setSpotDirection)
@@ -176 +181 @@
    \brief draws this Light. Being a World-entity the possibility to do this lies at hand.
 */
-void Light::draw() const
+void Light::draw(void) const
 {
   float pos[4] = {this->getAbsCoor().x, this->getAbsCoor().y, this->getAbsCoor().z, 1.0};
@@ -290 +295 @@
 }
 
+/**
+  \param light the Light to register to the LightManager
+
+  This is done explicitely by the constructor of a Light
+*/
 int LightManager::registerLight(Light* light)
 {
@@ -302 +312 @@
 }
 
+/**
+  \param light The light to unregister from the LightManager
+
+  This is done every time a Light is destroyed explicitely by the Light-destructor
+ */
 void LightManager::unregisterLight(Light* light)
 {
@@ -347 +362 @@
         this->lights[i]->debug();
       }
-  PRINT(0)("--------------------------------\n");
-}
+  PRINT(0)("-----------------------------LM-\n");
+}

orxonox/trunk/src/lib/graphics/light.h

@@ -69 +69 @@
    \li new Light();
 
+   if you want to operate on this Light just apply the following functions onto it.
+       (You can also optain the Light-pointer with LightManager::getInstance()->getLight(lightNumber))
+
    now you can operate on the light as follows:
    \li void setDiffuseColor(GLfloat r, GLfloat g, GLfloat b);
@@ -78 +81 @@
 
    To redraw the light use
-   \li void draw() const;
-
-   and to delete one just use
-   \li void deleteLight(void);
+   \li void draw() const; (this is automatically done by the LightManager)
 
    for some nice output just use:
-   \li void debug(void) const;
-
-   You can also operate on the single Lights themselves, by first retreaving them with
-   \li Light* getLight(int LightNumber) const;
-   \n
-   and then using the same functions on this to change settings.
+   \li void debug(void) const; (either on LightManager for a resume or on any Light for single information.)
 */
 class LightManager : public BaseObject