From 3dfe2108cfab31ba3ee5527e217d0d8e99a51162 Mon Sep 17 00:00:00 2001 From: git perforce import user Date: Tue, 25 Oct 2016 12:29:14 -0600 Subject: Initial commit: PhysX 3.4.0 Update @ 21294896 APEX 1.4.0 Update @ 21275617 [CL 21300167] --- .../files/classPxVehicleWheelsDynData.html | 836 +++++++++++++++++++++ 1 file changed, 836 insertions(+) create mode 100644 PhysX_3.4/Documentation/PhysXAPI/files/classPxVehicleWheelsDynData.html (limited to 'PhysX_3.4/Documentation/PhysXAPI/files/classPxVehicleWheelsDynData.html') diff --git a/PhysX_3.4/Documentation/PhysXAPI/files/classPxVehicleWheelsDynData.html b/PhysX_3.4/Documentation/PhysXAPI/files/classPxVehicleWheelsDynData.html new file mode 100644 index 00000000..fdfa6903 --- /dev/null +++ b/PhysX_3.4/Documentation/PhysXAPI/files/classPxVehicleWheelsDynData.html @@ -0,0 +1,836 @@ + + + NVIDIA(R) PhysX(R) SDK 3.4 API Reference: PxVehicleWheelsDynData Class Reference + + + + + + + +
+

PxVehicleWheelsDynData Class Reference
+ +[Vehicle] +

Data structure with instanced dynamics data for wheels. +More... +

+#include <PxVehicleWheels.h> +

+ +

+List of all members. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Public Member Functions

 PxVehicleWheelsDynData ()
 ~PxVehicleWheelsDynData ()
void setToRestState ()
 Set all wheels to their rest state.
void setTireForceShaderFunction (PxVehicleComputeTireForce tireForceShaderFn)
 Set the tire force shader function.
void setTireForceShaderData (const PxU32 tireId, const void *tireForceShaderData)
 Set the tire force shader data for a specific tire.
const void * getTireForceShaderData (const PxU32 tireId) const
 Get the tire force shader data for a specific tire.
void setWheelRotationSpeed (const PxU32 wheelIdx, const PxReal speed)
 Set the wheel rotation speed (radians per second) about the rolling axis for the specified wheel.
PxReal getWheelRotationSpeed (const PxU32 wheelIdx) const
 Return the rotation speed about the rolling axis of a specified wheel .
void setWheelRotationAngle (const PxU32 wheelIdx, const PxReal angle)
 Set the wheel rotation angle (radians) about the rolling axis of the specified wheel.
PxReal getWheelRotationAngle (const PxU32 wheelIdx) const
 Return the rotation angle about the rolling axis for the specified wheel.
void setUserData (const PxU32 tireIdx, void *userData)
 Set the user data pointer for the specified wheel It has a default value of NULL.
void * getUserData (const PxU32 tireIdx) const
 Get the user data pointer that was set for the specified wheel.
void copy (const PxVehicleWheelsDynData &src, const PxU32 srcWheel, const PxU32 trgWheel)
 Copy the dynamics data of a single wheel unit (wheel, suspension, tire) from srcWheel of src to trgWheel.
PxU32 getNbWheelRotationSpeed () const
PxU32 getNbWheelRotationAngle () const
PxVehicleWheels4DynData * getWheel4DynData () const

Static Public Member Functions

static void getBinaryMetaData (PxOutputStream &stream)

Private Member Functions

bool isValid () const
 Test if wheel dynamics data have legal values.
 PxVehicleWheelsDynData (const PxU32 numWheels)

Static Private Member Functions

static PxU32 computeByteSize (const PxU32 numWheels)
 see PxVehicleWheels::allocate
static PxU8 * patchUpPointers (const PxU32 numWheels, PxVehicleWheelsDynData *dynData, PxU8 *ptr)

Private Attributes

PxVehicleWheels4DynData * mWheels4DynData
 Dynamics data arranged in blocks of 4 wheels.
PxVehicleTireForceCalculator * mTireForceCalculators
 Shader data and function for tire force calculations.
void ** mUserDatas
 A userData pointer can be stored for each wheel.
