Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/branches/input/src/orxonox/overlays/OrxonoxOverlay.cc @ 1629

Last change on this file since 1629 was 1629, checked in by rgrieder, 16 years ago

updated input branch

  • Property svn:eol-style set to native
File size: 10.7 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 *      Reto Grieder
24 *   Co-authors:
25 *      ...
26 *
27 */
28
29/**
30@file
31@brief Definition of the OrxonoxOverlay class.
32*/
33
34#include "OrxonoxStableHeaders.h"
35#include "OrxonoxOverlay.h"
36
37#include <cmath>
38#include <OgreOverlay.h>
39#include <OgreOverlayManager.h>
40#include <OgrePanelOverlayElement.h>
41#include "util/Convert.h"
42#include "util/String.h"
43#include "core/CoreIncludes.h"
44#include "core/XMLPort.h"
45#include "core/ConsoleCommand.h"
46#include "GraphicsEngine.h"
47
48namespace orxonox
49{
50    unsigned int OrxonoxOverlay::hudOverlayCounter_s = 0;
51    std::map<std::string, OrxonoxOverlay*> OrxonoxOverlay::overlays_s;
52
53    SetConsoleCommand(OrxonoxOverlay, scaleOverlay, false).setAccessLevel(AccessLevel::User);
54    SetConsoleCommand(OrxonoxOverlay, scrollOverlay, false).setAccessLevel(AccessLevel::User);
55    SetConsoleCommand(OrxonoxOverlay, rotateOverlay, false).setAccessLevel(AccessLevel::User);
56
57    OrxonoxOverlay::OrxonoxOverlay()
58        : overlay_(0)
59        , background_(0)
60    {
61        RegisterObject(OrxonoxOverlay);
62    }
63
64    /**
65    @brief
66        Make sure everything gets removed/destroyed.
67    @remark
68        We assume that the Ogre::OverlayManager exists (there is an assert in Ogre for that!)
69    */
70    OrxonoxOverlay::~OrxonoxOverlay()
71    {
72        // erase ourself from the map with all overlays
73        std::map<std::string, OrxonoxOverlay*>::iterator it = overlays_s.find(this->getName());
74        if (it != overlays_s.end())
75            overlays_s.erase(it);
76
77        if (this->background_)
78            Ogre::OverlayManager::getSingleton().destroyOverlayElement(this->background_);
79        if (this->overlay_)
80            Ogre::OverlayManager::getSingleton().destroy(this->overlay_);
81    }
82
83    /**
84    @brief
85        Loads the OrxonoxOverlay.
86       
87        This has to be called before usage, otherwise strange behaviour is
88        guaranteed! (there should be no segfaults however).
89    @copydoc
90        BaseObject::XMLPort()
91    */
92    void OrxonoxOverlay::XMLPort(Element& xmlElement, XMLPort::Mode mode)
93    {
94        BaseObject::XMLPort(xmlElement, mode);
95
96        if (mode == XMLPort::LoadObject)
97        {
98            // add this overlay to the static map of OrxonoxOverlays
99            if (overlays_s.find(this->getName()) != overlays_s.end())
100            {
101                COUT(1) << "Overlay names should be unique or you cannnot access them via console." << std::endl;
102            }
103            overlays_s[this->getName()] = this;
104
105            // create the Ogre::Overlay
106            overlay_ = Ogre::OverlayManager::getSingleton().create("OrxonoxOverlay_overlay_"
107                + convertToString(hudOverlayCounter_s++));
108
109            // create background panel (can be used to show any picture)
110            this->background_ = static_cast<Ogre::PanelOverlayElement*>(
111                Ogre::OverlayManager::getSingleton().createOverlayElement("Panel",
112                "OrxonoxOverlay_background_" + convertToString(hudOverlayCounter_s++)));
113            this->overlay_->add2D(this->background_);
114
115            // We'll have to get the aspect ratio manually for the first time. Afterwards windowResized() gets
116            // called automatically by the GraphicsEngine.
117            this->windowResized(GraphicsEngine::getSingleton().getWindowWidth(),
118                GraphicsEngine::getSingleton().getWindowHeight());
119
120            this->changedVisibility();
121        }
122
123        XMLPortParam(OrxonoxOverlay, "size",      setSize,      getSize,      xmlElement, mode)
124            .defaultValues(Vector2(0.5f, 0.5f));
125        XMLPortParam(OrxonoxOverlay, "pickPoint", setPickPoint, getPickPoint, xmlElement, mode)
126            .defaultValues(Vector2(0.0f, 0.0f));
127        XMLPortParam(OrxonoxOverlay, "position",  setPosition,  getPosition,  xmlElement, mode)
128            .defaultValues(Vector2(0.0f, 0.0f));
129        XMLPortParam(OrxonoxOverlay, "rotation",  setRotation,  getRotation,  xmlElement, mode)
130            .defaultValues(0.0f);
131        XMLPortParam(OrxonoxOverlay, "correctAspect", setAspectCorrection,   getAspectCorrection,   xmlElement, mode)
132            .defaultValues(true);
133        XMLPortParam(OrxonoxOverlay, "background",    setBackgroundMaterial, getBackgroundMaterial, xmlElement, mode)
134            .defaultValues("");
135    }
136
137    //! Only sets the background material name if not ""
138    void OrxonoxOverlay::setBackgroundMaterial(const std::string& material)
139    {
140        if (this->background_ && material != "")
141            this->background_->setMaterialName(material);
142    }
143
144    //! Returns the the material name of the background
145    const std::string& OrxonoxOverlay::getBackgroundMaterial() const
146    {
147        if (this->background_)
148            return this->background_->getMaterialName();
149        else
150            return blankString;
151    }
152
153    //! Called by BaseObject when visibility has changed.
154    void OrxonoxOverlay::changedVisibility()
155    {
156        if (!this->overlay_)
157            return;
158
159        if (this->isVisible())
160            this->overlay_->show();
161        else
162            this->overlay_->hide();
163    }
164
165    /**
166    @brief
167        Called by the GraphicsEngine whenever the window size changes.
168        Calculates the aspect ratio only.
169    */
170    void OrxonoxOverlay::windowResized(int newWidth, int newHeight)
171    {
172        this->windowAspectRatio_ = newWidth/(float)newHeight;
173        this->sizeCorrectionChanged();
174    }
175
176    /**
177    @brief
178        Called whenever the rotation angle has changed.
179    */
180    void OrxonoxOverlay::angleChanged()
181    {
182        if (!this->overlay_)
183            return;
184
185        this->overlay_->setRotate(this->angle_);
186        this->sizeCorrectionChanged();
187    }
188
189    /**
190    @brief
191        Called whenever the aspect ratio or the angle has changed.
192        The method calculates a correction factor for the size to compensate
193        for aspect distortion if desired.
194    @remarks
195        This only works when the angle is about 0 or 90 degrees.
196    */
197    void OrxonoxOverlay::sizeCorrectionChanged()
198    {
199        if (this->bCorrectAspect_)
200        {
201            float angle = this->angle_.valueDegrees();
202            if (angle < 0.0)
203                angle = -angle;
204            angle -= 180.0 * (int)(angle / 180.0);
205
206            // take the reverse if angle is about 90 degrees
207            float tempAspect;
208            if (angle > 89.0 && angle < 91.0)
209                tempAspect = 1.0 / this->windowAspectRatio_;
210            else if (angle > 179 || angle < 1)
211                tempAspect = this->windowAspectRatio_;
212            else
213                tempAspect = 1.0;
214
215            // note: this is only an approximation that is mostly valid when the
216            // magnitude of the width is about the magnitude of the height.
217            // Correctly we would have to take the square root of width*height
218            this->sizeCorrection_.x = 2.0 / (tempAspect + 1.0);
219            this->sizeCorrection_.y = tempAspect * this->sizeCorrection_.x;
220        }
221        else
222        {
223            this->sizeCorrection_ = Vector2::UNIT_SCALE;
224        }
225
226        this->sizeChanged();
227    }
228
229    /**
230    @brief
231        Sets the overlay size using the actual corrected size.
232    */
233    void OrxonoxOverlay::sizeChanged()
234    {
235        if (!this->overlay_)
236            return;
237
238        this->overlay_->setScale(size_.x * sizeCorrection_.x, size_.y * sizeCorrection_.y);
239        positionChanged();
240    }
241
242    /**
243    @brief
244        Determines the position of the overlay.
245        This works also well when a rotation angle is applied. The overlay always
246        gets aligned correctly as well as possible.
247    */
248    void OrxonoxOverlay::positionChanged()
249    {
250        if (!this->overlay_)
251            return;
252
253        // transform the angle to a range of 0 - pi/2 first.
254        float angle = this->angle_.valueRadians();
255        if (angle < 0.0)
256            angle = -angle;
257        angle -= Ogre::Math::PI * (int)(angle / (Ogre::Math::PI));
258        if (angle > Ogre::Math::PI * 0.5)
259            angle = Ogre::Math::PI - angle;
260       
261        // do some mathematical fiddling for a bounding box
262        Vector2 actualSize = size_ * sizeCorrection_;
263        float radius = actualSize.length();
264        float phi = atan(actualSize.y / actualSize.x);
265        Vector2 boundingBox(radius * cos(angle - phi), radius * sin(angle + phi));
266
267        // calculate the scrolling offset
268        Vector2 scroll = (position_ - 0.5 - boundingBox * (pickPoint_ - 0.5)) * 2.0;
269        this->overlay_->setScroll(scroll.x, -scroll.y);
270    }
271
272
273    //########### Console commands ############
274
275    /**
276    @brief
277        Scales an overlay by its name.
278    @param name
279        The name of the overlay defined BaseObject::setName() (usually done with the "name"
280        attribute in the xml file).
281    */
282    /*static*/ void OrxonoxOverlay::scaleOverlay(const std::string& name, float scale)
283    {
284        std::map<std::string, OrxonoxOverlay*>::const_iterator it = overlays_s.find(name);
285        if (it != overlays_s.end())
286            (*it).second->scale(Vector2(scale, scale));
287    }
288
289    /**
290    @brief
291        Scrolls an overlay by its name.
292    @param name
293        The name of the overlay defined BaseObject::setName() (usually done with the "name"
294        attribute in the xml file).
295    */
296    /*static*/ void OrxonoxOverlay::scrollOverlay(const std::string& name, const Vector2& scroll)
297    {
298        std::map<std::string, OrxonoxOverlay*>::const_iterator it = overlays_s.find(name);
299        if (it != overlays_s.end())
300            (*it).second->scroll(scroll);
301    }
302
303    /**
304    @brief
305        Rotates an overlay by its name.
306    @param name
307        The name of the overlay defined BaseObject::setName() (usually done with the "name"
308        attribute in the xml file).
309    */
310    /*static*/ void OrxonoxOverlay::rotateOverlay(const std::string& name, const Degree& angle)
311    {
312        std::map<std::string, OrxonoxOverlay*>::const_iterator it = overlays_s.find(name);
313        if (it != overlays_s.end())
314            (*it).second->rotate(angle);
315    }
316}
Note: See TracBrowser for help on using the repository browser.