UiWidget.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 <OgreColourValue.h>
#include <OgreString.h>
#include <Ogre.h>
#include <vector>
#include "ScriptManager.h"
#include "UiAnimation.h"
 
class UiWidget{
 
    public:
 
        UiWidget(const Ogre::String& name);
 
        UiWidget(const Ogre::String& name, const Ogre::String& path_name, UiWidget* parent);
 
        virtual ~UiWidget();
 
        void Initialise();
 
        virtual void Update();
 
        void OnResize();
 
        virtual void Render();
 
        void SetVisible(const bool visible);
 
        bool IsVisible() const;
 
        const Ogre::String& GetName() const;
 
        void AddChild(UiWidget* widget);
 
        UiWidget* GetChild(const Ogre::String& name);
 
        UiWidget* GetChild(const unsigned int id);
 
        unsigned int GetNumberOfChildren();
 
        void RemoveAllChildren();
 
        void AddAnimation(UiAnimation* animation);
 
        const Ogre::String& GetCurrentAnimationName() const;
 
        UiAnimation::State GetAnimationState() const;
 
        void PlayAnimation(
          const Ogre::String& animation, UiAnimation::State state,
          const float start, const float end
        );
 
        void ScriptPlayAnimation(const char* name);
 
        void ScriptPlayAnimationStop(const char* name);
 
        void ScriptPlayAnimation(const char* name, const float start, const float end);
 
        void ScriptPlayAnimationStop(const char* name, const float start, const float end);
 
        void ScriptSetDefaultAnimation(const char* animation);
 
        int ScriptAnimationSync();
 
        void SetUpdateTransformation();
 
        virtual void UpdateTransformation();
 
        enum Align{
 
            LEFT,
 
            RIGHT,
 
            CENTER
        };
 
        enum VerticalAlign{
 
            TOP,
 
            BOTTOM,
 
            MIDDLE
        };
 
        void SetAlign(const UiWidget::Align align);
 
        void SetVerticalAlign(const UiWidget::VerticalAlign valign);
 
        float GetFinalZ() const;
 
        Ogre::Vector2 GetFinalOrigin() const;
 
        Ogre::Vector2 GetFinalTranslate() const;
 
        Ogre::Vector2 GetFinalSize() const;
 
        Ogre::Vector2 GetFinalScale() const;
 
        Ogre::Vector4 GetFinalScissor(bool& scissor) const;
 
        float GetFinalRotation() const;
 
        void SetOriginX(const float percent, const float x);
 
        void SetOriginY(const float percent, const float y);
 
        void SetX(const float percent, const float x);
 
        void GetX(float& percent, float& x);
 
        void SetY(const float percent, const float y);
 
        void GetY(float& percent, float& y);
 
        void SetZ(const float z);
 
        void SetWidth(const float percent, const float width);
 
        void GetWidth(float& percent, float& width);
 
        void SetHeight(const float percent, const float height);
 
        void GetHeight(float& percent, float& height);
 
        void SetScale(const Ogre::Vector2& scale);
 
        void SetRotation(const float degree);
 
        void SetScissorArea(
          const float percent_x1, const float x1, const float percent_y1, const float y1,
          const float percent_x2, const float x2, const float percent_y2, const float y2
        );
 
        void SetGlobalScissor(const bool global);
 
        void SetColour(const float r, const float g, const float b);
 
        void SetColours(
          const float r1, const float g1, const float b1,
          const float r2, const float g2, const float b2,
          const float r3, const float g3, const float b3,
          const float r4, const float g4, const float b4
        );
 
        void SetAlpha(const float a);
 
        virtual void SetText(const char* text);
 
        virtual void SetImage(const char* image);
 
        float ScriptGetWidth();
 
        void ScriptSetWidth(float width);
 
        float ScriptGetHeight();
 
        void ScriptSetHeight(float height);
 
    protected:
 
        Ogre::String name_;
 
        Ogre::String path_name_;
 
        UiWidget* parent_;
 
        std::vector<UiWidget*> children_;
 
        float screen_width_;
 
        float screen_height_;
 
        bool visible_;
 
        Ogre::ColourValue colour_1_;
 
        Ogre::ColourValue colour_2_;
 
        Ogre::ColourValue colour_3_;
 
        Ogre::ColourValue colour_4_;
 
        Align align_;
 
        VerticalAlign vertical_align_;
 
        bool update_transformation_;
 
        Ogre::Vector2 final_origin_;
 
        Ogre::Vector2 final_translate_;
 
        float final_z_;
 
        Ogre::Vector2 final_size_;
 
        Ogre::Vector2 final_scale_;
 
        float final_rotation_;
 
        float origin_x_percent_;
 
        float origin_x_;
 
        float origin_y_percent_;
 
        float origin_y_;
 
        float x_percent_;
 
        float x_;
 
        float y_percent_;
 
        float y_;
 
        float z_;
 
        float width_percent_;
 
        float width_;
 
        float height_percent_;
 
        float height_;
 
        Ogre::Vector2 scale_;
 
        float rotation_;
 
        bool scissor_;
 
        bool local_scissor_;
 
        bool global_scissor_;
 
        int scissor_top_;
 
        float scissor_x_percent_top_;
 
        float scissor_x_top_;
 
        int scissor_bottom_;
 
        float scissor_x_percent_bottom_;
 
        float scissor_x_bottom_;
 
        int scissor_left_;
 
        float scissor_y_percent_left_;
 
        float scissor_y_left_;
 
        int scissor_right_;
 
        float scissor_y_percent_right_;
 
        float scissor_y_right_;
 
        UiAnimation* animation_current_;
 
        std::vector<ScriptId> animation_sync_;
 
        UiAnimation::State animation_state_;
 
        Ogre::String animation_default_;
 
        float animation_end_time_;
 
        std::vector<UiAnimation*> animations_;
 
    private:
 
        UiWidget();
};