axmol/core/2d/MotionStreak.h

/****************************************************************************
Copyright (c) 2011      ForzeField Studios S.L.
Copyright (c) 2010-2012 cocos2d-x.org
Copyright (c) 2013-2016 Chukong Technologies Inc.
Copyright (c) 2017-2018 Xiamen Yaji Software Co., Ltd.

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 "base/Protocols.h"
#include "2d/Node.h"
#include "renderer/CustomCommand.h"

NS_AX_BEGIN

class Texture2D;

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

/** @class MotionStreak.
 * @brief Creates a trailing path.
 */
class AX_DLL MotionStreak : public Node, public TextureProtocol
{
public:
    /** Creates and initializes a motion streak with fade in seconds, minimum segments, stroke's width, color, texture
     * filename.
     *
     * @param timeToFade The fade time, in seconds.
     * @param minSeg The minimum segments.
     * @param strokeWidth The width of stroke.
     * @param strokeColor The color of stroke.
     * @param imagePath The texture file name of stoke.
     * @return An autoreleased MotionStreak object.
     */
    static MotionStreak* create(float timeToFade,
                                float minSeg,
                                float strokeWidth,
                                const Color3B& strokeColor,
                                std::string_view imagePath);
    /** Creates and initializes a motion streak with fade in seconds, minimum segments, stroke's width, color, texture.
     *
     * @param timeToFade The fade time, in seconds.
     * @param minSeg The minimum segments.
     * @param strokeWidth The width of stroke.
     * @param strokeColor The color of stroke.
     * @param texture The texture name of stoke.
     * @return An autoreleased MotionStreak object.
     */
    static MotionStreak* create(float timeToFade,
                                float minSeg,
                                float strokeWidth,
                                const Color3B& strokeColor,
                                Texture2D* texture);

    // Overrides
    virtual void setPosition(const Vec2& position) override;
    virtual void setPosition(float x, float y) override;
    virtual const Vec2& getPosition() const override;
    virtual void getPosition(float* x, float* y) const override;
    virtual void setPositionX(float x) override;
    virtual void setPositionY(float y) override;
    virtual float getPositionX() const override;
    virtual float getPositionY() const override;
    virtual Vec3 getPosition3D() const override;
    /**
     * @js NA
     * @lua NA
     */
    virtual void draw(Renderer* renderer, const Mat4& transform, uint32_t flags) override;
    /**
     * @lua NA
     */
    virtual void update(float delta) override;
    virtual Texture2D* getTexture() const override;
    virtual void setTexture(Texture2D* texture) override;
    /**
     * @js NA
     * @lua NA
     */
    virtual void setBlendFunc(const BlendFunc& blendFunc) override;
    /**
     * @js NA
     * @lua NA
     */
    virtual const BlendFunc& getBlendFunc() const override;
    virtual uint8_t getOpacity() const override;
    virtual void setOpacity(uint8_t opacity) override;
    virtual void setOpacityModifyRGB(bool value) override;
    virtual bool isOpacityModifyRGB() const override;

    /** Color used for the tint.
     *
     * @param colors The color used for the tint.
     */
    void tintWithColor(const Color3B& colors);

    /** Remove all living segments of the ribbon.
     */
    void reset();

    /** When fast mode is enabled, new points are added faster but with lower precision.
     *
     * @return True if fast mode is enabled.
     */
    bool isFastMode() const { return _fastMode; }
    /** Sets fast mode or not.
     *
     * @param bFastMode True if enabled fast mode.
     */
    void setFastMode(bool bFastMode) { _fastMode = bFastMode; }
    /** Get stroke.
     *
     * @return float stroke.
     */
    float getStroke() const { return _stroke; }
    /** Set stroke.
     *
     * @param stroke The width of stroke.
     */
    void setStroke(float stroke) { _stroke = stroke; }

    /** Is the starting position initialized or not.
     *
     * @return True if the starting position is initialized.
     */
    bool isStartingPositionInitialized() const { return _startingPositionInitialized; }
    /** Sets the starting position initialized or not.
     *
     * @param bStartingPositionInitialized True if initialized the starting position.
     */
    void setStartingPositionInitialized(bool bStartingPositionInitialized)
    {
        _startingPositionInitialized = bStartingPositionInitialized;
    }

    bool setProgramState(backend::ProgramState* programState, bool ownPS = false) override;

    MotionStreak();
    virtual ~MotionStreak();

    /** initializes a motion streak with fade in seconds, minimum segments, stroke's width, color and texture filename
     */
    bool initWithFade(float fade, float minSeg, float stroke, const Color3B& color, std::string_view path);

    /** initializes a motion streak with fade in seconds, minimum segments, stroke's width, color and texture  */
    bool initWithFade(float fade, float minSeg, float stroke, const Color3B& color, Texture2D* texture);

protected:
    bool _fastMode                    = false;
    bool _startingPositionInitialized = false;

    /** texture used for the motion streak */
    Texture2D* _texture  = nullptr;
    BlendFunc _blendFunc = BlendFunc::ALPHA_NON_PREMULTIPLIED;
    Vec2 _positionR;

    float _stroke    = 0.f;
    float _fadeDelta = 0.f;
    float _minSeg    = 0.f;

    unsigned int _maxPoints        = 0;
    unsigned int _nuPoints         = 0;
    unsigned int _previousNuPoints = 0;

    /** Pointers */
    Vec2* _pointVertexes = nullptr;
    float* _pointState   = nullptr;

    Vec2* _vertices           = nullptr;
    uint8_t* _colorPointer    = nullptr;
    Tex2F* _texCoords         = nullptr;
    unsigned int _vertexCount = 0;

    CustomCommand _customCommand;

    backend::UniformLocation _mvpMatrixLocaiton;
    backend::UniformLocation _textureLocation;

private:
    AX_DISALLOW_COPY_AND_ASSIGN(MotionStreak);
};

// end of _2d group
/// @}

NS_AX_END