include/extensions/PxRevoluteJoint.h

File members: include/extensions/PxRevoluteJoint.h

// 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-2024 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_REVOLUTE_JOINT_H
#define PX_REVOLUTE_JOINT_H

#include "extensions/PxJoint.h"
#include "extensions/PxJointLimit.h"

#if !PX_DOXYGEN
namespace physx
{
#endif

class PxRevoluteJoint;

PxRevoluteJoint*    PxRevoluteJointCreate(PxPhysics& physics, PxRigidActor* actor0, const PxTransform& localFrame0, PxRigidActor* actor1, const PxTransform& localFrame1);

struct PxRevoluteJointFlag
{
    enum Enum
    {
        eLIMIT_ENABLED  = 1<<0,
        eDRIVE_ENABLED  = 1<<1,
        eDRIVE_FREESPIN = 1<<2
    };
};

typedef PxFlags<PxRevoluteJointFlag::Enum, PxU16> PxRevoluteJointFlags;
PX_FLAGS_OPERATORS(PxRevoluteJointFlag::Enum, PxU16)

class PxRevoluteJoint : public PxJoint
{
public:

    virtual PxReal getAngle()   const   = 0;

    virtual PxReal getVelocity()    const   = 0;

    virtual void            setLimit(const PxJointAngularLimitPair& limits) = 0;

    virtual PxJointAngularLimitPair getLimit()  const   = 0;

    virtual void            setDriveVelocity(PxReal velocity, bool autowake = true) = 0;

    virtual PxReal          getDriveVelocity()  const   = 0;

    virtual void            setDriveForceLimit(PxReal limit)    = 0;

    virtual PxReal          getDriveForceLimit()    const   = 0;

    virtual void            setDriveGearRatio(PxReal ratio) = 0;

    virtual PxReal          getDriveGearRatio()     const   = 0;

    virtual void            setRevoluteJointFlags(PxRevoluteJointFlags flags) = 0;

    virtual void            setRevoluteJointFlag(PxRevoluteJointFlag::Enum flag, bool value) = 0;

    virtual PxRevoluteJointFlags    getRevoluteJointFlags() const   = 0;

    virtual const char*         getConcreteTypeName() const PX_OVERRIDE { return "PxRevoluteJoint"; }

protected:

    //serialization

    PX_INLINE                   PxRevoluteJoint(PxType concreteType, PxBaseFlags baseFlags) : PxJoint(concreteType, baseFlags) {}

    PX_INLINE                   PxRevoluteJoint(PxBaseFlags baseFlags) : PxJoint(baseFlags) {}

    virtual bool                isKindOf(const char* name) const { PX_IS_KIND_OF(name, "PxRevoluteJoint", PxJoint); }

    //~serialization
};

#if !PX_DOXYGEN
} // namespace physx
#endif

#endif