EmitterActor.h

/*
 * Copyright (c) 2008-2017, NVIDIA CORPORATION.  All rights reserved.
 *
 * NVIDIA CORPORATION and its licensors retain all intellectual property
 * and proprietary rights in and to this software, related documentation
 * and any modifications thereto.  Any use, reproduction, disclosure or
 * distribution of this software and related documentation without an express
 * license agreement from NVIDIA CORPORATION is strictly prohibited.
 */


#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