NxModifier.h

Go to the documentation of this file.

// This code contains NVIDIA Confidential Information and is disclosed to you
// under a form of NVIDIA software license agreement provided separately to you.
//
// Notice
// NVIDIA Corporation and its licensors retain all intellectual property and
// proprietary rights in and to this software and 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.
//
// ALL NVIDIA DESIGN SPECIFICATIONS, CODE ARE PROVIDED "AS IS.". NVIDIA MAKES
// NO WARRANTIES, EXPRESSED, IMPLIED, STATUTORY, OR OTHERWISE WITH RESPECT TO
// THE MATERIALS, AND EXPRESSLY DISCLAIMS ALL IMPLIED WARRANTIES OF NONINFRINGEMENT,
// MERCHANTABILITY, AND FITNESS FOR A PARTICULAR PURPOSE.
//
// Information and code furnished is believed to be accurate and reliable.
// However, NVIDIA Corporation assumes no responsibility for the consequences of use of such
// information or for any infringement of patents or other rights of third parties that may
// result from its use. No license is granted by implication or otherwise under any patent
// or patent rights of NVIDIA Corporation. Details are subject to change without notice.
// This code supersedes and replaces all information previously supplied.
// NVIDIA Corporation products are not authorized for use as critical
// components in life support devices or systems without express written approval of
// NVIDIA Corporation.
//
// Copyright (c) 2008-2014 NVIDIA Corporation. All rights reserved.

#ifndef NX_MODIFIER_H
#define NX_MODIFIER_H

#include "NxApex.h"
#include "NxCurve.h"
#include "NxIofxAsset.h"
#include "NxUserRenderSpriteBufferDesc.h"

#include "NxModifierDefs.h"

namespace physx
{
namespace apex
{

PX_PUSH_PACK_DEFAULT

inline physx::PxU32 ModifierUsageFromStage(ModifierStage stage)
{
    return 1 << stage;
}

class NiIosObjectData;

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

class NxModifier
{
public:
    virtual ModifierTypeEnum getModifierType() const = 0;

    virtual physx::PxU32 getModifierUsage() const = 0;

    virtual physx::PxU32 getModifierSpriteSemantics()
    {
        return 0;
    }
    virtual physx::PxU32 getModifierMeshSemantics()
    {
        return 0;
    }


    virtual ~NxModifier() { }


};

template <typename T>
class NxModifierT : public NxModifier
{
public:
    virtual ModifierTypeEnum getModifierType() const
    {
        return T::ModifierType;
    }
    virtual physx::PxU32 getModifierUsage() const
    {
        return T::ModifierUsage;
    }
};


class NxRotationModifier : public NxModifierT<NxRotationModifier>
{
public:
    static const ModifierTypeEnum ModifierType = ModifierType_Rotation;
    static const physx::PxU32 ModifierUsage = ModifierUsage_Spawn | ModifierUsage_Continuous
            | ModifierUsage_Mesh;


    virtual NxApexMeshParticleRollType::Enum getRollType() const = 0;
    virtual void setRollType(NxApexMeshParticleRollType::Enum rollType) = 0;
    virtual physx::PxF32 getMaxSettleRate() const = 0;
    virtual void setMaxSettleRate(physx::PxF32 settleRate) = 0;
    virtual physx::PxF32 getMaxRotationRate() const = 0;
    virtual void setMaxRotationRate(physx::PxF32 rotationRate) = 0;

};

class NxSimpleScaleModifier : public NxModifierT<NxSimpleScaleModifier>
{
public:
    static const ModifierTypeEnum ModifierType = ModifierType_SimpleScale;
    static const physx::PxU32 ModifierUsage = ModifierUsage_Spawn | ModifierUsage_Continuous
            | ModifierUsage_Sprite | ModifierUsage_Mesh;


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

class NxScaleByMassModifier : public NxModifierT<NxScaleByMassModifier>
{
public:
    static const ModifierTypeEnum ModifierType = ModifierType_ScaleByMass;
    static const physx::PxU32 ModifierUsage = ModifierUsage_Spawn | ModifierUsage_Continuous
            | ModifierUsage_Sprite | ModifierUsage_Mesh;
};

class NxRandomScaleModifier : public NxModifierT<NxRandomScaleModifier>
{
public:
    static const ModifierTypeEnum ModifierType = ModifierType_RandomScale;
    static const physx::PxU32 ModifierUsage = ModifierUsage_Spawn
            | ModifierUsage_Sprite | ModifierUsage_Mesh;


    virtual NxRange<physx::PxF32> getScaleFactor() const = 0;
    virtual void setScaleFactor(const NxRange<physx::PxF32>& s) = 0;
};

class NxColorVsLifeModifier : public NxModifierT<NxColorVsLifeModifier>
{
public:
    static const ModifierTypeEnum ModifierType = ModifierType_ColorVsLife;
    static const physx::PxU32 ModifierUsage = ModifierUsage_Spawn | ModifierUsage_Continuous
            | ModifierUsage_Sprite | ModifierUsage_Mesh;


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

class NxColorVsDensityModifier : public NxModifierT<NxColorVsDensityModifier>
{
public:
    static const ModifierTypeEnum ModifierType = ModifierType_ColorVsDensity;
    static const physx::PxU32 ModifierUsage = ModifierUsage_Continuous
            | ModifierUsage_Sprite | ModifierUsage_Mesh;


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

class NxSubtextureVsLifeModifier : public NxModifierT<NxSubtextureVsLifeModifier>
{
public:
    static const ModifierTypeEnum ModifierType = ModifierType_SubtextureVsLife;
    static const physx::PxU32 ModifierUsage = ModifierUsage_Continuous
            | ModifierUsage_Sprite;


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

class NxOrientAlongVelocityModifier : public NxModifierT<NxOrientAlongVelocityModifier>
{
public:
    static const ModifierTypeEnum ModifierType = ModifierType_OrientAlongVelocity;
    static const physx::PxU32 ModifierUsage = ModifierUsage_Continuous
            | ModifierUsage_Mesh;


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


class NxScaleAlongVelocityModifier : public NxModifierT<NxScaleAlongVelocityModifier>
{
public:
    static const ModifierTypeEnum ModifierType = ModifierType_ScaleAlongVelocity;
    static const physx::PxU32 ModifierUsage = ModifierUsage_Continuous
            | ModifierUsage_Mesh;


