PxVehicleUpdate.h

Go to the documentation of this file.

//
// 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-2021 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_UPDATE_H
#define PX_VEHICLE_UPDATE_H

#include "vehicle/PxVehicleSDK.h"
#include "vehicle/PxVehicleTireFriction.h"
#include "foundation/PxSimpleTypes.h"
#include "foundation/PxMemory.h"
#include "foundation/PxTransform.h"
#include "PxBatchQueryDesc.h"

#if !PX_DOXYGEN
namespace physx
{
#endif

    class PxBatchQuery;
    class PxContactModifyPair;
    class PxVehicleWheels;
    class PxVehicleDrivableSurfaceToTireFrictionPairs;
    class PxVehicleTelemetryData;

    struct PxWheelQueryResult
    {
        PxWheelQueryResult()
        {
            PxMemZero(this, sizeof(PxWheelQueryResult));
            isInAir=true;
            tireSurfaceType = PxU32(PxVehicleDrivableSurfaceType::eSURFACE_TYPE_UNKNOWN);
            localPose = PxTransform(PxIdentity);
        }

        PxVec3 suspLineStart;

        PxVec3 suspLineDir;

        PxReal suspLineLength;

        bool isInAir;

        PxActor* tireContactActor;

        PxShape* tireContactShape;

        const PxMaterial* tireSurfaceMaterial;

        PxU32 tireSurfaceType;

        PxVec3 tireContactPoint;

        PxVec3 tireContactNormal;

        PxReal tireFriction;

        PxReal suspJounce;

        PxReal suspSpringForce;

        PxVec3 tireLongitudinalDir;

        PxVec3 tireLateralDir;

        PxReal longitudinalSlip;

        PxReal lateralSlip;

        PxReal steerAngle;

        PxTransform localPose;
    };

    struct PxVehicleWheelQueryResult
    {
        PxWheelQueryResult* wheelQueryResults;

        PxU32 nbWheelQueryResults;
    };

    struct PxVehicleWheelConcurrentUpdateData
    {
        friend class PxVehicleUpdate;

        PxVehicleWheelConcurrentUpdateData()
            : localPose(PxTransform(PxIdentity)),
              hitActor(NULL),
              hitActorForce(PxVec3(0,0,0)),
              hitActorForcePosition(PxVec3(0,0,0))
        {
        }

    private:

        PxTransform localPose;
        PxRigidDynamic* hitActor;
        PxVec3 hitActorForce;
        PxVec3 hitActorForcePosition;
    };

    struct PxVehicleConcurrentUpdateData
    {
        friend class PxVehicleUpdate;

        PxVehicleConcurrentUpdateData()
            : concurrentWheelUpdates(NULL),
              nbConcurrentWheelUpdates(0),
              linearMomentumChange(PxVec3(0,0,0)),
              angularMomentumChange(PxVec3(0,0,0)),
              staySleeping(false),
              wakeup(false)
        {
        }

        PxVehicleWheelConcurrentUpdateData* concurrentWheelUpdates;

        PxU32 nbConcurrentWheelUpdates;

    private:

        PxVec3 linearMomentumChange;
        PxVec3 angularMomentumChange;
        bool staySleeping;
        bool wakeup;
    };

    void PxVehicleSuspensionRaycasts
        (PxBatchQuery* batchQuery, 
         const PxU32 nbVehicles, PxVehicleWheels** vehicles,
         const PxU32 nbSceneQueryResults, PxRaycastQueryResult* sceneQueryResults, 
         const bool* vehiclesToRaycast = NULL);


    void PxVehicleSuspensionSweeps
        (PxBatchQuery* batchQuery, 
         const PxU32 nbVehicles, PxVehicleWheels** vehicles, 
         const PxU32 nbSceneQueryResults, PxSweepQueryResult* sceneQueryResults,  const PxU16 nbHitsPerQuery, 
         const bool* vehiclesToSweep = NULL,
         const PxF32 sweepWidthScale = 1.0f, const PxF32 sweepRadiusScale = 1.0f, const PxF32 sweepInflation = 0.0f);

    PxU32 PxVehicleModifyWheelContacts
        (const PxVehicleWheels& vehicle, const PxU32 wheelId,
        const PxF32 wheelTangentVelocityMultiplier, const PxReal maxImpulse,
        PxContactModifyPair& contactModifyPair);


    void PxVehicleUpdates(
        const PxReal timestep, const PxVec3& gravity, 
        const PxVehicleDrivableSurfaceToTireFrictionPairs& vehicleDrivableSurfaceToTireFrictionPairs, 
        const PxU32 nbVehicles, PxVehicleWheels** vehicles, PxVehicleWheelQueryResult* vehicleWheelQueryResults, PxVehicleConcurrentUpdateData* vehicleConcurrentUpdates = NULL);


    void PxVehiclePostUpdates(
        const PxVehicleConcurrentUpdateData* vehicleConcurrentUpdates, const PxU32 nbVehicles, PxVehicleWheels** vehicles);


    void PxVehicleShiftOrigin(const PxVec3& shift, const PxU32 nbVehicles, PxVehicleWheels** vehicles);

#if PX_DEBUG_VEHICLE_ON

    void PxVehicleUpdateSingleVehicleAndStoreTelemetryData
        (const PxReal timestep, const PxVec3& gravity, 
         const PxVehicleDrivableSurfaceToTireFrictionPairs& vehicleDrivableSurfaceToTireFrictionPairs, 
         PxVehicleWheels* focusVehicle, PxVehicleWheelQueryResult* vehicleWheelQueryResults, 
         PxVehicleTelemetryData& telemetryData,
         PxVehicleConcurrentUpdateData* vehicleConcurrentUpdates = NULL);
#endif

#if !PX_DOXYGEN
} // namespace physx
#endif

#endif //PX_VEHICLE_UPDATE_H