source: code/branches/consolecommands/src/modules/overlays/hud/HUDRadar.cc @ 6333

/*
 *   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:
 *      Yuning Chai
 *      Felix Schulthess
 *   Co-authors:
 *      Reto Grieder
 *
 */

#include "HUDRadar.h"

#include <OgreOverlayManager.h>
#include <OgrePanelOverlayElement.h>

#include "util/Math.h"
#include "util/StringUtils.h"
#include "core/CoreIncludes.h"
#include "core/XMLPort.h"
#include "tools/TextureGenerator.h"
#include "worldentities/WorldEntity.h"
#include "worldentities/pawns/Pawn.h"

namespace orxonox
{
    CreateFactory(HUDRadar);

    HUDRadar::HUDRadar(BaseObject* creator)
        : OrxonoxOverlay(creator)
    {
        RegisterObject(HUDRadar);

        this->marker_ = static_cast<Ogre::PanelOverlayElement*>(Ogre::OverlayManager::getSingleton()
            .createOverlayElement("Panel", "HUDRadar_marker_" + getUniqueNumberString()));
        this->marker_->setMaterialName("Orxonox/RadarMarker");
        this->overlay_->add2D(this->marker_);
        this->marker_->hide();

        this->setRadarSensitivity(1.0f);
        this->setHalfDotSizeDistance(3000.0f);
        this->setMaximumDotSize(0.1f);

        this->shapeMaterials_[RadarViewable::Dot]      = "RadarDot.tga";
        this->shapeMaterials_[RadarViewable::Triangle] = "RadarTriangle.tga";
        this->shapeMaterials_[RadarViewable::Square]   = "RadarSquare.tga";

        this->owner_ = 0;
    }

    HUDRadar::~HUDRadar()
    {
        if (this->isInitialized())
        {
            Ogre::OverlayManager::getSingleton().destroyOverlayElement(this->marker_);
            for (std::vector<Ogre::PanelOverlayElement*>::iterator it = this->radarDots_.begin();
                it != this->radarDots_.end(); ++it)
            {
                Ogre::OverlayManager::getSingleton().destroyOverlayElement(*it);
            }
        }
    }

    void HUDRadar::XMLPort(Element& xmlElement, XMLPort::Mode mode)
    {
        SUPER(HUDRadar, XMLPort, xmlElement, mode);

        XMLPortParam(HUDRadar, "sensitivity", setRadarSensitivity, getRadarSensitivity, xmlElement, mode);
        XMLPortParam(HUDRadar, "halfDotSizeDistance", setHalfDotSizeDistance, getHalfDotSizeDistance, xmlElement, mode);
        XMLPortParam(HUDRadar, "maximumDotSize", setMaximumDotSize, getMaximumDotSize, xmlElement, mode);
    }

    void HUDRadar::displayObject(RadarViewable* object, bool bIsMarked)
    {
        if (object == static_cast<RadarViewable*>(this->owner_))
            return;

        const WorldEntity* wePointer = object->getWorldEntity();

        // Just to be sure that we actually have a WorldEntity.
        // We could do a dynamic_cast, but that would be a lot slower.
        if (!wePointer || !this->owner_)
        {
            if (!wePointer)
                CCOUT(2) << "Cannot display a non-WorldEntitiy on the radar" << std::endl;
            if (!this->owner_)
                CCOUT(2) << "No owner defined" << std::endl;
            return;
        }

        // try to find a panel already created
        Ogre::PanelOverlayElement* panel;
        //std::map<RadarViewable*, Ogre::PanelOverlayElement*>::iterator it = this->radarDots_.find(object);
        if (itRadarDots_ == this->radarDots_.end())
        {
            // we have to create a new entry
            panel = static_cast<Ogre::PanelOverlayElement*>(
                Ogre::OverlayManager::getSingleton().createOverlayElement("Panel", "RadarDot" + getUniqueNumberString()));
            radarDots_.push_back(panel);
            // get right material
            panel->setMaterialName(TextureGenerator::getMaterialName(
                shapeMaterials_[object->getRadarObjectShape()], object->getRadarObjectColour()));
            this->overlay_->add2D(panel);
            this->itRadarDots_ = this->radarDots_.end();
        }
        else
        {
            panel = *itRadarDots_;
            ++itRadarDots_;
            std::string materialName = TextureGenerator::getMaterialName(
                shapeMaterials_[object->getRadarObjectShape()], object->getRadarObjectColour());
            if (materialName != panel->getMaterialName())
                panel->setMaterialName(materialName);
        }
        panel->show();

        // set size to fit distance...
        float distance = (wePointer->getWorldPosition() - this->owner_->getPosition()).length();
        // calculate the size with 1/distance dependency for simplicity (instead of exp(-distance * lambda)
        float size = maximumDotSize_ * halfDotSizeDistance_ / (halfDotSizeDistance_ + distance);
        panel->setDimensions(size, size);

        // calc position on radar...
        Vector2 coord = get2DViewcoordinates(this->owner_->getPosition(), this->owner_->getOrientation() * WorldEntity::FRONT, this->owner_->getOrientation() * WorldEntity::UP, wePointer->getWorldPosition());
        coord *= Ogre::Math::PI / 3.5; // small adjustment to make it fit the texture
        panel->setPosition((1.0 + coord.x - size) * 0.5, (1.0 - coord.y - size) * 0.5);

        if (bIsMarked)
        {
            this->marker_->show();
            this->marker_->setDimensions(size * 1.5, size * 1.5);
            this->marker_->setPosition((1.0 + coord.x - size * 1.5) * 0.5, (1.0 - coord.y - size * 1.5) * 0.5);
        }
    }

    void HUDRadar::radarTick(float dt)
    {
        for (itRadarDots_ = radarDots_.begin(); itRadarDots_ != radarDots_.end(); ++itRadarDots_)
            (*itRadarDots_)->hide();
        this->itRadarDots_ = this->radarDots_.begin();
        this->marker_->hide();
    }

    void HUDRadar::changedOwner()
    {
        SUPER(HUDRadar, changedOwner);

        this->owner_ = orxonox_cast<Pawn*>(this->getOwner());
    }
}