TurbulenceFSActor.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 TURBULENCE_FSACTOR_H
#define TURBULENCE_FSACTOR_H

#include "Apex.h"
#include "Shape.h"

namespace nvidia
{
namespace apex
{

class TurbulenceFSAsset;
class TurbulenceRenderable;

class TurbulenceFSActor : public Actor, public Renderable
{
protected:
    virtual ~TurbulenceFSActor() {}

public:

    virtual TurbulenceFSAsset* getTurbulenceFSAsset() const = 0;

    virtual void setEnabled(bool enable) = 0;

    virtual void setPose(PxMat44 pose) = 0;

    virtual PxMat44 getPose() const = 0;

    virtual PxVec3 getGridBoundingBoxMin() = 0;
    virtual PxVec3 getGridBoundingBoxMax() = 0;

    virtual PxVec3 getGridSize() = 0;

    virtual void getGridDimensions(uint32_t &gridX,uint32_t &gridY,uint32_t &gridZ) = 0;

    virtual void setGridDimensions(const uint32_t &gridX, const uint32_t &gridY, const uint32_t &gridZ) = 0;

    virtual void setUpdatesPerFrame(float upd) = 0;
    virtual float getUpdatesPerFrame() const = 0;

    virtual void getVelocityField(void** x, void** y, void** z, uint32_t& sizeX, uint32_t& sizeY, uint32_t& sizeZ) = 0;

    virtual void setSampleVelocityFieldEnabled(bool enabled) = 0;

    virtual void setAngularVelocityMultiplierAndClamp(float angularVelocityMultiplier, float angularVelocityClamp) = 0;

    virtual void setLinearVelocityMultiplierAndClamp(float linearVelocityMultiplier, float linearVelocityClamp) = 0;

    virtual void setVelocityFieldFade(float fade) = 0;

    virtual void setFluidViscosity(float viscosity) = 0;

    virtual void setVelocityFieldCleaningTime(float time) = 0;

    virtual void setVelocityFieldCleaningDelay(float time) = 0;

    virtual void setVelocityFieldCleaningIntensity(float a) = 0;

    virtual void setUseHeat(bool enable) = 0;

    virtual void setHeatBasedParameters(float forceMultiplier, float ambientTemperature, PxVec3 heatForceDirection, float thermalConductivity) = 0;

    virtual void setUseDensity(bool enable) = 0;

    virtual bool getUseDensity(void) const = 0;

    virtual void setDensityBasedParameters(float diffusionCoef, float densityFieldFade) = 0;

    virtual void getDensityGridDimensions(uint32_t &gridX,uint32_t &gridY,uint32_t &gridZ) = 0;

    virtual void setExternalVelocity(PxVec3 vel) = 0;

    virtual void setFieldVelocityMultiplier(float value) = 0;

    virtual void setFieldVelocityWeight(float value) = 0;

    virtual void setNoiseParameters(float noiseStrength, PxVec3 noiseSpacePeriod, float noiseTimePeriod, uint32_t noiseOctaves) = 0;

    virtual void setDensityTextureRange(float minValue, float maxValue) = 0;

    virtual const char *getVolumeRenderMaterialName(void) const = 0;

    virtual void setCurrentScale(float scale) = 0;

    virtual float getCurrentScale(void) const = 0;

    virtual bool getUseFlame(void) const = 0;

    virtual void getFlameGridDimensions(uint32_t &gridX, uint32_t &gridY, uint32_t &gridZ) const = 0;

    virtual TurbulenceRenderable* acquireRenderableReference() = 0;

};

}
} // end namespace nvidia

#endif // TURBULENCE_FSACTOR_H