PxArticulationJoint.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-2018 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_PHYSICS_NX_ARTICULATION_JOINT
#define PX_PHYSICS_NX_ARTICULATION_JOINT

#include "PxPhysXConfig.h"
#include "common/PxBase.h"

#if !PX_DOXYGEN
namespace physx
{
#endif

class PxArticulationJointImpl;

struct PxArticulationJointDriveType
{
    enum Enum
    {
        eTARGET = 0,            // use the quaternion as the drive target
        eERROR  = 1             // use the vector part of the quaternion as the drive error.
    };
};

struct PxArticulationAxis
{
    enum Enum
    {
        eTWIST = 0,
        eSWING1 = 1,
        eSWING2 = 2,
        eX = 3,
        eY = 4,
        eZ = 5,
        eCOUNT = 6
    };
};

PX_FLAGS_OPERATORS(PxArticulationAxis::Enum, PxU8)

struct PxArticulationMotion
{
    enum Enum
    {
        eLOCKED = 0,
        eLIMITED = 1,
        eFREE = 2
    };
};

typedef PxFlags<PxArticulationMotion::Enum, PxU8> PxArticulationMotions;
PX_FLAGS_OPERATORS(PxArticulationMotion::Enum, PxU8)

struct PxArticulationJointType
{
    enum Enum
    {
        ePRISMATIC = 0,
        eREVOLUTE = 1,
        eSPHERICAL = 2,
        eFIX = 3,
        eUNDEFINED = 4
    };
};


class PxArticulationJointBase : public PxBase
{
public:
    virtual     PxArticulationLink& getParentArticulationLink() const = 0;

    virtual     void            setParentPose(const PxTransform& pose) = 0;

    virtual     PxTransform     getParentPose() const = 0;

    virtual     PxArticulationLink& getChildArticulationLink() const = 0;


    virtual     void            setChildPose(const PxTransform& pose) = 0;

    virtual     PxTransform     getChildPose() const = 0;

    virtual     PxArticulationJointImpl* getImpl() = 0;
    virtual     const PxArticulationJointImpl* getImpl() const = 0;

    virtual                     ~PxArticulationJointBase() {}

private:
protected:
    PX_INLINE                   PxArticulationJointBase(PxType concreteType, PxBaseFlags baseFlags) : PxBase(concreteType, baseFlags) {}
    PX_INLINE                   PxArticulationJointBase(PxBaseFlags baseFlags) : PxBase(baseFlags) {}
    
    virtual     bool            isKindOf(const char* name)  const { return !::strcmp("PxArticulationJointBase", name) || PxBase::isKindOf(name); }
};



class PxArticulationJoint : public PxArticulationJointBase
{
public:

    virtual     void            setTargetOrientation(const PxQuat& orientation) = 0;

    virtual     PxQuat          getTargetOrientation() const = 0;

    virtual     void            setTargetVelocity(const PxVec3& velocity) = 0;

    virtual     PxVec3          getTargetVelocity() const = 0;


    virtual     void            setDriveType(PxArticulationJointDriveType::Enum driveType) = 0;

    virtual     PxArticulationJointDriveType::Enum
                                getDriveType() const = 0;


    
    virtual     void            setStiffness(PxReal spring) = 0;

    virtual     PxReal          getStiffness() const = 0;


    virtual     void            setDamping(PxReal damping) = 0;

    virtual     PxReal          getDamping() const = 0;

    virtual     void            setInternalCompliance(PxReal compliance) = 0;


    virtual     PxReal          getInternalCompliance() const = 0;

    virtual     void            setExternalCompliance(PxReal compliance) = 0;

    virtual     PxReal          getExternalCompliance() const = 0;



    virtual     void            setSwingLimit(PxReal zLimit, PxReal yLimit) = 0;


    virtual     void            getSwingLimit(PxReal& zLimit, PxReal& yLimit) const = 0;



    virtual     void            setTangentialStiffness(PxReal spring) = 0;


    virtual     PxReal          getTangentialStiffness() const = 0;


    virtual     void            setTangentialDamping(PxReal damping) = 0;


    virtual     PxReal          getTangentialDamping() const = 0;


    virtual     void            setSwingLimitContactDistance(PxReal contactDistance) = 0;


    virtual     PxReal          getSwingLimitContactDistance() const = 0;



    virtual     void            setSwingLimitEnabled(bool enabled) = 0;

    virtual     bool            getSwingLimitEnabled() const = 0;


    virtual     void            setTwistLimit(PxReal lower, PxReal upper) = 0;

    virtual     void            getTwistLimit(PxReal &lower, PxReal &upper) const = 0;

    virtual     void            setTwistLimitEnabled(bool enabled) = 0;

    virtual     bool            getTwistLimitEnabled() const = 0;


    virtual     void            setTwistLimitContactDistance(PxReal contactDistance) = 0;


    virtual     PxReal          getTwistLimitContactDistance() const = 0;

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

protected:
    PX_INLINE                   PxArticulationJoint(PxType concreteType, PxBaseFlags baseFlags) : PxArticulationJointBase(concreteType, baseFlags) {}
    PX_INLINE                   PxArticulationJoint(PxBaseFlags baseFlags) : PxArticulationJointBase(baseFlags) {}
    virtual                     ~PxArticulationJoint() {}
    virtual     bool            isKindOf(const char* name)  const       {   return !::strcmp("PxArticulationJoint", name) || PxArticulationJointBase::isKindOf(name); }
};

#if !PX_DOXYGEN
} // namespace physx
#endif

#endif