EffectPackageActor.h

Go to the documentation of this file.

//
// 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 EFFECT_PACKAGE_ACTOR_H
#define EFFECT_PACKAGE_ACTOR_H

#include "Actor.h"
#include "EmitterActor.h"

struct ID3D11ShaderResourceView;
struct ID3D11DeviceContext;

namespace physx
{
    class PxRigidDynamic;
}

namespace nvidia
{

namespace general_renderdebug4
{
class RenderDebugInterface;
};

namespace apex
{

enum EffectType
{
    ET_EMITTER,
    ET_HEAT_SOURCE,
    ET_SUBSTANCE_SOURCE,
    ET_TURBULENCE_FS,
    ET_JET_FS,
    ET_ATTRACTOR_FS,
    ET_FORCE_FIELD,
    ET_NOISE_FS,
    ET_VORTEX_FS,
    ET_WIND_FS,
    ET_RIGID_BODY,
    ET_VELOCITY_SOURCE,
    ET_FLAME_EMITTER,
    ET_LAST
};

class Actor;
class RenderVolume;

class EffectPackageActor : public Actor
{
public:

    virtual void fadeOut(float fadetime) = 0;

    virtual void fadeIn(float fadetime) = 0;

    virtual uint32_t getEffectCount() const = 0;

    virtual EffectType getEffectType(uint32_t effectIndex) const = 0;

    virtual const char* getEffectName(uint32_t effectIndex) const = 0;

    virtual bool isEffectEnabled(uint32_t effectIndex) const = 0;

    virtual bool setEffectEnabled(uint32_t effectIndex, bool state) = 0;

    virtual void setCurrentScale(float scale) = 0;

    virtual float getCurrentScale(void) const = 0;

    virtual bool getEffectPose(uint32_t effectIndex, PxTransform& pose, bool worldSpace) = 0;

    virtual bool setEffectPose(uint32_t effectIndex, const PxTransform& pose, bool worldSpace) = 0;

    virtual Actor* getEffectActor(uint32_t effectIndex) const  = 0;

    virtual PxRigidDynamic* getEffectRigidDynamic(uint32_t effectIndex) const  = 0;

    virtual void setEmitterState(bool state) = 0;

    virtual uint32_t getActiveParticleCount() const = 0;

    virtual bool isStillEmitting() const = 0;

    virtual bool isAlive(void) const = 0;

    virtual void setEnabled(bool state) = 0;

    virtual bool getEnabled() const = 0;

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

    virtual const PxTransform& getPose() const = 0;

    virtual void refresh() = 0;

    virtual void release() = 0;

    virtual const char* getName() const = 0;

    virtual float getDuration() const = 0;

    virtual float getCurrentLife() const = 0;

    virtual void                 setPreferredRenderVolume(RenderVolume* volume) = 0;

    virtual const char * hasVolumeRenderMaterial(uint32_t &index) const = 0;

    virtual void setApexEmitterValidateCallback(EmitterActor::EmitterValidateCallback *callback) = 0;
};


}; // end of apex namespace
}; // end of physx namespace

#endif