axmol/extensions/Particle3D/PU/CCPUParticleSystem3D.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_SYSTEM_3D_H__
#define __AX_PU_PARTICLE_SYSTEM_3D_H__

#include "2d/CCNode.h"
#include "base/CCProtocols.h"
#include "math/CCMath.h"
#include "extensions/Particle3D/CCParticleSystem3D.h"
#include <vector>
#include <map>

NS_AX_BEGIN

/**
 * 3d particle system
 */
class PUListener;
class PUObserver;
class PUBehaviour;
class PUEmitter;
class PUAffector;
class Particle3DRender;

enum PUComponentType
{
    CT_PARTICLE,
    CT_SYSTEM,
    CT_TECHNIQUE,
    CT_EMITTER,
    CT_AFFECTOR,
    CT_OBSERVER
};

struct AX_EX_DLL PUParticle3D : public Particle3D
{
    static float DEFAULT_TTL;
    static float DEFAULT_MASS;

    PUParticle3D();
    virtual ~PUParticle3D();

    typedef std::vector<PUBehaviour*> ParticleBehaviourList;

    enum ParticleType
    {
        PT_VISUAL,
        PT_TECHNIQUE,
        PT_EMITTER,
        PT_AFFECTOR,
        PT_SYSTEM,
    };

    /** Enumeration which lists a number of reserved event flags. Although custom flags can be used to
    indicate that a certain condition occurs, the first number of flags may not be used as custom flags.
*/
    enum ReservedParticleEventFlags
    {
        PEF_EXPIRED  = 1 << 0,
        PEF_EMITTED  = 1 << 1,
        PEF_COLLIDED = 1 << 2
    };

    Ref* particleEntityPtr;
    PUEmitter* parentEmitter;

    Ref* visualData;

    ParticleType particleType;
    // Values that are assigned as soon as the particle is emitted (non-transformed)
    // Vec3 positionInWorld;
    Vec3 originalPosition;
    Vec3 latestPosition;
    // Direction (and speed)
    Vec3 direction;
    Vec3 originalDirection;
    float originalDirectionLength;  // Length of the direction that has been set
    float originalVelocity;
    float originalScaledDirectionLength;  // Length of the direction after multiplication with the velocity

    /** The rotation axis is used in combination with orientation. Because the rotation axis is part
        of the particle itself, it can be changed independently. */
    Vec3 rotationAxis;
    /** Current and original colour */

    Vec4 originalColor;

    /** The zRotationSpeed is used in combination with zRotation and defines tha actual rotationspeed
        in 2D. */
    float zRotationSpeed;  // radian

    // Quaternion orientationInWorld;
    /*@remarks
        The orientation of the particle is only visible if the Particle Renderer - such as the Box renderer -
        supports orientation.
    */
    Quaternion originalOrientation;

    /** The rotation is used in combination with orientation. Because the rotation speed is part
        of the particle itself, it can be changed independently. */
    float rotationSpeed;

    /** Radius of the particle, to be used for inter-particle collision and such.
     */
    float radius;

    ParticleBehaviourList behaviours;
    void copyBehaviours(const ParticleBehaviourList& list);

    float calculateVelocity() const;

    /** Set own dimensions
     */
    void setOwnDimensions(float newWidth, float newHeight, float newDepth);
    void calculateBoundingSphereRadius();

    void initForEmission();
    void initForExpiration(float timeElapsed);
    void process(float timeElapsed);

    /** Does this particle have it's own dimensions? */
    bool ownDimensions;

    /** Sets the event flags.
     */
    void setEventFlags(unsigned int flags) { eventFlags = flags; }

    /** As setEventFlags, except the flags passed as parameters are appended to the
        existing flags on this object.
    */
    void addEventFlags(unsigned int flags) { eventFlags |= flags; }

    /** The flags passed as parameters are removed from the existing flags.
     */
    void removeEventFlags(unsigned int flags) { eventFlags &= ~flags; }

    /** Return the event flags.
     */
    unsigned int getEventFlags() const { return eventFlags; }

    /** Determines whether it has certain flags set.
     */
    bool hasEventFlags(unsigned int flags) const { return (eventFlags & flags) != 0; }

