EmitterActor.h

//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions
// are met:
//  * Redistributions of source code must retain the above copyright
//    notice, this list of conditions and the following disclaimer.
//  * Redistributions in binary form must reproduce the above copyright
//    notice, this list of conditions and the following disclaimer in the
//    documentation and/or other materials provided with the distribution.
//  * Neither the name of NVIDIA CORPORATION nor the names of its
//    contributors may be used to endorse or promote products derived
//    from this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS ``AS IS'' AND ANY
// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
// OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// Copyright (c) 2018 NVIDIA Corporation. All rights reserved.



#ifndef EMITTER_ACTOR_H
#define EMITTER_ACTOR_H

#include "Apex.h"

namespace nvidia
{
namespace apex
{

PX_PUSH_PACK_DEFAULT

class EmitterAsset;
class EmitterGeomExplicit;
class EmitterLodParamDesc;
class RenderVolume;

class EmitterActor : public Actor
{
protected:
    virtual ~EmitterActor() {}

public:

    class EmitterValidateCallback
    {
    public:
        virtual bool validateEmitterPosition(const PxVec3 &emitterOrigin,PxVec3 &position) = 0;
    };

    virtual EmitterAsset*           getEmitterAsset() const = 0;

    virtual EmitterGeomExplicit*    isExplicitGeom() = 0;

    virtual PxMat44                 getGlobalPose() const = 0;
    
    virtual void                    setCurrentPose(const PxTransform& pose) = 0;
    
    virtual void                    setCurrentPosition(const PxVec3& pos) = 0;

    virtual void                    setAttachActor(PxActor*) = 0;

    virtual void                    setAttachRelativePose(const PxTransform& pose) = 0;

    virtual const PxActor*          getAttachActor() const = 0;

    virtual const PxMat44           getAttachRelativePose() const = 0;
    
    virtual float                   getObjectRadius() const = 0;

    virtual void                    setOverlapTestCollisionGroups(uint32_t) = 0;

    virtual void                    startEmit(bool persistent = true) = 0;
    
    virtual void                    stopEmit() = 0;
    
    virtual bool                    isEmitting() const = 0;
    
    virtual const EmitterLodParamDesc& getLodParamDesc() const = 0;
    virtual void                    setLodParamDesc(const EmitterLodParamDesc&) = 0;


    virtual void                    setDensity(const float&) = 0;
    
    virtual void                    setRate(const float&) = 0;

    virtual void                    setVelocityLow(const PxVec3&) = 0;
    
    virtual void                    setVelocityHigh(const PxVec3&) = 0;
    
    virtual void                    setLifetimeLow(const float&) = 0;
    
    virtual void                    setLifetimeHigh(const float&) = 0;

    virtual void                    emitAssetParticles(bool enable) = 0;
    
    virtual bool                    getEmitAssetParticles() const = 0;

    virtual void                    setPreferredRenderVolume(RenderVolume* volume) = 0;

    virtual void                    getRate(float&) const = 0;

    virtual uint32_t                getSimParticlesCount() const = 0;

    virtual uint32_t                getActiveParticleCount() const = 0;

    virtual void                    setDensityGridPosition(const PxVec3 &pos) = 0;

    virtual void                    setApexEmitterValidateCallback(EmitterValidateCallback *callback) = 0;

    PX_DEPRECATED virtual void      setObjectScale(float scale) = 0;

    PX_DEPRECATED virtual float     getObjectScale(void) const = 0;

    virtual void                    setCurrentScale(float scale) = 0;

    virtual float                   getCurrentScale(void) const = 0;


};

PX_POP_PACK

}
} // end namespace nvidia

#endif // EMITTER_ACTOR_H