Changeset 3416 in orxonox.OLD for orxonox/branches/dave/src/skysphere.cc

Timestamp:

Feb 21, 2005, 5:09:15 PM (19 years ago)

Author:

bensch

Message:

orxonox/branches/dave: injected Doxygen-tags

File:

• orxonox/branches/dave/src/skysphere.cc (modified) (5 diffs)

orxonox/branches/dave/src/skysphere.cc

@@ -1 +1 @@
 
-/* Created by Dave, this file is actually quite similar to player.cc and so is 
+/* 
+   orxonox - the future of 3D-vertical-scrollers
+
+   Copyright (C) 2004 orx
+
+   This program is free software; you can redistribute it and/or modify
+   it under the terms of the GNU General Public License as published by
+   the Free Software Foundation; either version 2, or (at your option)
+   any later version.
+
+   ### File Specific:
+   main-programmer: David Gruetter
+   co-programmer: ...
+
+
+    Created by Dave, this file is actually quite similar to player.cc and so is 
     skybox.h similar to player.h
     With that said, things should be clear:)
@@ -17 +32 @@
 using namespace std;
 
+/**
+   \brief Standart Constructor
+   \todo second Constructor with char* input for different skies
+*/
 Skysphere::Skysphere()
 {  
@@ -25 +44 @@
     sky->setDiffuseMap("../data/pictures/sky-replace.jpg");
     sky->setIllum(3);
+    //    sky->setAmbient(1,1,1);
 
 }
 
+/**
+   \brief default destructor
+*/
 Skysphere::~Skysphere()
 {
@@ -35 +58 @@
 }
 
+/**
+   \brief updates the position of the Skysphere
+   \param x the x-coordinate of the Center of the Sphere
+   \param y the y-coordinate of the Center of the Sphere
+   \param z the z-coordinate of the Center of the Sphere
+
+   This is normally done in the update-phase of world, so the Skysphere is always centered at the Camera.
+*/
 void Skysphere::updatePosition(float x,float y,float z)
 {
@@ -42 +73 @@
 }
 
+/**
+   \brief draws the Skysphere
 
+   This part is normally precessed in the "Painting Phase".
+*/
+   
 void Skysphere::draw()
 {