source: code/branches/hud/src/orxonox/overlays/OrxonoxOverlay.cc @ 1614

/*
 *   ORXONOX - the hottest 3D action shooter ever to exist
 *                    > www.orxonox.net <
 *
 *
 *   License notice:
 *
 *   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
 *   of the License, or (at your option) any later version.
 *
 *   This program is distributed in the hope that it will be useful,
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *   GNU General Public License for more details.
 *
 *   You should have received a copy of the GNU General Public License
 *   along with this program; if not, write to the Free Software
 *   Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 *
 *   Author:
 *      Reto Grieder
 *   Co-authors:
 *      ...
 *
 */

#include "OrxonoxStableHeaders.h"
#include "OrxonoxOverlay.h"

#include <OgreOverlayManager.h>
#include <OgrePanelOverlayElement.h>
#include "util/Convert.h"
#include "core/CoreIncludes.h"
#include "GraphicsEngine.h"

namespace orxonox
{
  unsigned int OrxonoxOverlay::hudOverlayCounter_s = 0;

  OrxonoxOverlay::OrxonoxOverlay()
    : overlay_(0)
    , background_(0)
    , windowAspectRatio_(1.0f)
    , bCorrectAspect_(false)
    , size_(1.0f, 1.0f)
    , sizeCorrection_(1.0f, 1.0f)
    , angle_(0.0f)
    , position_(0.0f, 0.0f)
    , origin_(0.0f, 0.0f)
  {
    RegisterObject(OrxonoxOverlay);
  }

  OrxonoxOverlay::~OrxonoxOverlay()
  {
    if (this->background_)
      Ogre::OverlayManager::getSingleton().destroyOverlayElement(this->background_);
  }

  void OrxonoxOverlay::XMLPort(Element& xmlElement, XMLPort::Mode mode)
  {
    BaseObject::XMLPort(xmlElement, mode);

    if (mode == XMLPort::LoadObject)
    {
      overlay_ = Ogre::OverlayManager::getSingleton().create("OrxonoxOverlay"
            + convertToString(hudOverlayCounter_s++) + "_" + this->getName());

      this->windowResized(GraphicsEngine::getSingleton().getWindowWidth(),
            GraphicsEngine::getSingleton().getWindowHeight());

      // create background
      this->background_ = static_cast<Ogre::PanelOverlayElement*>(
          Ogre::OverlayManager::getSingleton().createOverlayElement("Panel", getUniqueNumberStr() + "_Background"));
      this->overlay_->add2D(this->background_);
    }

    XMLPortParam(OrxonoxOverlay, "correctAspect", setAspectCorrection, getAspectCorrection, xmlElement, mode);
    XMLPortParam(OrxonoxOverlay, "size", setSize, getUncorrectedSize, xmlElement, mode);
    XMLPortParam(OrxonoxOverlay, "rotation", setRotation, getRotation, xmlElement, mode);
    XMLPortParam(OrxonoxOverlay, "origin", setOrigin, getOrigin, xmlElement, mode);
    XMLPortParam(OrxonoxOverlay, "position", setPosition, getPosition, xmlElement, mode);
    XMLPortParam(OrxonoxOverlay, "background", setBackgroundMaterial, getBackgroundMaterial, xmlElement, mode);

    if (mode == XMLPort::LoadObject)
    {
      this->overlay_->show();
      if (!this->isVisible())
          this->overlay_->hide();

      this->sizeChanged();
      this->positionChanged();
      this->angleChanged();
    }
  }

  void OrxonoxOverlay::setBackgroundMaterial(const std::string& material)
  {
    if (this->background_ && material != "")
      this->background_->setMaterialName(material);
  }

  std::string OrxonoxOverlay::getBackgroundMaterial() const
  {
    if (this->background_)
      return this->background_->getMaterialName();
    else
      return "";
  }

  void OrxonoxOverlay::changedVisibility()
  {
    if (this->overlay_)
    {
      if (this->isVisible())
        this->overlay_->show();
      else
        this->overlay_->hide();
    }
  }

  void OrxonoxOverlay::windowResized(int newWidth, int newHeight)
  {
    this->windowAspectRatio_ = newWidth/(float)newHeight;

    this->setAspectCorrection(this->bCorrectAspect_);
  }

  void OrxonoxOverlay::setAspectCorrection(bool val)
  {
    if (val)
    {
      // note: this is only an approximation that is mostly valid when the
      // magnitude of the width is about the magnitude of the height.
      // Correctly we would have to take the square root of width*height
      this->sizeCorrection_.x = 2.0 / (this->windowAspectRatio_ + 1.0);
      this->sizeCorrection_.y = this->windowAspectRatio_ * this->sizeCorrection_.x;
    }
    else
    {
      this->sizeCorrection_ = Vector2::UNIT_SCALE;
    }

    this->bCorrectAspect_ = val;
    this->sizeChanged();
  }

  /**
    @remarks
      This function can be overriden by any derivative.
  */
  void OrxonoxOverlay::sizeChanged()
  {
    this->overlay_->setScale(size_.x * sizeCorrection_.x, size_.y * sizeCorrection_.y);
    positionChanged();
  }

  /**
    @remarks
      This function can be overriden by any derivative.
  */
  void OrxonoxOverlay::angleChanged()
  {
    this->overlay_->setRotate(this->angle_);
  }

  /**
    @remarks
      This function can be overriden by any derivative.
  */
  void OrxonoxOverlay::positionChanged()
  {
    Vector2 scroll = (position_ - 0.5 - size_ * sizeCorrection_ * (origin_ - 0.5)) * 2.0;
    this->overlay_->setScroll(scroll.x, -scroll.y);
  }
}