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


#ifndef PX_PHYSICS_NXMATERIAL
#define PX_PHYSICS_NXMATERIAL

#include "PxPhysXConfig.h"
#include "common/PxBase.h"

#if !PX_DOXYGEN
namespace physx
{
#endif

class PxScene;

struct PxMaterialFlag
{
    enum Enum
    {

        eDISABLE_FRICTION = 1 << 0,

        eDISABLE_STRONG_FRICTION = 1 << 1,

        eIMPROVED_PATCH_FRICTION = 1 << 2
    };
};

typedef PxFlags<PxMaterialFlag::Enum,PxU16> PxMaterialFlags;
PX_FLAGS_OPERATORS(PxMaterialFlag::Enum,PxU16)



struct PxCombineMode
{
    enum Enum
    {
        eAVERAGE    = 0,        
        eMIN        = 1,        
        eMULTIPLY   = 2,        
        eMAX        = 3,        
        eN_VALUES   = 4,        
        ePAD_32     = 0x7fffffff 
    };
};

class PxMaterial : public PxBase
{
public:

    virtual     void            release() = 0;

    virtual PxU32               getReferenceCount() const = 0;

    virtual void                acquireReference() = 0;

    virtual     void            setDynamicFriction(PxReal coef) = 0;

    virtual     PxReal          getDynamicFriction() const = 0;

    virtual     void            setStaticFriction(PxReal coef) = 0;

    virtual     PxReal          getStaticFriction() const = 0;

    virtual     void            setRestitution(PxReal rest) = 0;

    virtual     PxReal          getRestitution() const = 0;

    virtual     void            setFlag(PxMaterialFlag::Enum flag, bool b) = 0;

    virtual     void            setFlags(PxMaterialFlags flags) = 0;

    virtual     PxMaterialFlags getFlags() const = 0;

    virtual     void            setFrictionCombineMode(PxCombineMode::Enum combMode) = 0;

    virtual     PxCombineMode::Enum getFrictionCombineMode() const = 0;

    virtual     void            setRestitutionCombineMode(PxCombineMode::Enum combMode) = 0;

    virtual     PxCombineMode::Enum getRestitutionCombineMode() const = 0;

    //public variables:
                void*           userData;   

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

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

};

#if !PX_DOXYGEN
} // namespace physx
#endif

#endif