Modifier.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 MODIFIER_H
#define MODIFIER_H

#include "Apex.h"
#include "Curve.h"
#include "IofxAsset.h"
#include "IofxRenderCallback.h"

#include "ModifierDefs.h"

namespace nvidia
{
namespace apex
{

PX_PUSH_PACK_DEFAULT

inline uint32_t ModifierUsageFromStage(ModifierStage stage)
{
    return 1u << stage;
}

// Disable the unused arguments warning for this header.
#pragma warning( disable: 4100 )

class Modifier
{
public:

    virtual ModifierTypeEnum getModifierType() const = 0;

    virtual uint32_t getModifierUsage() const = 0;

    virtual uint32_t getModifierSpriteSemantics()
    {
        return 0;
    }
    
    virtual uint32_t getModifierMeshSemantics()
    {
        return 0;
    }

    virtual ~Modifier() { }

};

template <typename T>
class ModifierT : public Modifier
{
public:
    
    virtual ModifierTypeEnum getModifierType() const
    {
        return T::ModifierType;
    }
    
    virtual uint32_t getModifierUsage() const
    {
        return T::ModifierUsage;
    }
};


class RotationModifier : public ModifierT<RotationModifier>
{
public:
    
    static const ModifierTypeEnum ModifierType = ModifierType_Rotation;
    
    static const uint32_t ModifierUsage = ModifierUsage_Spawn | ModifierUsage_Continuous
            | ModifierUsage_Mesh;


    virtual ApexMeshParticleRollType::Enum getRollType() const = 0;
    
    virtual void setRollType(ApexMeshParticleRollType::Enum rollType) = 0;
    
    virtual float getMaxSettleRate() const = 0;
    
    virtual void setMaxSettleRate(float settleRate) = 0;
    
    virtual float getMaxRotationRate() const = 0;
    
    virtual void setMaxRotationRate(float rotationRate) = 0;

};

class SimpleScaleModifier : public ModifierT<SimpleScaleModifier>
{
public:

    static const ModifierTypeEnum ModifierType = ModifierType_SimpleScale;
    
    static const uint32_t ModifierUsage = ModifierUsage_Spawn | ModifierUsage_Continuous
            | ModifierUsage_Sprite | ModifierUsage_Mesh;


    virtual PxVec3 getScaleFactor() const = 0;
    
    virtual void setScaleFactor(const PxVec3& s) = 0;
};

class ScaleByMassModifier : public ModifierT<ScaleByMassModifier>
{
public:

    static const ModifierTypeEnum ModifierType = ModifierType_ScaleByMass;
    
    static const uint32_t ModifierUsage = ModifierUsage_Spawn | ModifierUsage_Continuous
            | ModifierUsage_Sprite | ModifierUsage_Mesh;
};

class RandomScaleModifier : public ModifierT<RandomScaleModifier>
{
public:

    static const ModifierTypeEnum ModifierType = ModifierType_RandomScale;
    
    static const uint32_t ModifierUsage = ModifierUsage_Spawn
            | ModifierUsage_Sprite | ModifierUsage_Mesh;


    virtual Range<float> getScaleFactor() const = 0;
    
    virtual void setScaleFactor(const Range<float>& s) = 0;
};

class ColorVsLifeModifier : public ModifierT<ColorVsLifeModifier>
{
public:

    static const ModifierTypeEnum ModifierType = ModifierType_ColorVsLife;
    
    static const uint32_t ModifierUsage = ModifierUsage_Spawn | ModifierUsage_Continuous
            | ModifierUsage_Sprite | ModifierUsage_Mesh;


    virtual ColorChannel getColorChannel() const = 0;
    
    virtual void setColorChannel(ColorChannel colorChannel) = 0;
    
    virtual const Curve* getFunction() const = 0;
    
    virtual void setFunction(const Curve* f) = 0;
};

class ColorVsDensityModifier : public ModifierT<ColorVsDensityModifier>
{
public:

    static const ModifierTypeEnum ModifierType = ModifierType_ColorVsDensity;
    
    static const uint32_t ModifierUsage = ModifierUsage_Continuous
            | ModifierUsage_Sprite | ModifierUsage_Mesh;


    virtual ColorChannel getColorChannel() const = 0;
    
    virtual void setColorChannel(ColorChannel colorChannel) = 0;
    
    virtual const Curve* getFunction() const = 0;
    
    virtual void setFunction(const Curve* f) = 0;
};

class SubtextureVsLifeModifier : public ModifierT<SubtextureVsLifeModifier>
{
public:

    static const ModifierTypeEnum ModifierType = ModifierType_SubtextureVsLife;
    
    static const uint32_t ModifierUsage = ModifierUsage_Continuous
            | ModifierUsage_Sprite;


    virtual const Curve* getFunction() const = 0;
    
    virtual void setFunction(const Curve* f) = 0;
};

class OrientAlongVelocityModifier : public ModifierT<OrientAlongVelocityModifier>
{
public:

    static const ModifierTypeEnum ModifierType = ModifierType_OrientAlongVelocity;
    
    static const uint32_t ModifierUsage = ModifierUsage_Continuous
            | ModifierUsage_Mesh;


    virtual PxVec3 getModelForward() const = 0;
    
    virtual void setModelForward(const PxVec3& s) = 0;
};


class ScaleAlongVelocityModifier : public ModifierT<ScaleAlongVelocityModifier>
{
public:

    static const ModifierTypeEnum ModifierType = ModifierType_ScaleAlongVelocity;
    
    static const uint32_t ModifierUsage = ModifierUsage_Continuous
            | ModifierUsage_Mesh;


