Changeset 159 for code/branches/main_reto_vs05/src/orxonox_scene.cc

Timestamp:

Nov 3, 2007, 11:06:43 PM (16 years ago)

Author:

rgrieder

Message:

 

File:

• code/branches/main_reto_vs05/src/orxonox_scene.cc (modified) (5 diffs)

code/branches/main_reto_vs05/src/orxonox_scene.cc

@@ -26 +26 @@
  */
 
+/**
+* The orxonox scene includes everything running in the background like terrain,
+* static figures, dangling lamp, etc.
+*/
+
+
 #include "orxonox_scene.h"
 
 
-OrxonoxScene::OrxonoxScene(SceneManager *mSceneMgr) : mSceneMgr(mSceneMgr)
+/**
+* Empty Consructor except the initialiser list.
+* @param sceneMgr The Scene Manager.
+*/
+OrxonoxScene::OrxonoxScene(SceneManager *sceneMgr) : sceneMgr_(sceneMgr)
 {
 }
 
-
+/**
+* Empty Destructor.
+*/
 OrxonoxScene::~OrxonoxScene()
 {
 }
 
-
+/**
+* Ogre initialisation method.
+* This function is called by the Run Manager to load the neccessary recources
+* and to create the scene.
+* @return False if failed.
+*/
 bool OrxonoxScene::initialise()
 {
@@ -44 +61 @@
         loadResources();
 
-        distance = 0;
-        radius = 100;
+        distance_ = 0;
+        radius_ = 100;
 
         createScene();
@@ -53 +70 @@
 
 
-// method where you can perform resource group loading
-// Must at least do
-// ResourceGroupManager::getSingleton().initialiseAllResourceGroups();
-void OrxonoxScene::loadResources(void)
+/**
+* Resource loader.
+* Currently, this method loads everything! TODO: If done this ugly, it should
+* at least be in the Run Manager.
+*/
+void OrxonoxScene::loadResources()
 {
         // Initialise, parse scripts etc
@@ -63 +82 @@
 
 
-// Currently just a test scene with an ogre head an a surrounding light
-void OrxonoxScene::createScene(void)
+/**
+* Scene creation.
+* Currently just a test scene with an ogre head an a surrounding light.
+*/
+void OrxonoxScene::createScene()
 {
-        mSceneMgr->setAmbientLight(ColourValue(0.3,0.3,0.3));
+        sceneMgr_->setAmbientLight(ColourValue(0.3,0.3,0.3));
 
         //create first entity
-        Entity *head = mSceneMgr->createEntity("head", "ogrehead.mesh");
+        Entity *head = sceneMgr_->createEntity("head", "ogrehead.mesh");
 
         //create a scene node to attach the head to
-        SceneNode *node = mSceneMgr->getRootSceneNode()
+        SceneNode *node = sceneMgr_->getRootSceneNode()
         ->createChildSceneNode("OgreHeadNode", Vector3(0,0,0));
         //attach the ogre head
@@ -78 +100 @@
 
         // set up skybox
-        mSceneMgr->setSkyBox(true, "Examples/SceneSkyBox2");
+        sceneMgr_->setSkyBox(true, "Examples/SceneSkyBox2");
 
-        // set up one mLight source
-        mLight = mSceneMgr->createLight("Light1");
-        mLight->setType(Light::LT_POINT);
-        mLight->setPosition(Vector3(0, 0, 0));
-        mLight->setDiffuseColour(1.0, 1.0, 1.0);
-        mLight->setSpecularColour(1.0, 1.0, 1.0);
+        // set up one light_ source
+        light_ = sceneMgr_->createLight("Light1");
+        light_->setType(Light::LT_POINT);
+        light_->setPosition(Vector3(0, 0, 0));
+        light_->setDiffuseColour(1.0, 1.0, 1.0);
+        light_->setSpecularColour(1.0, 1.0, 1.0);
 
         //create billboard
-        bbs = mSceneMgr->createBillboardSet("bb", 1);
-        bbs->createBillboard(Vector3::ZERO, ColourValue(1.0, 1.0, 1.0));
-        bbs->setMaterialName("Examples/Flare");
+        bbs_ = sceneMgr_->createBillboardSet("bb", 1);
+        bbs_->createBillboard(Vector3::ZERO, ColourValue(1.0, 1.0, 1.0));
+        bbs_->setMaterialName("Examples/Flare");
 
-        lightNode = mSceneMgr->getRootSceneNode()
-        ->createChildSceneNode("LightNode", Vector3(0, 100, 0));
+        lightNode_ = sceneMgr_->getRootSceneNode()
+        ->createChildSceneNode("lightNode_", Vector3(0, 100, 0));
 
-        lightNode->attachObject(bbs);
-        lightNode->attachObject(mLight);
+        lightNode_->attachObject(bbs_);
+        lightNode_->attachObject(light_);
 }
 
 
-// compute something between frames if neccessary
-void OrxonoxScene::tick(unsigned long time, float deltaTime)
+/**
+* Compute something between frames if neccessary.
+* @param time Absolute time.
+* @param deltaTime Relative time.
+* @return Return true to continue rendering.
+*/
+bool OrxonoxScene::tick(unsigned long time, Real deltaTime)
 {
-        float t = time/1000.0;
+        Real t = time/1000.0;
 
-        lightNode->setPosition(radius*sin(5*t), radius*cos(5*t), sin(1*t)*distance);
+        lightNode_->setPosition(radius_*sin(5*t), radius_*cos(5*t), sin(1*t)*distance_);
         
-        mLight->setDiffuseColour(sin(1*t), sin(1*t + 2.09), sin(1*t + 2.09*2));
-        mLight->setSpecularColour(sin(1*t), sin(1*t + 2.09), sin(1*t + 2.09*2));
+        light_->setDiffuseColour(sin(1*t), sin(1*t + 2.09), sin(1*t + 2.09*2));
+        light_->setSpecularColour(sin(1*t), sin(1*t + 2.09), sin(1*t + 2.09*2));
 
-        bbs->getBillboard(0)->setColour(ColourValue(sin(1*t),
+        bbs_->getBillboard(0)->setColour(ColourValue(sin(1*t),
         sin(1*t + 2.09), sin(1*t + 2.09*2)));
+  
+  return true;
 }