Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/branches/doc/src/modules/objects/Planet.cc @ 7297

Last change on this file since 7297 was 7297, checked in by landauf, 14 years ago

fixed lots of Doxygen warnings

Note: Doxygen prints a warning if only a part of the parameters of a function are documented.

Added documentation for missing parameters (as good as I could), removed documentation of obsolete parameters and fixed names of renamed parameters.
Some parameters are tagged with "FIXME", please replace this with an appropriate documentation if you know what it does.

  • Property svn:eol-style set to native
File size: 6.2 KB
Line 
1/*
2 *   ORXONOX - the hottest 3D action shooter ever to exist
3 *                    > www.orxonox.net <
4 *
5 *
6 *   License notice:
7 *
8 *   This program is free software; you can redistribute it and/or
9 *   modify it under the terms of the GNU General Public License
10 *   as published by the Free Software Foundation; either version 2
11 *   of the License, or (at your option) any later version.
12 *
13 *   This program is distributed in the hope that it will be useful,
14 *   but WITHOUT ANY WARRANTY; without even the implied warranty of
15 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16 *   GNU General Public License for more details.
17 *
18 *   You should have received a copy of the GNU General Public License
19 *   along with this program; if not, write to the Free Software
20 *   Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
21 *
22 *   Author:
23 *      Marian Runo
24 *   Co-authors:
25 *      ...
26 *
27 */
28
29#include "Planet.h"
30
31#include <OgreEntity.h>
32#include <OgreBillboardSet.h>
33#include <OgreProgressiveMesh.h>
34
35#include "core/CoreIncludes.h"
36#include "core/GameMode.h"
37#include "core/XMLPort.h"
38#include "Scene.h"
39#include "graphics/Camera.h"
40#include "CameraManager.h"
41
42namespace orxonox
43{
44    CreateFactory(Planet);
45
46    /**
47     * @brief Constructor
48     */
49    Planet::Planet(BaseObject* creator) : MovableEntity(creator)
50    {
51        RegisterObject(Planet);
52        this->registerVariables();
53    }
54
55    /**
56     * @brief Destructor
57     */
58    Planet::~Planet()
59    {
60        if (this->isInitialized() && this->mesh_.getEntity())
61            this->detachOgreObject(this->mesh_.getEntity());
62    }
63
64    void Planet::tick(float dt)
65    {
66        if (!this->isVisible())
67            return;
68
69        if (GameMode::showsGraphics())
70        {
71            Camera* activeCamera = CameraManager::getInstance().getActiveCamera();
72            if (activeCamera && this->billboard_.getBillboardSet())
73            {
74                float distance = this->getPosition().distance( activeCamera->getWorldPosition() );
75                //             COUT(2) << distance << std::endl;
76                float planetRadius = this->getScale();
77
78                float newScale = 2 * distance / sqrt(distance*distance - planetRadius*planetRadius);
79                float tempTest = newScale*(1+float(this->atmosphereSize)/float(this->imageSize));
80                newScale = tempTest;
81
82                this->billboard_.getBillboardSet()->setDefaultDimensions(newScale, newScale);
83            }
84        }
85
86        SUPER(Planet, tick, dt);
87    }
88
89    void Planet::init()
90    {
91    }
92
93    void Planet::changedMesh()
94    {
95        if( GameMode::showsGraphics() )
96        {
97            if (this->mesh_.getEntity())
98                this->detachOgreObject(this->mesh_.getEntity());
99
100            this->mesh_.setMeshSource(this->getScene()->getSceneManager(), this->meshSrc_);
101
102            if (this->mesh_.getEntity())
103            {
104                this->attachOgreObject(this->mesh_.getEntity());
105                this->mesh_.getEntity()->setCastShadows(this->bCastShadows_);
106                this->mesh_.setVisible(this->isVisible());
107
108                float scaleFactor = this->getScale();
109
110    #if OGRE_VERSION >= 0x010700
111                Ogre::Mesh::LodValueList distList;
112    #else
113                Ogre::Mesh::LodDistanceList distList;
114    #endif
115
116                distList.push_back(10.0f*scaleFactor);
117                distList.push_back(19.0f*scaleFactor);
118                distList.push_back(27.0f*scaleFactor);
119                distList.push_back(34.0f*scaleFactor);
120                distList.push_back(40.0f*scaleFactor);
121                distList.push_back(45.0f*scaleFactor);
122                distList.push_back(49.0f*scaleFactor);
123                distList.push_back(52.0f*scaleFactor);
124                distList.push_back(54.0f*scaleFactor);
125                distList.push_back(55.0f*scaleFactor);
126
127                float reductionValue = 0.2f;
128
129                this->mesh_.getEntity()->getMesh()->generateLodLevels(distList, Ogre::ProgressiveMesh::VRQ_PROPORTIONAL, reductionValue);
130                billboard_.setBillboardSet(this->getScene()->getSceneManager(), this->atmosphere_, Vector3(0,0,0));
131
132                this->attachOgreObject(this->billboard_.getBillboardSet());
133                this->billboard_.getBillboardSet()->setUseAccurateFacing(true);
134                this->setCastShadows(true);
135                this->billboard_.getBillboardSet()->setRenderQueueGroup(this->mesh_.getEntity()->getRenderQueueGroup());
136                this->mesh_.setCastShadows(true);
137            }
138        }
139    }
140
141    void Planet::changedShadows()
142    {
143        this->mesh_.setCastShadows(this->bCastShadows_);
144    }
145
146    void Planet::XMLPort(Element& xmlelement, XMLPort::Mode mode)
147    {
148        SUPER(Planet, XMLPort, xmlelement, mode);
149
150        XMLPortParam(Planet, "atmosphere", setAtmosphere, getAtmosphere, xmlelement, mode).defaultValues("planet/Atmosphere");
151        XMLPortParam(Planet, "atmospheresize", setAtmosphereSize, getAtmosphereSize, xmlelement,mode);
152        XMLPortParam(Planet, "imagesize", setImageSize, getImageSize, xmlelement,mode);
153        XMLPortParam(Planet, "mesh", setMeshSource, getMeshSource, xmlelement, mode);
154        XMLPortParam(Planet, "shadow", setCastShadows, getCastShadows, xmlelement, mode).defaultValues(true);
155    }
156
157    void Planet::registerVariables()
158    {
159        registerVariable(this->atmosphere_, VariableDirection::ToClient);
160        registerVariable(this->atmosphereSize, VariableDirection::ToClient);
161        registerVariable(this->imageSize, VariableDirection::ToClient);
162        // Note: the meshSrc should be synchronised after atmosphere and other values, because the meshSrc callback setts the atmosphere billboards
163        registerVariable(this->meshSrc_, VariableDirection::ToClient, new NetworkCallback<Planet>(this, &Planet::changedMesh));
164        registerVariable(this->bCastShadows_, VariableDirection::ToClient, new NetworkCallback<Planet>(this, &Planet::changedShadows));
165    }
166
167    void Planet::changedVisibility()
168    {
169        SUPER(Planet, changedVisibility);
170        if (this->isInitialized())
171        {
172            this->mesh_.setVisible(this->isVisible());
173            this->billboard_.setVisible(this->isVisible());
174        }
175    }
176}
Note: See TracBrowser for help on using the repository browser.