EffectPackageActor.h

Go to the documentation of this file.

/*
 * 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 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