PxVehicleDriveNW.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_NWDRIVE_H
#define PX_VEHICLE_NWDRIVE_H

#include "vehicle/PxVehicleDrive.h"
#include "vehicle/PxVehicleWheels.h"
#include "vehicle/PxVehicleComponents.h"

#if !PX_DOXYGEN
namespace physx
{
#endif

struct PxFilterData;
class PxGeometry;
class PxPhysics;
class PxVehicleDrivableSurfaceToTireFrictionPairs;
class PxShape;
class PxMaterial;
class PxRigidDynamic;

class PxVehicleDriveSimDataNW : public PxVehicleDriveSimData
{
//= ATTENTION! =====================================================================================
// Changing the data layout of this class breaks the binary serialization format.  See comments for 
// PX_BINARY_SERIAL_VERSION.  If a modification is required, please adjust the getBinaryMetaData 
// function.  If the modification is made on a custom branch, please change PX_BINARY_SERIAL_VERSION
// accordingly.
//==================================================================================================
public:

    friend class PxVehicleDriveNW;

    PxVehicleDriveSimDataNW() 
        : PxVehicleDriveSimData()
    {
    }

    const PxVehicleDifferentialNWData& getDiffData()  const
    {
        return mDiff;
    }

    void setDiffData(const PxVehicleDifferentialNWData& diff);

private:

    PxVehicleDifferentialNWData mDiff;

    bool isValid() const;

//serialization
public:
    PxVehicleDriveSimDataNW(const PxEMPTY) : PxVehicleDriveSimData(PxEmpty), mDiff(PxEmpty) {}
    static void getBinaryMetaData(PxOutputStream& stream);
//~serialization
};
PX_COMPILE_TIME_ASSERT(0==(sizeof(PxVehicleDriveSimDataNW) & 15));


struct PxVehicleDriveNWControl
{
    enum Enum
    {
        eANALOG_INPUT_ACCEL=0,
        eANALOG_INPUT_BRAKE,        
        eANALOG_INPUT_HANDBRAKE,    
        eANALOG_INPUT_STEER_LEFT,   
        eANALOG_INPUT_STEER_RIGHT,  
        eMAX_NB_DRIVENW_ANALOG_INPUTS
    };
};

class PxVehicleDriveNW : public PxVehicleDrive
{
//= ATTENTION! =====================================================================================
// Changing the data layout of this class breaks the binary serialization format.  See comments for 
// PX_BINARY_SERIAL_VERSION.  If a modification is required, please adjust the getBinaryMetaData 
// function.  If the modification is made on a custom branch, please change PX_BINARY_SERIAL_VERSION
// accordingly.
//==================================================================================================
public:

    friend class PxVehicleUpdate;

    static PxVehicleDriveNW* allocate(const PxU32 nbWheels);

    void free();

    void setup
        (PxPhysics* physics, PxRigidDynamic* vehActor,
         const PxVehicleWheelsSimData& wheelsData, const PxVehicleDriveSimDataNW& driveData,
         const PxU32 nbWheels);

    static PxVehicleDriveNW* create
        (PxPhysics* physics, PxRigidDynamic* vehActor,
         const PxVehicleWheelsSimData& wheelsData, const PxVehicleDriveSimDataNW& driveData,
         const PxU32 nbWheels);

    void setToRestState();

    PxVehicleDriveSimDataNW mDriveSimData;

private:

    bool isValid() const;

//serialization
public:
                                PxVehicleDriveNW(PxBaseFlags baseFlags) : PxVehicleDrive(baseFlags), mDriveSimData(PxEmpty) {}
                                PxVehicleDriveNW();
                                ~PxVehicleDriveNW(){}
    static  PxVehicleDriveNW*   createObject(PxU8*& address, PxDeserializationContext& context);
    static  void                getBinaryMetaData(PxOutputStream& stream);
    virtual const char*         getConcreteTypeName() const         { return "PxVehicleDriveNW";    }
    virtual bool                isKindOf(const char* name)  const   { return !::strcmp("PxVehicleDriveNW", name) || PxBase::isKindOf(name); }
//~serialization
};
PX_COMPILE_TIME_ASSERT(0==(sizeof(PxVehicleDriveNW) & 15));



#if !PX_DOXYGEN
} // namespace physx
#endif

#endif //PX_VEHICLE_NWDRIVE_H