source: code/branches/objecthierarchy/src/orxonox/overlays/OverlayText.cc @ 2024

/*
 *   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 "OverlayText.h"

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

#include "util/String.h"
#include "core/CoreIncludes.h"
#include "core/XMLPort.h"

namespace orxonox
{
    CreateFactory(OverlayText);

    OverlayText::OverlayText(BaseObject* creator) : OrxonoxOverlay(creator), text_(0)
    {
        RegisterObject(OverlayText);
    }

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

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

        if (mode == XMLPort::LoadObject)
        {
            this->text_ = static_cast<Ogre::TextAreaOverlayElement*>(Ogre::OverlayManager::getSingleton()
                .createOverlayElement("TextArea", "OverlayText_text_" + getUniqueNumberString()));
            this->text_->setCharHeight(1.0);

            this->background_->addChild(this->text_);
        }

        XMLPortParam(OverlayText, "font",     setFont,            getFont,            xmlElement, mode).defaultValues("Monofur");
        XMLPortParam(OverlayText, "colour",   setColour,          getColour,          xmlElement, mode).defaultValues(ColourValue(1.0, 1.0, 1.0, 1.0));
        XMLPortParam(OverlayText, "caption",  setCaption,         getCaption,         xmlElement, mode).defaultValues("");
        XMLPortParam(OverlayText, "textSize", setTextSize,        getTextSize,        xmlElement, mode).defaultValues(1.0f);
        XMLPortParam(OverlayText, "align",    setAlignmentString, getAlignmentString, xmlElement, mode).defaultValues("left");
    }

    void OverlayText::setFont(const std::string& font)
    {
        if (this->text_ && font != "")
            this->text_->setFontName(font);
    }

    const std::string& OverlayText::getFont() const
    {
        if (this->text_)
            return this->text_->getFontName();
        else
            return BLANKSTRING;
    }

    void OverlayText::setColour(const ColourValue& colour)
    {
        if (this->text_)
            this->text_->setColour(colour);
    }

    const ColourValue& OverlayText::getColour() const
    {
        if (this->text_)
            return this->text_->getColour();
        else
            return ColourValue::White;
    }

    void OverlayText::setAlignment(Ogre::TextAreaOverlayElement::Alignment alignment)
    {
        if (this->text_)
            this->text_->setAlignment(alignment);
    }

    Ogre::TextAreaOverlayElement::Alignment OverlayText::getAlignment() const
    {
        if (this->text_)
            return this->text_->getAlignment();
        else
            return Ogre::TextAreaOverlayElement::Left;
    }

    void OverlayText::setAlignmentString(const std::string& alignment)
    {
        if (alignment == "right")
            this->setAlignment(Ogre::TextAreaOverlayElement::Right);
        else if (alignment == "center")
            this->setAlignment(Ogre::TextAreaOverlayElement::Center);
        else // "left" and default
            this->setAlignment(Ogre::TextAreaOverlayElement::Left);
    }

    std::string OverlayText::getAlignmentString() const
    {
        if (this->text_)
        {
            Ogre::TextAreaOverlayElement::Alignment alignment = this->text_->getAlignment();

            switch (alignment)
            {
                case Ogre::TextAreaOverlayElement::Right:
                    return "right";
                case Ogre::TextAreaOverlayElement::Center:
                    return "center";
                case Ogre::TextAreaOverlayElement::Left:
                default:;
            }
        }
        return "left";
    }

    void OverlayText::setCaption(const std::string& caption)
    {
        this->caption_ = caption;
        this->text_->setCaption(caption);
    }

    void OverlayText::sizeChanged()
    {
        if (!this->overlay_)
            return;

        if (this->rotState_ == Horizontal)
            this->overlay_->setScale(size_.y * sizeCorrection_.y, size_.y * sizeCorrection_.y);
        else if (this->rotState_ == Vertical)
            this->overlay_->setScale(size_.y / (sizeCorrection_.y * sizeCorrection_.y), size_.y * sizeCorrection_.y);
        else
            this->overlay_->setScale(size_.y, size_.y);

        positionChanged();
    }
}