PxClothFabric.h

Go to the documentation of this file.

/*
 * Copyright (c) 2008-2015, 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.
 */
// Copyright (c) 2004-2008 AGEIA Technologies, Inc. All rights reserved.
// Copyright (c) 2001-2004 NovodeX AG. All rights reserved.  


#ifndef PX_PHYSICS_NX_CLOTH_FABRIC
#define PX_PHYSICS_NX_CLOTH_FABRIC

#include "common/PxBase.h"

#ifndef PX_DOXYGEN
namespace physx
{
#endif

struct PxClothFabricPhaseType
{
    enum Enum
    {
        eINVALID,     
        eVERTICAL,    
        eHORIZONTAL,  
        eBENDING,     
        eSHEARING,    
        eCOUNT        // internal use only
    };
};

struct PxClothFabricPhase
{
    PxClothFabricPhase(PxClothFabricPhaseType::Enum type = 
        PxClothFabricPhaseType::eINVALID, PxU32 index = 0);

    PxClothFabricPhaseType::Enum phaseType;

    PxU32 setIndex;
};

PX_INLINE PxClothFabricPhase::PxClothFabricPhase(
    PxClothFabricPhaseType::Enum type, PxU32 index)
    : phaseType(type)
    , setIndex(index)
{}

class PxClothFabricDesc
{
public:
    PxU32 nbParticles;

    PxU32 nbPhases;
    const PxClothFabricPhase* phases;

    PxU32 nbSets;
    const PxU32* sets;

    const PxU32* indices;
    const PxReal* restvalues;

    PxU32 nbTethers;
    const PxU32* tetherAnchors;
    const PxReal* tetherLengths;

    PX_INLINE PxClothFabricDesc();

    PX_INLINE void setToDefault();

    PX_INLINE bool isValid() const;
};

PX_INLINE PxClothFabricDesc::PxClothFabricDesc()
{
    setToDefault();
}

PX_INLINE void PxClothFabricDesc::setToDefault()
{
    memset(this, 0, sizeof(PxClothFabricDesc));
}

PX_INLINE bool PxClothFabricDesc::isValid() const
{
    return nbParticles && nbPhases && phases && restvalues && nbSets 
        && sets && indices && (!nbTethers || (tetherAnchors && tetherLengths));
}


class PxClothFabric : public PxBase
{
public:
    virtual void release() = 0;

    virtual PxU32 getNbParticles() const = 0;

    virtual PxU32 getNbPhases() const = 0;

    virtual PxU32 getNbRestvalues() const = 0;

    virtual PxU32 getNbSets() const = 0;

    virtual PxU32 getNbParticleIndices() const = 0;

    virtual PxU32 getNbTethers() const = 0;

    virtual PxU32 getPhases(PxClothFabricPhase* userPhaseBuffer, PxU32 bufferSize) const = 0;

    virtual PxU32 getSets(PxU32* userSetBuffer, PxU32 bufferSize) const = 0;

    virtual PxU32 getParticleIndices(PxU32* userParticleIndexBuffer, PxU32 bufferSize) const = 0;

    virtual PxU32 getRestvalues(PxReal* userRestvalueBuffer, PxU32 bufferSize) const = 0;

    virtual PxU32 getTetherAnchors(PxU32* userAnchorBuffer, PxU32 bufferSize) const = 0;

    virtual PxU32 getTetherLengths(PxReal* userLengthBuffer, PxU32 bufferSize) const = 0;

    PX_DEPRECATED virtual PxClothFabricPhaseType::Enum getPhaseType(PxU32 phaseIndex) const = 0;

    virtual void scaleRestlengths(PxReal scale) = 0;

    virtual PxU32 getReferenceCount() const = 0;

    virtual const char* getConcreteTypeName() const { return "PxClothFabric";   }

protected:

    PX_INLINE PxClothFabric(PxType concreteType, PxBaseFlags baseFlags) : PxBase(concreteType, baseFlags) {}
    PX_INLINE PxClothFabric(PxBaseFlags baseFlags) : PxBase(baseFlags) {}
    virtual ~PxClothFabric() {}
    virtual bool isKindOf(const char* name) const { return !strcmp("PxClothFabric", name) || PxBase::isKindOf(name); }
};

#ifndef PX_DOXYGEN
} // namespace physx
#endif

#endif