axmol/extensions/Particle3D/PU/PULineEmitter.h

/****************************************************************************
 Copyright (C) 2013 Henry van Merode. All rights reserved.
 Copyright (c) 2015-2016 Chukong Technologies Inc.
 Copyright (c) 2017-2018 Xiamen Yaji Software Co., Ltd.

 https://axmolengine.github.io/

 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.
 ****************************************************************************/

#ifndef __AX_PU_PARTICLE_3D_LINE_EMITTER_H__
#define __AX_PU_PARTICLE_3D_LINE_EMITTER_H__

#include "extensions/Particle3D/PU/PUEmitter.h"

NS_AX_BEGIN

struct PUParticle3D;
class AX_EX_DLL PULineEmitter : public PUEmitter
{
public:
    // Constants
    static const Vec3 DEFAULT_END;
    static const float DEFAULT_MIN_INCREMENT;
    static const float DEFAULT_MAX_INCREMENT;
    static const float DEFAULT_MAX_DEVIATION;

    static PULineEmitter* create();
    /**
     */
    virtual void notifyStart() override;

    /** Override the default implementation, to allow that no particles are emitted if there
        is an incremental emission of particles (along a path), and the end of the line has
        been reached.
    */
    virtual unsigned short calculateRequestedParticles(float timeElapsed) override;

    /**
     */
    float getMaxDeviation() const;
    void setMaxDeviation(float maxDeviation);

    /**
     */
    float getMaxIncrement() const;
    void setMaxIncrement(float maxIncrement);

    /**
     */
    float getMinIncrement() const;
    void setMinIncrement(float minIncrement);

    /** Get the end vector. This is the vector that defines the end of the line (in local space).
     */
    const Vec3& getEnd() const;

    /** Set the end vector.
     */
    void setEnd(const Vec3& end);

    /**
     */
    virtual void notifyRescaled(const Vec3& scale) override;

    /**
     */
    virtual void initParticlePosition(PUParticle3D* particle) override;

    /**
     */
    virtual void initParticleDirection(PUParticle3D* particle) override;

    virtual PULineEmitter* clone() override;
    virtual void copyAttributesTo(PUEmitter* emitter) override;

    PULineEmitter();
    virtual ~PULineEmitter(){};

protected:
    Vec3 _end;            // End point of the line (startpoint is determined by means of position)
    Vec3 _perpendicular;  // Generated unit vector perpendicular on the line
    float _maxDeviation;  // Determines how far from the line a particle is emitted.
    // This attribute defines the maximum value.
    float _minIncrement;  // Defines the minimum increment value.
    float _maxIncrement;  // If > 0, it defines the maximum (random) increment value that is
    // taken on the line traject. If not set, there is no particular
    // order in particle generation.
    float _increment;      // Defines the trajectory path along the line in terms of increments
    float _length;         // The length of the line
    bool _incrementsLeft;  // Indicates whether there are more increments on the path towards the end
    // of the line.
    bool _first;  // True when the first particle is emitted (only for generating particles incremental)

    // Internal scaled values
    Vec3 _scaledEnd;
    float _scaledMaxDeviation;
    float _scaledMinIncrement;
    float _scaledMaxIncrement;
    float _scaledLength;
};
NS_AX_END

#endif