    virtual physx::PxF32 getScaleFactor() const = 0;
    virtual void setScaleFactor(const physx::PxF32& s) = 0;
};

class NxRandomSubtextureModifier : public NxModifierT<NxRandomSubtextureModifier>
{
public:
    static const ModifierTypeEnum ModifierType = ModifierType_RandomSubtexture;
    static const physx::PxU32 ModifierUsage = ModifierUsage_Spawn
            | ModifierUsage_Sprite;


    virtual NxRange<physx::PxF32> getSubtextureRange() const = 0;
    virtual void setSubtextureRange(const NxRange<physx::PxF32>& s) = 0;
};

class NxRandomRotationModifier : public NxModifierT<NxRandomRotationModifier>
{
public:
    static const ModifierTypeEnum ModifierType = ModifierType_RandomRotation;
    static const physx::PxU32 ModifierUsage = ModifierUsage_Spawn
            | ModifierUsage_Sprite;


    virtual NxRange<physx::PxF32> getRotationRange() const = 0;
    virtual void setRotationRange(const NxRange<physx::PxF32>& s) = 0;
};

class NxScaleVsLifeModifier : public NxModifierT<NxScaleVsLifeModifier>
{
public:
    static const ModifierTypeEnum ModifierType = ModifierType_ScaleVsLife;
    static const physx::PxU32 ModifierUsage = ModifierUsage_Continuous
            | ModifierUsage_Sprite | ModifierUsage_Mesh;


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

class NxScaleVsDensityModifier : public NxModifierT<NxScaleVsDensityModifier>
{
public:
    static const ModifierTypeEnum ModifierType = ModifierType_ScaleVsDensity;
    static const physx::PxU32 ModifierUsage = ModifierUsage_Continuous
            | ModifierUsage_Sprite | ModifierUsage_Mesh;


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

class NxScaleVsCameraDistanceModifier : public NxModifierT<NxScaleVsCameraDistanceModifier>
{
public:
    static const ModifierTypeEnum ModifierType = ModifierType_ScaleVsCameraDistance;
    static const physx::PxU32 ModifierUsage = ModifierUsage_Continuous
            | ModifierUsage_Sprite | ModifierUsage_Mesh;


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

class NxViewDirectionSortingModifier : public NxModifierT<NxViewDirectionSortingModifier>
{
public:
    static const ModifierTypeEnum ModifierType = ModifierType_ViewDirectionSorting;
    static const physx::PxU32 ModifierUsage = ModifierUsage_Continuous
            | ModifierUsage_Sprite;

    // Access to expected data members
};

class NxRotationRateModifier : public NxModifierT<NxRotationRateModifier>
{
public:
    static const ModifierTypeEnum ModifierType = ModifierType_RotationRate;
    static const physx::PxU32 ModifierUsage = ModifierUsage_Continuous
            | ModifierUsage_Sprite;


    virtual physx::PxF32 getRotationRate() const = 0;
    virtual void setRotationRate(const physx::PxF32& rate) = 0;
};

class NxRotationRateVsLifeModifier : public NxModifierT<NxRotationRateVsLifeModifier>
{
public:
    static const ModifierTypeEnum ModifierType = ModifierType_RotationRateVsLife;
    static const physx::PxU32 ModifierUsage = ModifierUsage_Continuous
            | ModifierUsage_Sprite;


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

class NxOrientScaleAlongScreenVelocityModifier : public NxModifierT<NxOrientScaleAlongScreenVelocityModifier>
{
public:
    static const ModifierTypeEnum ModifierType = ModifierType_OrientScaleAlongScreenVelocity;
    static const physx::PxU32 ModifierUsage = ModifierUsage_Continuous
            | ModifierUsage_Sprite;


    virtual physx::PxF32 getScalePerVelocity() const = 0;
    virtual void setScalePerVelocity(const physx::PxF32& s) = 0;
};

class NxColorVsVelocityModifier : public NxModifierT<NxColorVsVelocityModifier>
{
public:
    static const ModifierTypeEnum ModifierType = ModifierType_ColorVsVelocity;
    static const physx::PxU32 ModifierUsage = ModifierUsage_Spawn | ModifierUsage_Continuous
            | ModifierUsage_Sprite | ModifierUsage_Mesh;


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

    virtual physx::PxF32 getVelocity0() const = 0;
    virtual void setVelocity0(physx::PxF32 value) = 0;

    virtual physx::PxF32 getVelocity1() const = 0;
    virtual void setVelocity1(physx::PxF32 value) = 0;
};

#pragma warning( default: 4100 )

PX_POP_PACK

}
} // namespace apex

#endif // NX_MODIFIER_H