PxVehicleTireFriction.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-2022 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_VEHICLE_TIREFRICTION_H
#define PX_VEHICLE_TIREFRICTION_H
 
#include "foundation/PxSimpleTypes.h"
#include "common/PxSerialFramework.h"
 
#if !PX_DOXYGEN
namespace physx
{
#endif
 
class PxMaterial;
class PxCollection;
class PxOutputStream;
 
struct PX_DEPRECATED PxVehicleDrivableSurfaceType
{
    enum
    {
        eSURFACE_TYPE_UNKNOWN=0xffffffff
    };
    PxU32 mType;
};
 
class PX_DEPRECATED PxVehicleDrivableSurfaceToTireFrictionPairs
{
public:
 
    friend class VehicleSurfaceTypeHashTable;
 
    enum
    {
        eMAX_NB_SURFACE_TYPES=256
    };
 
    static PxVehicleDrivableSurfaceToTireFrictionPairs* allocate
        (const PxU32 maxNbTireTypes, const PxU32 maxNbSurfaceTypes);
 
    void setup
        (const PxU32 nbTireTypes, const PxU32 nbSurfaceTypes, 
         const PxMaterial** drivableSurfaceMaterials, const PxVehicleDrivableSurfaceType* drivableSurfaceTypes);
 
    void release();
 
    void setTypePairFriction(const PxU32 surfaceType, const PxU32 tireType, const PxReal value);
 
 
    PxU32 getSurfaceType(const PxMaterial& surfaceMaterial) const;
 
    PxReal getTypePairFriction(const PxU32 surfaceType, const PxU32 tireType) const;
 
    PxReal getTypePairFriction(const PxMaterial& surfaceMaterial, const PxU32 tireType) const;
 
    PX_FORCE_INLINE PxU32 getMaxNbSurfaceTypes() const {return mMaxNbSurfaceTypes;}
 
    PX_FORCE_INLINE PxU32 getMaxNbTireTypes() const {return mMaxNbTireTypes;}
 
    static void serializeToBinary(const PxVehicleDrivableSurfaceToTireFrictionPairs& frictionTable, const PxSerialObjectId* materialIds, const PxU32 nbMaterialIds, PxCollection* collection, PxOutputStream& stream);
 
    static PxVehicleDrivableSurfaceToTireFrictionPairs* deserializeFromBinary(const PxCollection& collection, void* memBlock);
 
private:
 
    PxReal* mPairs;                 
 
    const PxMaterial** mDrivableSurfaceMaterials;
 
    PxVehicleDrivableSurfaceType* mDrivableSurfaceTypes;
 
    PxSerialObjectId* mMaterialSerialIds;
 
    PxU32 mNbSurfaceTypes;          
 
    PxU32 mMaxNbSurfaceTypes;           
 
    PxU32 mNbTireTypes;         
 
    PxU32 mMaxNbTireTypes;          
 
    PxVehicleDrivableSurfaceToTireFrictionPairs(){}
    ~PxVehicleDrivableSurfaceToTireFrictionPairs(){}
};
PX_COMPILE_TIME_ASSERT(0==(sizeof(PxVehicleDrivableSurfaceToTireFrictionPairs) & 15));
 
#if !PX_DOXYGEN
} // namespace physx
#endif
 
#endif