UiTextArea.h

Go to the documentation of this file.

/*
 * Copyright (C) 2022 The V-Gears Team
 *
 * This file is part of V-Gears
 *
 * V-Gears is free software: you can redistribute it and/or modify it under
 * terms of the GNU General Public License as published by the Free Software
 * Foundation, version 3.0 (GPLv3) of the License.
 *
 * V-Gears 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.
 */
 
#pragma once
 
#include <OgreHardwareVertexBuffer.h>
#include <OgreRenderQueueListener.h>
#include <OgreRoot.h>
#include <Overlay/OgreUTFString.h>
#include <tinyxml.h>
 
#include "UiFont.h"
#include "UiWidget.h"
 
class UiSprite;
 
enum TextState{
 
    TS_SHOW_TEXT,
 
    TS_SCROLL_TEXT,
 
    TS_PAUSE_OK,
 
    TS_PAUSE_TIME,
 
    TS_DONE,
 
    TS_OVERFLOW,
 
    TS_NEXT_PAGE,
};
 
struct TextChar{
    TextChar():
      char_code(0),
      colour(Ogre::ColourValue::White),
      skip(false),
      variable(""),
      variable_len(0),
      pause_ok(false),
      pause_time(0.0f),
      next_page(false),
      sprite(NULL),
      sprite_y(0)
    {}
 
    int char_code;
 
    Ogre::ColourValue colour;
 
    bool skip;
 
    Ogre::String variable;
 
    unsigned int variable_len;
 
    bool pause_ok;
 
    float pause_time;
 
    bool next_page;
 
    UiSprite* sprite;
 
    float sprite_y;
};
 
struct TextVariable{
 
    Ogre::String name;
 
    Ogre::UTFString value;
};
 
 
class UiTextArea : public UiWidget{
 
    public:
 
        UiTextArea(const Ogre::String& name);
 
        UiTextArea(const Ogre::String& name, const Ogre::String& path_name, UiWidget* parent);
 
        virtual ~UiTextArea();
 
        void Initialise();
 
        virtual void Update();
 
        virtual void Render();
 
        virtual void UpdateTransformation();
 
        void UpdateGeometry();
 
        void InputPressed();
 
        void InputRepeated();
 
        enum TextAlign{
 
            LEFT,
 
            RIGHT,
 
            CENTER
        };
 
        void SetTextAlign(const TextAlign align);
 
        void SetPadding(const float top, const float right, const float bottom, const float left);
 
        void SetText(const Ogre::UTFString& text);
 
        void SetText(const char* text) override;
 
        void SetText(TiXmlNode* text);
 
        void TextClear();
 
        void RemoveSpritesFromText(const unsigned int end);
 
        void SetFont(const Ogre::String& font);
 
        const UiFont* GetFont() const;
 
        void SetTextPrintSpeed(const float speed);
 
        void SetTextScrollTime(const float time);
 
        void SetVariable(const Ogre::String& name, const Ogre::UTFString& value);
 
        Ogre::UTFString GetVariable(const Ogre::String& name) const;
 
        TextState GetTextState() const;
 
        float GetTextLimit() const;
 
        unsigned int GetTextSize() const;
 
        float GetPauseTime() const;
 
    private:
 
        float GetTextWidth() const;
 
        void PrepareTextFromNode(TiXmlNode* node, const Ogre::ColourValue& colour);
 
        void SetTextFromNode(TiXmlNode* node, const Ogre::ColourValue& colour);
 
        void PrepareTextFromText(const Ogre::UTFString& text, const Ogre::ColourValue& colour);
 
        UiTextArea();
 
        void CreateVertexBuffer();
 
        void DestroyVertexBuffer();
 
        Ogre::MaterialPtr material_;
 
        Ogre::SceneManager* scene_manager_;
 
        Ogre::RenderSystem* render_system_;
 
        unsigned int max_letters_;
 
        Ogre::RenderOperation render_operation_;
 
        Ogre::HardwareVertexBufferSharedPtr vertex_buffer_;
 
        UiFont* font_;
 
        TextAlign text_align_;
 
        std::vector<TextChar> text_;
 
        float text_limit_;
 
        float text_print_speed_;
 
        float text_print_speed_mod_;
 
        TextState text_state_;
 
        std::vector<TextVariable> text_variable_;
 
        float text_scroll_time_;
 
        float text_y_offset_;
 
        float text_y_offset_target_;
 
        float pause_time_;
 
        unsigned int next_page_start_;
 
        bool next_pressed_;
 
        bool next_repeated_;
 
        float padding_top_;
 
        float padding_right_;
 
        float padding_bottom_;
 
        float padding_left_;
 
        bool timer_;
 
        int timer_time_;
};