axmol/core/2d/ProgressTimer.h

/****************************************************************************
Copyright (c) 2010      Lam Pham
Copyright (c) 2010-2012 cocos2d-x.org
Copyright (c) 2013-2016 Chukong Technologies Inc.
Copyright (c) 2017-2018 Xiamen Yaji Software Co., Ltd.
Copyright (c) 2019-present Axmol Engine contributors (see AUTHORS.md).

https://axmol.dev/

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
****************************************************************************/
#pragma once

#include "renderer/CustomCommand.h"
#include "2d/Node.h"
#include "renderer/PipelineDescriptor.h"

#include <vector>

namespace ax
{

class Sprite;

/**
 * @addtogroup _2d
 * @{
 */

/**
 * @brief ProgressTimer is a subclass of Node.
 * It renders the inner sprite according to the percentage.
 * The progress can be Radial, Horizontal or vertical.
 * @since v0.99.1
 */
class AX_DLL ProgressTimer : public Node
{
public:
    /** Types of progress
     * @since v0.99.1
     */
    enum class Type
    {
        RADIAL, /** Radial Counter-Clockwise. */
        BAR,    /** Bar. */
    };

    /** Creates a progress timer with the sprite as the shape the timer goes through.
     *
     * @param sp The sprite as the shape the timer goes through.
     * @return A ProgressTimer.
     */
    static ProgressTimer* create(Sprite* sp);

    /** Change the percentage to change progress.
     *
     * @return A Type
     */
    Type getType() const { return _type; }

    /** Percentages are from 0 to 100.
     *
     * @return Percentages.
     */
    float getPercentage() const { return _percentage; }

    /** The image to show the progress percentage, retain.
     *
     * @return A sprite.
     */
    Sprite* getSprite() const { return _sprite; }

    /** Set the initial percentage values.
     *
     * @param percentage The initial percentage values.
     */
    void setPercentage(float percentage);

    /** Set the sprite as the shape.
     *
     * @param sprite The sprite as the shape.
     */
    void setSprite(Sprite* sprite);

    /** Set the ProgressTimer type.
     *
     * @param type Is an Type.
     */
    void setType(Type type);

    /** Return the Reverse direction.
     *
     * @return If the direction is Anti-clockwise,it will return true.
     */
    bool isReverseDirection() { return _reverseDirection; };

    /** Set the Reverse direction.
     *
     * @param value If value is false it will clockwise,if is true it will Anti-clockwise.
     */
    void setReverseDirection(bool value);

    /**
     *    Midpoint is used to modify the progress start position.
     *    If you're using radials type then the midpoint changes the center point.
     *    If you're using bar type then the midpoint changes the bar growth.
     *        it expands from the center but clamps to the sprites edge so:
     *        you want a left to right then set the midpoint all the way to Vec2(0,y).
     *        you want a right to left then set the midpoint all the way to Vec2(1,y).
     *        you want a bottom to top then set the midpoint all the way to Vec2(x,0).
     *        you want a top to bottom then set the midpoint all the way to Vec2(x,1).
     * @param point A Vec2 point.
     */
    void setMidpoint(const Vec2& point);

    /** Returns the Midpoint.
     *
     * @return A Vec2.
     */
    Vec2 getMidpoint() const;

    /**
     *    This allows the bar type to move the component at a specific rate.
     *    Set the component to 0 to make sure it stays at 100%.
     *    For example you want a left to right bar but not have the height stay 100%.
     *    Set the rate to be Vec2(0,1); and set the midpoint to = Vec2(0,.5f).
     * @param barChangeRate A Vec2.
     */
    void setBarChangeRate(const Vec2& barChangeRate) { _barChangeRate = barChangeRate; }

    /** Returns the BarChangeRate.
     *
     * @return A barChangeRate.
     */
    Vec2 getBarChangeRate() const { return _barChangeRate; }

    // Overrides
    virtual void draw(Renderer* renderer, const Mat4& transform, uint32_t flags) override;
    virtual void setAnchorPoint(const Vec2& anchorPoint) override;
    virtual void setColor(const Color3B& color) override;
    virtual const Color3B& getColor() const override;
    virtual void setOpacity(uint8_t opacity) override;
    virtual uint8_t getOpacity() const override;
    virtual uint8_t getDisplayedOpacity() const override;

    /**
     * @js ctor
     */
    ProgressTimer() = default;
    /**
     * @js NA
     * @lua NA
     */
    virtual ~ProgressTimer();

    /** Initializes a progress timer with the sprite as the shape the timer goes through */
    bool initWithSprite(Sprite* sp);

protected:
    Tex2F textureCoordFromAlphaPoint(Vec2 alpha);
    Vec2 vertexFromAlphaPoint(Vec2 alpha);
    void updateProgress();
    void updateBar();
    void updateRadial();
    void updateDisplayedOpacity(uint8_t parentOpacity) override;
    void updateColor() override;
    Vec2 boundaryTexCoord(char index);

    Type _type = Type::RADIAL;
    Vec2 _midpoint;
    Vec2 _barChangeRate;
    float _percentage = 0.0f;
    Sprite* _sprite   = nullptr;
    std::vector<V2F_C4B_T2F> _vertexData;
    std::vector<unsigned short> _indexData;
    bool _reverseDirection = false;

    CustomCommand _customCommand;
    CustomCommand _customCommand2;

    backend::ProgramState* _programState2 = nullptr;

    backend::UniformLocation _locMVP1;
    backend::UniformLocation _locTex1;

    backend::UniformLocation _locMVP2;
    backend::UniformLocation _locTex2;

private:
    AX_DISALLOW_COPY_AND_ASSIGN(ProgressTimer);
};

// end of misc_nodes group
/// @}

}