Changeset 8793 in orxonox.OLD for trunk/src/lib/graphics/effects/fog_effect.cc

Timestamp:

Jun 26, 2006, 3:36:16 PM (19 years ago)

Author:

patrick

Message:

trunk: merged the weather engine branche to the trunk

File:

• trunk/src/lib/graphics/effects/fog_effect.cc (modified) (8 diffs)

trunk/src/lib/graphics/effects/fog_effect.cc

@@ -20 +20 @@
 #include "shell_command.h"
 
+// Define shell commands
 SHELL_COMMAND(activate, FogEffect, activateFog);
 SHELL_COMMAND(deactivate, FogEffect, deactivateFog);
@@ -25 +26 @@
 SHELL_COMMAND(fadeout, FogEffect, fadeOutFog);
 
-// TODO: Fix fades
-
 using namespace std;
 
 CREATE_FACTORY(FogEffect, CL_FOG_EFFECT);
 
+/**
+ * @brief standard constructor
+ */
 FogEffect::FogEffect(const TiXmlElement* root) {
     this->setClassID(CL_FOG_EFFECT, "FogEffect");
 
+    // Initialize values
     this->init();
 
+    // Load XML params
     if (root != NULL)
         this->loadParams(root);
 
+    // Activate fog, if chosen to be activated by default
     if (this->fogActivate)
         this->activate();
 }
 
-
+/**
+ * @brief standard destructor
+ */
 FogEffect::~FogEffect() {
     this->deactivate();
 }
 
-
+/**
+ * @brief initalizes the fog effect with default values
+ */
+void FogEffect::init() {
+    // default values
+  this->fogMode = GL_LINEAR;
+  this->fogDensity = 0.005;
+  this->fogStart = 0;
+  this->fogEnd = 300;
+  this->colorVector = Vector(0.6, 0.0, 0.0);
+
+    // init variables
+  this->fogFadeInDuration = 0;
+  this->fogFadeOutDuration = 0;
+  this->fogFadeDensity = 0;
+  this->fogFadeEnd = 0;
+
+  this->localTimer = 0;
+  this->fogActivate = false;
+  this->fogFadeInActivate = false;
+  this->fogFadeOutActivate = false;
+}
+
+/**
+ * @brief loads the fog effect parameters.
+ * @param root: the XML-Element to load the data from
+ */
 void FogEffect::loadParams(const TiXmlElement* root) {
     WeatherEffect::loadParams(root);
 
-    LoadParam(root, "mode", this, FogEffect, setFogMode);
-    LoadParam(root, "density", this, FogEffect, setFogDensity);
-    LoadParam(root, "range", this, FogEffect, setFogRange);
-    LoadParam(root, "color", this, FogEffect, setFogColor);
-    LoadParam(root, "fadeinduration", this, FogEffect, setFogFadeIn);
-    LoadParam(root, "fadeoutduration", this, FogEffect, setFogFadeOut);
+    LoadParam(root, "mode", this, FogEffect, setFogMode).describe("fog mode (linear, exponential)");;
+    LoadParam(root, "density", this, FogEffect, setFogDensity).describe("fog density if exp. fog");;
+    LoadParam(root, "range", this, FogEffect, setFogRange).describe("fog range: start, end");;
+    LoadParam(root, "color", this, FogEffect, setFogColor).describe("fog color: r,g,b");;
+    LoadParam(root, "fadeinduration", this, FogEffect, setFogFadeIn).describe("duration of the fade in");;
+    LoadParam(root, "fadeoutduration", this, FogEffect, setFogFadeOut).describe("duration of the fade out");;
 
     LOAD_PARAM_START_CYCLE(root, element);
     {
-        LoadParam_CYCLE(element, "option", this, FogEffect, setFogOption);
+      LoadParam_CYCLE(element, "option", this, FogEffect, setFogOption).describe("sets a fog option: activate");;
     }
     LOAD_PARAM_END_CYCLE(element);
 }
 
