PxVehicleTireFriction.h
Go to the documentation of this file.
1 //
2 // Redistribution and use in source and binary forms, with or without
3 // modification, are permitted provided that the following conditions
4 // are met:
5 // * Redistributions of source code must retain the above copyright
6 // notice, this list of conditions and the following disclaimer.
7 // * Redistributions in binary form must reproduce the above copyright
8 // notice, this list of conditions and the following disclaimer in the
9 // documentation and/or other materials provided with the distribution.
10 // * Neither the name of NVIDIA CORPORATION nor the names of its
11 // contributors may be used to endorse or promote products derived
12 // from this software without specific prior written permission.
13 //
14 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS ``AS IS'' AND ANY
15 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
17 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
18 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
19 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
20 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
21 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
22 // OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
24 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25 //
26 // Copyright (c) 2008-2018 NVIDIA Corporation. All rights reserved.
27 // Copyright (c) 2004-2008 AGEIA Technologies, Inc. All rights reserved.
28 // Copyright (c) 2001-2004 NovodeX AG. All rights reserved.
29 
30 #ifndef PX_VEHICLE_TIREFRICTION_H
31 #define PX_VEHICLE_TIREFRICTION_H
32 
37 
38 #if !PX_DOXYGEN
39 namespace physx
40 {
41 #endif
42 
43 class PxMaterial;
44 
50 {
51  enum
52  {
53  eSURFACE_TYPE_UNKNOWN=0xffffffff
54  };
56 };
57 
63 {
64 public:
65 
66  friend class VehicleSurfaceTypeHashTable;
67 
68  enum
69  {
70  eMAX_NB_SURFACE_TYPES=256
71  };
72 
85  (const PxU32 maxNbTireTypes, const PxU32 maxNbSurfaceTypes);
86 
101  void setup
102  (const PxU32 nbTireTypes, const PxU32 nbSurfaceTypes,
103  const PxMaterial** drivableSurfaceMaterials, const PxVehicleDrivableSurfaceType* drivableSurfaceTypes);
104 
108  void release();
109 
117  void setTypePairFriction(const PxU32 surfaceType, const PxU32 tireType, const PxReal value);
118 
126  PxReal getTypePairFriction(const PxU32 surfaceType, const PxU32 tireType) const;
127 
133  PxU32 getMaxNbSurfaceTypes() const {return mMaxNbSurfaceTypes;}
134 
140  PxU32 getMaxNbTireTypes() const {return mMaxNbTireTypes;}
141 
142 private:
143 
151 
163 
175 
184 
191 
198 
205 
206 
207 #if !PX_P64_FAMILY
208  PxU32 mPad[1];
209 #else
210  PxU32 mPad[2];
211 #endif
212 
215 };
217 
218 #if !PX_DOXYGEN
219 } // namespace physx
220 #endif
221 
223 #endif //PX_VEHICLE_TIREFRICTION_H
Definition: GuContactBuffer.h:37
PxReal * mPairs
Ptr to base address of a 2d PxReal array with dimensions [mNbSurfaceTypes][mNbTireTypes].
Definition: PxVehicleTireFriction.h:150
~PxVehicleDrivableSurfaceToTireFrictionPairs()
Definition: PxVehicleTireFriction.h:214
Friction for each combination of driving surface type and tire type.
Definition: PxVehicleTireFriction.h:62
PxU32 mType
Definition: PxVehicleTireFriction.h:55
Driving surface type. Each PxMaterial is associated with a corresponding PxVehicleDrivableSurfaceType...
Definition: PxVehicleTireFriction.h:49
float PxReal
Definition: PxSimpleTypes.h:78
PxU32 mNbSurfaceTypes
Number of different driving surface types.
Definition: PxVehicleTireFriction.h:183
PxU32 getMaxNbTireTypes() const
Return the maximum number of tire types.
Definition: PxVehicleTireFriction.h:140
PxU32 mMaxNbTireTypes
Maximum number of different tire types.
Definition: PxVehicleTireFriction.h:204
PxU32 mNbTireTypes
Number of different tire types.
Definition: PxVehicleTireFriction.h:197
PxU32 mMaxNbSurfaceTypes
Maximum number of different driving surface types.
Definition: PxVehicleTireFriction.h:190
#define PX_COMPILE_TIME_ASSERT(exp)
Definition: PxPreprocessor.h:447
const PxMaterial ** mDrivableSurfaceMaterials
Ptr to 1d array of material ptrs that is of length mNbSurfaceTypes.
Definition: PxVehicleTireFriction.h:162
Material class to represent a set of surface properties.
Definition: PxMaterial.h:130
PxVehicleDrivableSurfaceToTireFrictionPairs()
Definition: PxVehicleTireFriction.h:213
uint32_t PxU32
Definition: Px.h:48
PxU32 getMaxNbSurfaceTypes() const
Return the maximum number of surface types.
Definition: PxVehicleTireFriction.h:133
PxVehicleDrivableSurfaceType * mDrivableSurfaceTypes
Ptr to 1d array of PxVehicleDrivableSurfaceType that is of length mNbSurfaceTypes.
Definition: PxVehicleTireFriction.h:174