    unsigned int eventFlags;

    bool isFreezed() const { return freezed; }
    //-----------------------------------------------------------------------
    void setFreezed(bool fzd) { freezed = fzd; }
    bool freezed;

    // Time to live, number of seconds left of particles natural life
    float timeToLive;

    // Total Time to live, number of seconds of particles natural life
    float totalTimeToLive;

    // The timeFraction is calculated every update. It is used in other observers, affectors, etc. so it is
    // better to calculate it once at the Particle level.
    float timeFraction;

    /*  Mass of a particle.
@remarks
    In case of simulations where mass of a particle is needed (i.e. exploding particles of different
    mass) this attribute can be used.
*/
    float mass;

    /** Animation attributes
     */
    float textureAnimationTimeStep;
    float textureAnimationTimeStepCount;
    unsigned short textureCoordsCurrent;
    bool textureAnimationDirectionUp;

    float depthInView;  // depth in camera view
    float zRotation;    // zRotation is used to rotate the particle in 2D (around the Z-axis)   (radian)
    // float widthInWorld;
    // float heightInWorld;
    // float depthInWorld;
};

class AX_EX_DLL PUParticleSystem3D : public ParticleSystem3D
{
public:
    typedef hlookup::string_map<ParticlePool> ParticlePoolMap;

    static const float DEFAULT_WIDTH;
    static const float DEFAULT_HEIGHT;
    static const float DEFAULT_DEPTH;
    static const unsigned int DEFAULT_PARTICLE_QUOTA;
    static const unsigned int DEFAULT_EMITTED_EMITTER_QUOTA;
    static const unsigned int DEFAULT_EMITTED_SYSTEM_QUOTA;
    static const float DEFAULT_MAX_VELOCITY;

    static PUParticleSystem3D* create();
    static PUParticleSystem3D* create(std::string_view filePath);
    static PUParticleSystem3D* create(std::string_view filePath, std::string_view materialPath);

    virtual void draw(Renderer* renderer, const Mat4& transform, uint32_t flags) override;

    virtual void update(float delta) override;
    void forceUpdate(float delta);

    /**
     * particle system play control
     */
    virtual void startParticleSystem() override;

    /**
     * stop particle
     */
    virtual void stopParticleSystem() override;

    /**
     * pause particle
     */
    virtual void pauseParticleSystem() override;

    /**
     * resume particle
     */
    virtual void resumeParticleSystem() override;

    virtual int getAliveParticleCount() const override;

    /**
     * Returns the velocity scale, defined in the particle system, but passed to the technique for convenience.
     */
    float getParticleSystemScaleVelocity() const;

    void setParticleSystemScaleVelocity(float scaleVelocity) { _particleSystemScaleVelocity = scaleVelocity; }

    /**
     * If the orientation of the particle system has been changed since the last update, the passed vector is rotated
     * accordingly.
     */
    void rotationOffset(Vec3& pos);

    float getTimeElapsedSinceStart() const { return _timeElapsedSinceStart; }

    /**
     * default particle width
     */
    float getDefaultWidth() const;
    void setDefaultWidth(const float width);

    /**
     * default particle height
     */
    float getDefaultHeight() const;
    void setDefaultHeight(const float height);

    /**
     * default particle depth
     */
    float getDefaultDepth() const;
    void setDefaultDepth(const float depth);

    Vec3 getDerivedPosition();
    Quaternion getDerivedOrientation();
    Vec3 getDerivedScale();

    /**
     * Return the maximum velocity a particle can have, even if the velocity of the particle has been set higher (either
     * by initialisation of the particle or by means of an affector).
     */
    float getMaxVelocity() const;

    /**
     * Set the maximum velocity a particle can have.
     */
    void setMaxVelocity(float maxVelocity);

    void setMaterialName(std::string_view name) { _matName = name; };
    std::string_view getMaterialName() const { return _matName; };

    /** Forces emission of particles.
     * @remarks The number of requested particles are the exact number that are emitted. No down-scaling is applied.
     */
    void forceEmission(PUEmitter* emitter, unsigned requested);

    /**
     * add particle affector
     */
    void addEmitter(PUEmitter* emitter);

