PxVehicleNoDrive.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_NO_DRIVE_H
#define PX_VEHICLE_NO_DRIVE_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 PxVehicleNoDrive : public PxVehicleWheels
{
//= 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 PxVehicleNoDrive* allocate(const PxU32 nbWheels);

    void free();

    void setup
        (PxPhysics* physics, PxRigidDynamic* vehActor, const PxVehicleWheelsSimData& wheelsData);

    static PxVehicleNoDrive* create
        (PxPhysics* physics, PxRigidDynamic* vehActor, const PxVehicleWheelsSimData& wheelsData);

    void setToRestState();

    void setBrakeTorque(const PxU32 id, const PxReal brakeTorque);

    void setDriveTorque(const PxU32 id, const PxReal driveTorque);

    void setSteerAngle(const PxU32 id, const PxReal steerAngle);

    PxReal getBrakeTorque(const PxU32 id) const;

    PxReal getDriveTorque(const PxU32 id) const;

    PxReal getSteerAngle(const PxU32 id) const;
        
private:

    PxReal* mSteerAngles;
    PxReal* mDriveTorques;
    PxReal* mBrakeTorques;

#if PX_P64_FAMILY
    PxU32 mPad[2];
#else 
    PxU32 mPad[1];
#endif

    bool isValid() const;


//serialization
public:
                                    PxVehicleNoDrive(PxBaseFlags baseFlags) : PxVehicleWheels(baseFlags) {} 
    virtual     void                exportExtraData(PxSerializationContext&);
                void                importExtraData(PxDeserializationContext&);
    static      PxVehicleNoDrive*   createObject(PxU8*& address, PxDeserializationContext& context);
    static      void                getBinaryMetaData(PxOutputStream& stream);
    virtual     const char*         getConcreteTypeName() const         { return "PxVehicleNoDrive";    }
    virtual     bool                isKindOf(const char* name)  const   { return !::strcmp("PxVehicleNoDrive", name) || PxBase::isKindOf(name); }
                PxU32               getNbSteerAngle() const { return mWheelsSimData.getNbWheels();  }
                PxU32               getNbDriveTorque() const    { return mWheelsSimData.getNbWheels();  }
                PxU32               getNbBrakeTorque() const    { return mWheelsSimData.getNbWheels();  }
protected:
                                    PxVehicleNoDrive();
                                    ~PxVehicleNoDrive() {}
//~serialization
};
PX_COMPILE_TIME_ASSERT(0==(sizeof(PxVehicleNoDrive) & 15));

#if !PX_DOXYGEN
} // namespace physx
#endif

#endif //PX_VEHICLE_NO_DRIVE_H