PxU32 mNbWheels4
 Number of blocks of 4 wheels.
PxU32 mNbActiveWheels
 Number of wheels (mNbActiveWheels <= (mNbWheels4*4)).
PxU32 mPad [3]

Friends

class PxVehicleWheels
class PxVehicleDrive4W
class PxVehicleDriveTank
class PxVehicleUpdate
+

Detailed Description

+Data structure with instanced dynamics data for wheels.

Constructor & Destructor Documentation

+ +
+
+ + + + + + + + +
PxVehicleWheelsDynData::PxVehicleWheelsDynData (  )  [inline]
+
+
+ +

+ +

+

+ +

+
+ + + + + + + + +
PxVehicleWheelsDynData::~PxVehicleWheelsDynData (  )  [inline]
+
+
+ +

+ +

+

+ +

+
+ + + + + + + + + +
PxVehicleWheelsDynData::PxVehicleWheelsDynData (const PxU32  numWheels  )  [private]
+
+
+ +

+ +

+

+

Member Function Documentation

+ +
+
+ + + + + + + + + +
static PxU32 PxVehicleWheelsDynData::computeByteSize (const PxU32  numWheels  )  [static, private]
+
+
+ +

+see PxVehicleWheels::allocate +

+ +

+

+ +

+
+ + + + + + + + + + + + + + + + + + + + + + + + +
void PxVehicleWheelsDynData::copy (const PxVehicleWheelsDynData &  src,
const PxU32  srcWheel,
const PxU32  trgWheel 
)
+
+
+ +

+Copy the dynamics data of a single wheel unit (wheel, suspension, tire) from srcWheel of src to trgWheel. +

+

Parameters:
+ + + + +
[in] src is the data to be copied.
[in] srcWheel is the wheel whose data will be copied from src.
[in] trgWheel is the wheel that will be assigned the copied data.
+
+ +
+

+ +

+
+ + + + + + + + + +
static void PxVehicleWheelsDynData::getBinaryMetaData (PxOutputStream &  stream  )  [static]
+
+
+ +

+ +

+

+ +

+
+ + + + + + + + +
PxU32 PxVehicleWheelsDynData::getNbWheelRotationAngle (  )  const [inline]
+
+
+ +

+ +

+

+ +

+
+ + + + + + + + +
PxU32 PxVehicleWheelsDynData::getNbWheelRotationSpeed (  )  const [inline]
+
+
+ +

+ +

+

+ +

+
+ + + + + + + + + +
const void* PxVehicleWheelsDynData::getTireForceShaderData (const PxU32  tireId  )  const
+
+
+ +

+Get the tire force shader data for a specific tire. +

+ +

+

+ +

+
+ + + + + + + + + +
void* PxVehicleWheelsDynData::getUserData (const PxU32  tireIdx  )  const
+
+
+ +

+Get the user data pointer that was set for the specified wheel. +

+ +

+

+ +

+
+ + + + + + + + +
PxVehicleWheels4DynData* PxVehicleWheelsDynData::getWheel4DynData (  )  const [inline]
+
+
+ +

+ +

+

+ +

+
+ + + + + + + + + +
PxReal PxVehicleWheelsDynData::getWheelRotationAngle (const PxU32  wheelIdx  )  const
+
+
+ +

+Return the rotation angle about the rolling axis for the specified wheel. +

+ +

+

+ +

+
+ + + + + + + + + +
PxReal PxVehicleWheelsDynData::getWheelRotationSpeed (const PxU32  wheelIdx  )  const
+
+
+ +

+Return the rotation speed about the rolling axis of a specified wheel . +

+ +

+

+ +

+
+ + + + + + + + +
bool PxVehicleWheelsDynData::isValid (  )  const [private]
+
+
+ +

+Test if wheel dynamics data have legal values. +

+ +

+

+ +

+
+ + + + + + + + + + + + + + + + + + + + + + + + +
static PxU8* PxVehicleWheelsDynData::patchUpPointers (const PxU32  numWheels,
PxVehicleWheelsDynData *  dynData,
PxU8 *  ptr 
) [static, private]
+
+
+ +

