PxDistanceJoint.h

Go to the documentation of this file.

/*
 * Copyright (c) 2008-2015, NVIDIA CORPORATION.  All rights reserved.
 *
 * NVIDIA CORPORATION and its licensors retain all intellectual property
 * and proprietary rights in and to this software, related documentation
 * and any modifications thereto.  Any use, reproduction, disclosure or
 * distribution of this software and related documentation without an express
 * license agreement from NVIDIA CORPORATION is strictly prohibited.
 */
// Copyright (c) 2004-2008 AGEIA Technologies, Inc. All rights reserved.
// Copyright (c) 2001-2004 NovodeX AG. All rights reserved.  


#ifndef PX_DISTANCEJOINT_H
#define PX_DISTANCEJOINT_H

#include "extensions/PxJoint.h"

#ifndef PX_DOXYGEN
namespace physx
{
#endif

class PxDistanceJoint;

PxDistanceJoint*    PxDistanceJointCreate(PxPhysics& physics, 
                                          PxRigidActor* actor0, const PxTransform& localFrame0, 
                                          PxRigidActor* actor1, const PxTransform& localFrame1);


struct PxDistanceJointFlag
{
    enum Enum
    {
        eMAX_DISTANCE_ENABLED   = 1<<1,
        eMIN_DISTANCE_ENABLED   = 1<<2,
        eSPRING_ENABLED         = 1<<3
    };
};

typedef PxFlags<PxDistanceJointFlag::Enum, PxU16> PxDistanceJointFlags;
PX_FLAGS_OPERATORS(PxDistanceJointFlag::Enum, PxU16)


class PxDistanceJoint : public PxJoint
{
public:


    virtual PxReal                  getDistance() const                                 = 0;
    
    virtual void                    setMinDistance(PxReal distance)                     = 0;

    virtual PxReal                  getMinDistance()                            const   = 0;


    virtual void                    setMaxDistance(PxReal distance)                     = 0;

    virtual PxReal                  getMaxDistance()                            const   = 0;


    virtual void                    setTolerance(PxReal tolerance)                      = 0;


    virtual PxReal                  getTolerance()                              const   = 0;

    virtual void                    setStiffness(PxReal stiffness)                  = 0;

    virtual PxReal                  getStiffness()                                  const   = 0;


    virtual void                    setDamping(PxReal damping)                          = 0;
    

    virtual PxReal                  getDamping()                                    const   = 0;

    virtual void                    setDistanceJointFlags(PxDistanceJointFlags flags) = 0;


    virtual void                    setDistanceJointFlag(PxDistanceJointFlag::Enum flag, bool value) = 0;

    virtual PxDistanceJointFlags    getDistanceJointFlags(void)                 const   = 0;

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

protected:

    //serialization

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

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

    virtual bool                    isKindOf(const char* name)  const { return !strcmp("PxDistanceJoint", name) || PxJoint::isKindOf(name); }

    //~serialization
};

#ifndef PX_DOXYGEN
} // namespace physx
#endif

#endif