axmol/extensions/Particle3D/PU/CCPUBehaviour.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_BEHAVIOUR_H__
#define __AX_PU_PARTICLE_3D_BEHAVIOUR_H__

#include "base/CCRef.h"
#include "math/CCMath.h"
#include "extensions/Particle3D/PU/CCPUParticleSystem3D.h"
#include <vector>
#include <string>

NS_AX_BEGIN

struct PUParticle3D;
class PUParticleSystem3D;

class AX_EX_DLL PUBehaviour : public Ref
{
    friend class PUParticleSystem3D;

public:
    /** Todo
     */
    std::string_view getBehaviourType() const { return _behaviourType; };
    void setBehaviourType(std::string_view behaviourType) { _behaviourType = behaviourType; };

    /** Notify that the Behaviour is rescaled.
     */
    virtual void notifyRescaled(const Vec3& scale) { _behaviourScale = scale; };

    virtual void prepare(){};
    virtual void unPrepare(){};

    virtual void updateBehaviour(PUParticle3D* particle, float deltaTime);

    /** Perform initialising activities as soon as the particle with which the ParticleBehaviour is
        associated, is emitted.
    */

    virtual void initParticleForEmission(PUParticle3D* particle);
    /** Perform some action if a particle expires.
     */
    virtual void initParticleForExpiration(PUParticle3D* particle, float timeElapsed);

    virtual PUBehaviour* clone();
    virtual void copyAttributesTo(PUBehaviour* behaviour);

    PUBehaviour();
    virtual ~PUBehaviour();

protected:
    PUParticleSystem3D* _particleSystem;

    // Type of behaviour
    std::string _behaviourType;

    /** Although the scale is on a Particle System level, the behaviour can also be scaled.
     */
    Vec3 _behaviourScale;
};

NS_AX_END

#endif