PhysX SDK 3.2 API Reference: PxVehicleDrivableSurfaceToTireFrictionPairs Class Reference

PhysX SDK 3.2 API

PxVehicleDrivableSurfaceToTireFrictionPairs Class Reference
[Vehicle]

Friction for each combination of driving surface type and tire type. More...

#include <PxVehicleTireFriction.h>

Collaboration diagram for PxVehicleDrivableSurfaceToTireFrictionPairs:

List of all members.


Public Types

enum  { eMAX_NUM_SURFACE_TYPES = 256 }

Public Member Functions

void release ()
 Deallocate a PxVehicleDrivableSurfaceToTireFrictionPairs instance.
void setTypePairFriction (const PxU32 surfaceType, const PxU32 tireType, const PxReal value)
 Return the friction for a specified pair of tire/drivable surface type pair.
PxReal getTypePairFriction (const PxU32 surfaceType, const PxU32 tireType) const
 Return the friction for a specified pair of tire/drivable surface type pair.

Static Public Member Functions

static
PxVehicleDrivableSurfaceToTireFrictionPairs
create (const PxU32 maxNumTireTypes, const PxU32 maxNumSurfaceTypes, const PxMaterial **drivableSurfaceMaterials, const PxVehicleDrivableSurfaceType *drivableSurfaceTypes)
 Create a PxVehicleDrivableSurfaceToTireFrictionPairs instance.

Private Member Functions

 PxVehicleDrivableSurfaceToTireFrictionPairs ()
 ~PxVehicleDrivableSurfaceToTireFrictionPairs ()

Private Attributes

PxRealmPairs
 Ptr to base address of a 2d PxReal array with dimensions [mNumSurfaceTypes][mNumTireTypes].
const PxMaterial ** mDrivableSurfaceMaterials
 Ptr to 1d array of material ptrs that is of length mNumSurfaceTypes.
PxVehicleDrivableSurfaceTypemDrivableSurfaceTypes
 Ptr to 1d array of PxVehicleDrivableSurfaceType that is of length mNumSurfaceTypes.
PxU32 mNumSurfaceTypes
 Total number of different driving surface types.
PxU32 mNumTireTypes
 Total number of different tire types.
PxU32 mPad [3]

Friends

class VehicleSurfaceTypeHashTable

Detailed Description

Friction for each combination of driving surface type and tire type.

Member Enumeration Documentation

anonymous enum

Enumerator:
eMAX_NUM_SURFACE_TYPES 


Constructor & Destructor Documentation

PxVehicleDrivableSurfaceToTireFrictionPairs::PxVehicleDrivableSurfaceToTireFrictionPairs (  )  [inline, private]

PxVehicleDrivableSurfaceToTireFrictionPairs::~PxVehicleDrivableSurfaceToTireFrictionPairs (  )  [inline, private]


Member Function Documentation

static PxVehicleDrivableSurfaceToTireFrictionPairs* PxVehicleDrivableSurfaceToTireFrictionPairs::create ( const PxU32  maxNumTireTypes,
const PxU32  maxNumSurfaceTypes,
const PxMaterial **  drivableSurfaceMaterials,
const PxVehicleDrivableSurfaceType drivableSurfaceTypes 
) [static]

Create a PxVehicleDrivableSurfaceToTireFrictionPairs instance.

If the PxMaterial that touches the tire corresponds to drivableSurfaceMaterials[x] then the drivable surface type is drivableSurfaceTypes[x].mType The friction of each surface-type/tire-type pair is determined by the corresponding value set by setTypePairFriction. If no value has been set by setTypePairFriction than a default value of 1.0 is used.

See also:
release, setTypePairFriction, getTypePairFriction

PxReal PxVehicleDrivableSurfaceToTireFrictionPairs::getTypePairFriction ( const PxU32  surfaceType,
const PxU32  tireType 
) const

Return the friction for a specified pair of tire/drivable surface type pair.

void PxVehicleDrivableSurfaceToTireFrictionPairs::release (  ) 

void PxVehicleDrivableSurfaceToTireFrictionPairs::setTypePairFriction ( const PxU32  surfaceType,
const PxU32  tireType,
const PxReal  value 
)

Return the friction for a specified pair of tire/drivable surface type pair.


Friends And Related Function Documentation

friend class VehicleSurfaceTypeHashTable [friend]


Member Data Documentation

Ptr to 1d array of material ptrs that is of length mNumSurfaceTypes.

If the PxMaterial that touches the tire corresponds to mDrivableSurfaceMaterials[x] then the drivable surface type is mDrivableSurfaceTypes[x].mType and the friction for that contact is mPairs[mDrivableSurfaceTypes[x].mType][y], assuming a tire type y. If the PxMaterial that touches the tire is not found in mDrivableSurfaceMaterials then the friction is mPairs[0][y], assuming a tire type y.

Ptr to 1d array of PxVehicleDrivableSurfaceType that is of length mNumSurfaceTypes.

If the PxMaterial that touches the tire is found in mDrivableSurfaceMaterials[x] then the drivable surface type is mDrivableSurfaceTypes[x].mType and the friction for that contact is mPairs[mDrivableSurfaceTypes[x].mType][y], assuming a tire type y. If the PxMaterial that touches the tire is not found in mDrivableSurfaceMaterials then the friction is mPairs[0][y], assuming a tire type y.

Total number of different driving surface types.

mDrivableSurfaceMaterials and mDrivableSurfaceTypes are both 1d arrays of length mNumSurfaceTypes. mNumSurfaceTypes must be less than or equal to eMAX_NUM_SURFACE_TYPES.

Total number of different tire types.

Tire types stored in PxVehicleTireData.mType mNumTireTypes must be a multiple of 4.

Ptr to base address of a 2d PxReal array with dimensions [mNumSurfaceTypes][mNumTireTypes].

Each element of the array describes the maximum friction provided by a surface type-tire type combination. eg the friction corresponding to a combination of surface type x and tire type y is mPairs[x][y]


The documentation for this class was generated from the following file:



Copyright © 2008-2012 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com