PxPrismaticJoint.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_PRISMATICJOINT_H
#define PX_PRISMATICJOINT_H

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

#if !PX_DOXYGEN
namespace physx
{
#endif

class PxPrismaticJoint;

PxPrismaticJoint*   PxPrismaticJointCreate(PxPhysics& physics, PxRigidActor* actor0, const PxTransform& localFrame0, PxRigidActor* actor1, const PxTransform& localFrame1);


struct PxPrismaticJointFlag
{
    enum Enum
    {
        eLIMIT_ENABLED  = 1<<1
    };
};

typedef PxFlags<PxPrismaticJointFlag::Enum, PxU16> PxPrismaticJointFlags;
PX_FLAGS_OPERATORS(PxPrismaticJointFlag::Enum, PxU16)


class PxPrismaticJoint : public PxJoint
{
public:
    
    virtual PxReal          getPosition()   const   = 0;

    virtual PxReal          getVelocity()   const   = 0;

    virtual void            setLimit(const PxJointLinearLimitPair&)     = 0;

    virtual PxJointLinearLimitPair getLimit()   const   = 0;

    virtual void                    setPrismaticJointFlags(PxPrismaticJointFlags flags) = 0;

    virtual void                    setPrismaticJointFlag(PxPrismaticJointFlag::Enum flag, bool value) = 0;

    virtual PxPrismaticJointFlags   getPrismaticJointFlags()    const   = 0;

    virtual void            setProjectionLinearTolerance(PxReal tolerance)  = 0;

    virtual PxReal          getProjectionLinearTolerance()  const   = 0;

    virtual void            setProjectionAngularTolerance(PxReal tolerance) = 0;

    virtual PxReal          getProjectionAngularTolerance() const   = 0;

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

protected:
    //serialization
    
    PX_INLINE               PxPrismaticJoint(PxType concreteType, PxBaseFlags baseFlags) : PxJoint(concreteType, baseFlags) {}

    PX_INLINE               PxPrismaticJoint(PxBaseFlags baseFlags) : PxJoint(baseFlags) {}
    
    virtual bool            isKindOf(const char* name) const {  return !::strcmp("PxPrismaticJoint", name) || PxJoint::isKindOf(name); }
    
    //~serialization
};

#if !PX_DOXYGEN
} // namespace physx
#endif

#endif