include/PxMaterial.h

File members: include/PxMaterial.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) 2008-2024 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_MATERIAL_H
#define PX_MATERIAL_H

#include "PxBaseMaterial.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,

        eCOMPLIANT_CONTACT PX_DEPRECATED = 1 << 3,

        eCOMPLIANT_ACCELERATION_SPRING = 1 << 4
    };
};

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 PxBaseMaterial
{
public:

    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    setDamping(PxReal damping) = 0;

    virtual     PxReal  getDamping() 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;

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

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

    // PxBase
    virtual     const char* getConcreteTypeName() const PX_OVERRIDE { return "PxMaterial"; }
    //~PxBase

protected:
    PX_INLINE           PxMaterial(PxType concreteType, PxBaseFlags baseFlags) : PxBaseMaterial(concreteType, baseFlags)    {}
    PX_INLINE           PxMaterial(PxBaseFlags baseFlags) : PxBaseMaterial(baseFlags) {}
    virtual             ~PxMaterial() {}
    virtual     bool    isKindOf(const char* name) const { PX_IS_KIND_OF(name, "PxMaterial", PxBaseMaterial); }
};

#if !PX_DOXYGEN
} // namespace physx
#endif

#endif