axmol/extensions/Particle3D/PU/PUCircleEmitter.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_CIRCLE_EMITTER_H__
#define __AX_PU_PARTICLE_3D_CIRCLE_EMITTER_H__

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

NS_AX_BEGIN

class AX_EX_DLL PUCircleEmitter : public PUEmitter
{
public:
    // Constants
    static const float DEFAULT_RADIUS;
    static const float DEFAULT_STEP;
    static const float DEFAULT_ANGLE;
    static const bool DEFAULT_RANDOM;
    static const Vec3 DEFAULT_NORMAL;

    static PUCircleEmitter* create();

    /**
     */
    float getRadius() const;
    void setRadius(const float radius);

    /**
     */
    float getCircleAngle() const;
    void setCircleAngle(const float circleAngle);

    /**
     */
    float getStep() const;
    void setStep(const float step);

    /**
     */
    bool isRandom() const;
    void setRandom(const bool random);

    /*
     */
    const Quaternion& getOrientation() const;
    const Vec3& getNormal() const;
    void setNormal(const Vec3& normal);

    /** See ParticleEmiter
     */
    virtual void notifyStart() override;

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

    PUCircleEmitter();
    virtual ~PUCircleEmitter(){};

protected:
    /** Determine a particle position on the circle.
     */
    virtual void initParticlePosition(PUParticle3D* particle) override;

    /** Determine the particle direction.
     */
    virtual void initParticleDirection(PUParticle3D* particle) override;

    Quaternion getRotationTo(const Vec3& src, const Vec3& dest, const Vec3& fallbackAxis = Vec3::ZERO) const;

protected:
    float _radius;
    float _circleAngle;
    float _originalCircleAngle;
    float _step;
    float _x;
    float _z;
    bool _random;
    Quaternion _orientation;
    Vec3 _normal;
};
NS_AX_END

#endif