    virtual float getScaleFactor() const = 0;
    
    virtual void setScaleFactor(const float& s) = 0;
};

class RandomSubtextureModifier : public ModifierT<RandomSubtextureModifier>
{
public:

    static const ModifierTypeEnum ModifierType = ModifierType_RandomSubtexture;
    
    static const uint32_t ModifierUsage = ModifierUsage_Spawn
            | ModifierUsage_Sprite;


    virtual Range<float> getSubtextureRange() const = 0;
    
    virtual void setSubtextureRange(const Range<float>& s) = 0;
};

class RandomRotationModifier : public ModifierT<RandomRotationModifier>
{
public:

    static const ModifierTypeEnum ModifierType = ModifierType_RandomRotation;
    
    static const uint32_t ModifierUsage = ModifierUsage_Spawn
            | ModifierUsage_Sprite;


    virtual Range<float> getRotationRange() const = 0;
    
    virtual void setRotationRange(const Range<float>& s) = 0;
};

class ScaleVsLifeModifier : public ModifierT<ScaleVsLifeModifier>
{
public:

    static const ModifierTypeEnum ModifierType = ModifierType_ScaleVsLife;
    
    static const uint32_t ModifierUsage = ModifierUsage_Continuous
            | ModifierUsage_Sprite | ModifierUsage_Mesh;


    virtual ScaleAxis getScaleAxis() const = 0;
    
    virtual void setScaleAxis(ScaleAxis a) = 0;
    
    virtual const Curve* getFunction() const = 0;
    
    virtual void setFunction(const Curve* f) = 0;
};

class ScaleVsDensityModifier : public ModifierT<ScaleVsDensityModifier>
{
public:

    static const ModifierTypeEnum ModifierType = ModifierType_ScaleVsDensity;
    
    static const uint32_t ModifierUsage = ModifierUsage_Continuous
            | ModifierUsage_Sprite | ModifierUsage_Mesh;


    virtual ScaleAxis getScaleAxis() const = 0;
    
    virtual void setScaleAxis(ScaleAxis a) = 0;
    
    virtual const Curve* getFunction() const = 0;
    
    virtual void setFunction(const Curve* f) = 0;
};

class ScaleVsCameraDistanceModifier : public ModifierT<ScaleVsCameraDistanceModifier>
{
public:

    static const ModifierTypeEnum ModifierType = ModifierType_ScaleVsCameraDistance;
    
    static const uint32_t ModifierUsage = ModifierUsage_Continuous
            | ModifierUsage_Sprite | ModifierUsage_Mesh;


    virtual ScaleAxis getScaleAxis() const = 0;
    
    virtual void setScaleAxis(ScaleAxis a) = 0;
    
    virtual const Curve* getFunction() const = 0;
    
    virtual void setFunction(const Curve* f) = 0;
};

class ViewDirectionSortingModifier : public ModifierT<ViewDirectionSortingModifier>
{
public:

    static const ModifierTypeEnum ModifierType = ModifierType_ViewDirectionSorting;
    
    static const uint32_t ModifierUsage = ModifierUsage_Continuous
            | ModifierUsage_Sprite;

};

class RotationRateModifier : public ModifierT<RotationRateModifier>
{
public:

    static const ModifierTypeEnum ModifierType = ModifierType_RotationRate;
    
    static const uint32_t ModifierUsage = ModifierUsage_Continuous
            | ModifierUsage_Sprite;


    virtual float getRotationRate() const = 0;
    
    virtual void setRotationRate(const float& rate) = 0;
};

class RotationRateVsLifeModifier : public ModifierT<RotationRateVsLifeModifier>
{
public:

    static const ModifierTypeEnum ModifierType = ModifierType_RotationRateVsLife;
    
    static const uint32_t ModifierUsage = ModifierUsage_Continuous
            | ModifierUsage_Sprite;


    virtual const Curve* getFunction() const = 0;
    
    virtual void setFunction(const Curve* f) = 0;
};

class OrientScaleAlongScreenVelocityModifier : public ModifierT<OrientScaleAlongScreenVelocityModifier>
{
public:

    static const ModifierTypeEnum ModifierType = ModifierType_OrientScaleAlongScreenVelocity;
    
    static const uint32_t ModifierUsage = ModifierUsage_Continuous
            | ModifierUsage_Sprite;


    virtual float getScalePerVelocity() const = 0;
    
    virtual void setScalePerVelocity(const float& s) = 0;

    virtual float getScaleChangeLimit() const = 0;
    
    virtual void setScaleChangeLimit(const float& s) = 0;

    virtual float getScaleChangeDelay() const = 0;
    
    virtual void setScaleChangeDelay(const float& s) = 0;
};

class ColorVsVelocityModifier : public ModifierT<ColorVsVelocityModifier>
{
public:

    static const ModifierTypeEnum ModifierType = ModifierType_ColorVsVelocity;
    
    static const uint32_t ModifierUsage = ModifierUsage_Spawn | ModifierUsage_Continuous
            | ModifierUsage_Sprite | ModifierUsage_Mesh;


    virtual ColorChannel getColorChannel() const = 0;
    
    virtual void setColorChannel(ColorChannel colorChannel) = 0;
    
    virtual const Curve* getFunction() const = 0;
    
    virtual void setFunction(const Curve* f) = 0;

    virtual float getVelocity0() const = 0;
    
    virtual void setVelocity0(float value) = 0;

    virtual float getVelocity1() const = 0;
    
    virtual void setVelocity1(float value) = 0;
};

#pragma warning( default: 4100 )

PX_POP_PACK

}
} // namespace nvidia

#endif // MODIFIER_H