UiAnimation.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 <OgreString.h>
#include <Ogre.h>
#include <vector>
 
class UiWidget;
 
struct UiKeyFrameFloat{
 
    float time;
 
    float value;
};
 
struct UiKeyFrameVector2{
 
    float time;
 
    Ogre::Vector2 value;
};
 
class UiAnimation{
 
    public:
 
        UiAnimation(const Ogre::String& name, UiWidget* widget);
 
        virtual ~UiAnimation();
 
        enum State{
 
            DEFAULT,
 
            ONCE
        };
 
        void AddTime(const float time);
 
        const Ogre::String& GetName() const;
 
        void SetTime(const float time);
 
        float GetTime() const;
 
        void SetLength(const float time);
 
        float GetLength() const;
 
        void AddScaleKeyFrame(const UiKeyFrameVector2& key_frame);
 
        void AddXKeyFrame(const UiKeyFrameVector2& key_frame);
 
        void AddYKeyFrame(const UiKeyFrameVector2& key_frame);
 
        void AddWidthKeyFrame(const UiKeyFrameVector2& key_frame);
 
        void AddHeightKeyFrame(const UiKeyFrameVector2& key_frame);
 
        void AddRotationKeyFrame(const UiKeyFrameFloat& key_frame);
 
        void AddAlphaKeyFrame(const UiKeyFrameFloat& key_frame);
 
        void AddScissorKeyFrame(
          const UiKeyFrameVector2& x1, const UiKeyFrameVector2& y1,
          const UiKeyFrameVector2& x2, const UiKeyFrameVector2& y2
        );
 
    private:
 
        UiAnimation();
 
        float KeyFrameGetValue(std::vector<UiKeyFrameFloat>& data);
 
        Ogre::Vector2 KeyFrameGetValue(std::vector<UiKeyFrameVector2>& data);
 
        Ogre::String name_;
 
        UiWidget* widget_;
 
        float time_;
 
        float length_;
 
        std::vector<UiKeyFrameVector2> scale_;
 
        std::vector<UiKeyFrameVector2> x_;
 
        std::vector<UiKeyFrameVector2> y_;
 
        std::vector<UiKeyFrameVector2> width_;
 
        std::vector<UiKeyFrameVector2> height_;
 
        std::vector<UiKeyFrameFloat> rotation_;
 
        std::vector<UiKeyFrameFloat> alpha_;
 
        std::vector<UiKeyFrameVector2> scissor_x_top_;
 
        std::vector<UiKeyFrameVector2> scissor_y_left_;
 
        std::vector<UiKeyFrameVector2> scissor_x_bottom_;
 
        std::vector<UiKeyFrameVector2> scissor_y_right_;
};