Changeset 3600 in orxonox.OLD

Timestamp:

Mar 18, 2005, 1:02:30 AM (19 years ago)

Author:

bensch

Message:

orxonox/trunk: nice doxygen-information about the LightManager

Location:

orxonox/trunk/src

Files:

• light.cc (modified) (5 diffs)
• light.h (modified) (3 diffs)

orxonox/trunk/src/light.cc

@@ -155 +155 @@
    \returns the Position of the Light
 */
-Vector Light::getPosition()
+Vector Light::getPosition() const
 {
   return Vector(this->lightPosition[0], this->lightPosition[1], this->lightPosition[2]);
@@ -172 +172 @@
    \brief Prints out some nice formated debug information about the Light
 */
-void Light::debug(void)
+void Light::debug(void) const
 {
   PRINT(0)(":: %d ::  -- reference %p\n", this->lightNumber, this);
@@ -461 +461 @@
    \returns the Position of the Light
 */
-Vector LightManager::getPosition(void)
+Vector LightManager::getPosition(void) const
 {
   if (!this->currentLight)
@@ -476 +476 @@
    \param lightNumber lightnumber
 */
-Vector LightManager::getPosition(int lightNumber)
+Vector LightManager::getPosition(int lightNumber) const
 {
   if (!this->lights[lightNumber])
@@ -487 +487 @@
 }
 
+/**
+   \returns a pointer to a Light
+   \param lightNumber The light to request the pointer from
+*/
+Light* LightManager::getLight(int lightNumber) const
+{
+  return this->lights[lightNumber];
+}
 
 /**
    \brief outputs debug information about the Class and its lights
 */
-void LightManager::debug(void)
+void LightManager::debug(void) const
 {
   PRINT(0)("=================================\n");

orxonox/trunk/src/light.h

@@ -35 +35 @@
   void setSpotCutoff(GLfloat cutoff);
 
-  Vector getPosition();
+  Vector getPosition() const;
   /** \returns the lightNumber*/
-  int getLightNumber(void) {return this->lightNumber;}
+  int getLightNumber(void) const {return this->lightNumber;}
   
   virtual void draw();
 
-  void debug(void);
+  void debug(void) const;
 
   // attributes
@@ -59 +59 @@
 /**
    A Light is a source that emits light rays (photons)
+
+   <b>Usage:</b>\n
+   First you have to get the Light Manager up and running by using LightManager::getInstance.
+   This automatically initiates the GL_LIGHTING, and sets some default stuff about the light.\n
+   Then you will create a new light using:
+   \li int addLight(void);
+   \li int addLight(int lightNumber);
+
+   now you can operate on the light as follows:
+   \li void setPosition(Vector position);
+   \li void setPosition(GLfloat x, GLfloat y, GLfloat z);
+   \li void setDiffuseColor(GLfloat r, GLfloat g, GLfloat b);
+   \li void setSpecularColor(GLfloat r, GLfloat g, GLfloat b);
+   \li void setAttenuation(float constantAttenuation, float linearAttenuation, float quadraticAttenuation);
+   \li void setSpotDirection(Vector direction);
+   \li void setSpotCutoff(GLfloat cutoff);
+
+   These functions are preatty selv-explaining, but you can read about them below.\n
+   If you want to fetch info, or the a Light use:
+   \li Vector getPosition(void) const;
+   \li Vector getPosition(int lightNumber) const;
+   \li Light* getLight(int LightNumber) const;
+
+   To redraw the light use
+   \li void draw();
+   
+   and to delete one just use
+   \li void deleteLight(void);
+
+   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);
+   \n
+   and then using the same functions on this to change settings.
 */
 class LightManager : public BaseObject
@@ -97 +133 @@
 
   // get Attributes
-  Vector getPosition(void);
-  Vector getPosition(int lightNumber);
+  Vector getPosition(void) const;
+  Vector getPosition(int lightNumber) const;
   
-  void debug(void);
+  Light* getLight(int lightNumber) const;
+  
+  void debug(void) const;
 };