+ +

+

+ +

+
+ + + + + + + + + + + + + + + + + + +
void PxVehicleWheelsDynData::setTireForceShaderData (const PxU32  tireId,
const void *  tireForceShaderData 
)
+
+
+ +

+Set the tire force shader data for a specific tire. +

+

Parameters:
+ + + +
[in] tireId is the wheel index
[in] tireForceShaderData is the data describing the tire.
+
+ +
+

+ +

+
+ + + + + + + + + +
void PxVehicleWheelsDynData::setTireForceShaderFunction (PxVehicleComputeTireForce  tireForceShaderFn  ) 
+
+
+ +

+Set the tire force shader function. +

+

Parameters:
+ + +
[in] tireForceShaderFn is the shader function that will be used to compute tire forces.
+
+ +
+

+ +

+
+ + + + + + + + +
void PxVehicleWheelsDynData::setToRestState (  ) 
+
+
+ +

+Set all wheels to their rest state. +

+

See also:
setup
+ +
+

+ +

+
+ + + + + + + + + + + + + + + + + + +
void PxVehicleWheelsDynData::setUserData (const PxU32  tireIdx,
void *  userData 
)
+
+
+ +

+Set the user data pointer for the specified wheel It has a default value of NULL. +

+

Parameters:
+ + + +
[in] tireIdx is the wheel index
[in] userData is the data to be associated with the wheel.
+
+ +
+

+ +

+
+ + + + + + + + + + + + + + + + + + +
void PxVehicleWheelsDynData::setWheelRotationAngle (const PxU32  wheelIdx,
const PxReal  angle 
)
+
+
+ +

+Set the wheel rotation angle (radians) about the rolling axis of the specified wheel. +

+

Parameters:
+ + + +
[in] wheelIdx is the wheel index
[in] angle is the rotation angle to be applied to the wheel.
+
+ +
+

+ +

+
+ + + + + + + + + + + + + + + + + + +
void PxVehicleWheelsDynData::setWheelRotationSpeed (const PxU32  wheelIdx,
const PxReal  speed 
)
+
+
+ +

+Set the wheel rotation speed (radians per second) about the rolling axis for the specified wheel. +

+

Parameters:
+ + + +
[in] wheelIdx is the wheel index
[in] speed is the rotation speed to be applied to the wheel.
+
+ +
+

+

Friends And Related Function Documentation

+ +
+
+ + + + +
friend class PxVehicleDrive4W [friend]
+
+
+ +

+ +

+

+ +

+
+ + + + +
friend class PxVehicleDriveTank [friend]
+
+
+ +

+ +

+

+ +

+
+ + + + +
friend class PxVehicleUpdate [friend]
+
+
+ +

+ +

+

+ +

+
+ + + + +
friend class PxVehicleWheels [friend]
+
+
+ +

+ +

+

+

Member Data Documentation

+ +
+
+ + + + +
PxU32 PxVehicleWheelsDynData::mNbActiveWheels [private]
+
+
+ +

+Number of wheels (mNbActiveWheels <= (mNbWheels4*4)). +

+ +

+

+ +

+
+ + + + +
PxU32 PxVehicleWheelsDynData::mNbWheels4 [private]
+
+
+ +

+Number of blocks of 4 wheels. +

+ +

+

+ +

+
+ + + + +
PxU32 PxVehicleWheelsDynData::mPad[3] [private]
+
+
+ +

+ +

+

+ +

+
+ + + + +
PxVehicleTireForceCalculator* PxVehicleWheelsDynData::mTireForceCalculators [private]
+
+
+ +

+Shader data and function for tire force calculations. +

+ +

+

+ +

+
+ + + + +
void** PxVehicleWheelsDynData::mUserDatas [private]
+
+
+ +

+A userData pointer can be stored for each wheel. +

+

See also:
setUserData, getUserData
+ +
+

+ +

+
+ + + + +
PxVehicleWheels4DynData* PxVehicleWheelsDynData::mWheels4DynData [private]
+
+
+ +

+Dynamics data arranged in blocks of 4 wheels. +

+ +

+

+

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

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