-void FogEffect::init() {
-    // default values
-    this->fogMode = GL_LINEAR;
-    this->fogDensity = 0.03;
-    this->fogStart = 0;
-    this->fogEnd = 50;
-    this->colorVector = Vector(0.3, 0.3, 0.3);
-
-    // init variables
-    this->fogFadeInDuration = 0;
-    this->fogFadeOutDuration = 0;
-    this->fogFadeDensity = 0;
-    this->localTimer = 0;
-    this->fogActivate = false;
-    this->fogFadeInActivate = false;
-    this->fogFadeOutActivate = false;
-
-}
-
-
+/**
+ * @brief activates the fog effect
+ */
 void FogEffect::activate() {
-    PRINTF(0)( "Enabling FogEffect, mode: %i, density: %f, start: %f, end: %f, color %f, %f, %f\n", this->fogMode, this->fogDensity, this->fogStart, this->fogEnd, this->colorVector.x, this->colorVector.y, this->colorVector.z);
-
-    this->fogActivate = true;
-
+    PRINTF(0)( "Activating FogEffect\n");
+
+    // init fogGL
     GLfloat fogColor[4] = { colorVector.x, colorVector.y, colorVector.z, 1.0};
     glFogi(GL_FOG_MODE, this->fogMode);
@@ -99 +114 @@
     glFogf(GL_FOG_END, this->fogEnd);
 
+    this->fogActivate = true;
+
     glEnable(GL_FOG);
-
-}
-
-
+}
+
+/**
+ * @brief deactivates the fog effect
+ */
 void FogEffect::deactivate() {
     PRINTF(0)("Deactivating FogEffect\n");
@@ -112 +130 @@
 
     glDisable(GL_FOG);
-
-}
-
+}
+
+/**
+ * @brief draws the fog effect
+ */
 void FogEffect::draw() const {
 
@@ -120 +140 @@
         return;
 
-    // If Fog Fade
-    if ( this->fogFadeInActivate || this->fogFadeOutActivate )
-        glFogf(GL_FOG_DENSITY, this->fogFadeDensity);
-
-}
-
+    // If fog is fading
+    if ( this->fogFadeInActivate || this->fogFadeOutActivate ) {
+        if ( this->fogMode == GL_LINEAR)
+            glFogf(GL_FOG_END, this->fogFadeEnd);
+        else
+            glFogf(GL_FOG_DENSITY, this->fogFadeDensity);
+    }
+}
+
+/**
+ * @brief ticks the fog effect
+ * @param dt: tick float
+ */
 void FogEffect::tick(float dt) {
+
     if (!this->fogActivate)
         return;
 
+    // If fog is fading in
     if ( this->fogFadeInActivate ) {
         this->localTimer += dt;
-        this->fogFadeDensity = ( this->localTimer / this->fogFadeInDuration ) * this->fogDensity;
-
-        if ( this->localTimer >= this->fogFadeOutDuration )
+
+        if ( this->fogMode == GL_LINEAR)
+          this->fogFadeEnd = 2000 * (1 - ( this->localTimer / this->fogFadeInDuration )) + this->fogEnd;
+        else
+            this->fogFadeDensity = ( this->localTimer / this->fogFadeInDuration ) * this->fogDensity;
+
+        if ( this->localTimer >= this->fogFadeInDuration )
             this->fogFadeInActivate = false;
     }
 
+    // If fog is fading out
     if ( this->fogFadeOutActivate ) {
         this->localTimer += dt;
-        this->fogFadeDensity = 1 - (( this->localTimer / this->fogFadeInDuration ) * this->fogDensity);
+
+        if ( this->fogMode == GL_LINEAR)
+          this->fogFadeEnd = 2000 * ( this->localTimer / this->fogFadeInDuration ) + this->fogEnd;
+        else
+            this->fogFadeDensity = 1 - (( this->localTimer / this->fogFadeInDuration ) * this->fogDensity);
 
         if ( this->localTimer >= this->fogFadeOutDuration )
@@ -147 +185 @@
 }
 
+/**
+ * @brief fades the fog in
+ */
 void FogEffect::fadeInFog() {
 
@@ -163 +204 @@
     this->localTimer = 0;
 
+    // Activate Fog
+    this->activate();
+
     // set FogFadeIn activate
     this->fogFadeInActivate = true;
-
-    // Activate Fog
-    this->activate();
-
-}
-
-
+}
+
+/**
+ * @brief fades the fog out
+ */
 void FogEffect::fadeOutFog() {
 
@@ -190 +232 @@
     // Reset local timer
     this->localTimer = 0;
-
-}
-
-
-GLint FogEffect::stringToFogMode(const std::string& mode) {
-    if(mode == "GL_LINEAR")
-        return GL_LINEAR;
-    else if(mode == "GL_EXP")
-        return GL_EXP;
-    else if(mode == "GL_EXP2" )
-        return GL_EXP2;
-    else
-        return -1;
-}
-
-
+}
+