    PUAffector* getAffector(std::string_view name);
    PUEmitter* getEmitter(std::string_view name);
    void removeAllEmitter();

    void addListener(PUListener* listener);
    void removeListener(PUListener* listener);
    void removeAllListener();

    void addObserver(PUObserver* observer);
    PUObserver* getObserver(std::string_view name);
    void removerAllObserver();

    void addBehaviourTemplate(PUBehaviour* behaviour);
    void removeAllBehaviourTemplate();

    bool isMarkedForEmission() const { return _isMarkedForEmission; };
    void setMarkedForEmission(bool isMarked) { _isMarkedForEmission = isMarked; };

    void clearAllParticles();

    unsigned int getEmittedEmitterQuota() const { return _emittedEmitterQuota; };
    void setEmittedEmitterQuota(unsigned int quota) { _emittedEmitterQuota = quota; };

    unsigned int getEmittedSystemQuota() const { return _emittedSystemQuota; };
    void setEmittedSystemQuota(unsigned int quota) { _emittedSystemQuota = quota; };

    PUParticleSystem3D* getParentParticleSystem() const { return _parentParticleSystem; };

    const ParticlePoolMap& getEmittedEmitterParticlePool() const { return _emittedEmitterParticlePool; };
    const ParticlePoolMap& getEmittedSystemParticlePool() const { return _emittedSystemParticlePool; };

    bool makeParticleLocal(PUParticle3D* particle);
    void calulateRotationOffset();

    virtual PUParticleSystem3D* clone();
    virtual void copyAttributesTo(PUParticleSystem3D* system);

    bool initSystem(std::string_view filePath);

    PUParticleSystem3D();
    virtual ~PUParticleSystem3D();

    bool initWithFilePath(std::string_view filePath);
    bool initWithFilePathAndMaterialPath(std::string_view filePath, std::string_view materialPath);

protected:
    void prepared();
    void unPrepared();
    void preUpdator(float elapsedTime);
    void updator(float elapsedTime);
    void postUpdator(float elapsedTime);
    void emitParticles(float elapsedTime);
    void executeEmitParticles(PUEmitter* emitter, unsigned requested, float elapsedTime);
    void emitParticles(ParticlePool& pool, PUEmitter* emitter, unsigned requested, float elapsedTime);
    void processParticle(ParticlePool& pool, bool& firstActiveParticle, bool& firstParticle, float elapsedTime);
    void processMotion(PUParticle3D* particle, float timeElapsed, const Vec3& scl, bool firstParticle);
    void notifyRescaled(const Vec3& scl);
    void initParticleForEmission(PUParticle3D* particle);
    void initParticleForExpiration(PUParticle3D* particle, float timeElapsed);
    void forceStopParticleSystem();

    inline bool isExpired(PUParticle3D* particle, float timeElapsed);

    static void convertToUnixStylePath(std::string& path);

protected:
    std::vector<PUEmitter*> _emitters;
    std::vector<PUObserver*> _observers;

    ParticlePoolMap _emittedEmitterParticlePool;
    ParticlePoolMap _emittedSystemParticlePool;

    unsigned int _emittedEmitterQuota;
    unsigned int _emittedSystemQuota;

    // internal
    PUParticle3D::ParticleBehaviourList _behaviourTemplates;
    std::vector<PUListener*> _listeners;

    bool _prepared;
    bool _poolPrepared;

    float _particleSystemScaleVelocity;
    float _timeElapsedSinceStart;

    Quaternion _rotationOffset;  // Rotation offset between 2 updates.

    Vec3 _rotationCentre;  // The rotation centre.

    float _defaultWidth;  // Default width of each visual particle.

    float _defaultHeight;  // Default height of each visual particle.

    float _defaultDepth;  // Default depth of each visual particle.

    float _maxVelocity;  // Attributes that limit the velocity of the particles in this technique.
    bool _maxVelocitySet;

    std::string _matName;  // material name

    bool _isMarkedForEmission;

    Vec3 _latestPositionDiff;
    Vec3 _latestPosition;  // Keep latest position

    Quaternion _latestOrientation;

    PUParticleSystem3D* _parentParticleSystem;
};

NS_AX_END

#endif