ExtDistanceJoint.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-2022 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 EXT_DISTANCE_JOINT_H
#define EXT_DISTANCE_JOINT_H
 
#include "common/PxTolerancesScale.h"
#include "extensions/PxDistanceJoint.h"
 
#include "ExtJoint.h"
#include "foundation/PxUserAllocated.h"
#include "CmUtils.h"
 
namespace physx
{
struct PxDistanceJointGeneratedValues;
namespace Ext
{
    struct DistanceJointData : public JointData
    {
    //= 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.
    //==================================================================================================
 
        PxReal                  minDistance;
        PxReal                  maxDistance;
        PxReal                  tolerance;
        PxReal                  stiffness;
        PxReal                  damping;
        PxReal                  contactDistance;
 
        PxDistanceJointFlags    jointFlags;
    };
 
    typedef JointT<PxDistanceJoint, DistanceJointData, PxDistanceJointGeneratedValues> DistanceJointT;
    class DistanceJoint : public DistanceJointT
    {
        //= 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:
        // PX_SERIALIZATION
                                        DistanceJoint(PxBaseFlags baseFlags) : DistanceJointT(baseFlags) {}
                void                    resolveReferences(PxDeserializationContext& context);
        static  DistanceJoint*          createObject(PxU8*& address, PxDeserializationContext& context) { return createJointObject<DistanceJoint>(address, context);    }
        static  void                    getBinaryMetaData(PxOutputStream& stream);
        //~PX_SERIALIZATION
                                        DistanceJoint(const PxTolerancesScale& scale, PxRigidActor* actor0, const PxTransform& localFrame0, PxRigidActor* actor1, const PxTransform& localFrame1);
        // PxDistanceJoint
        virtual PxReal                  getDistance()   const   PX_OVERRIDE;
        virtual void                    setMinDistance(PxReal distance) PX_OVERRIDE;
        virtual PxReal                  getMinDistance()    const   PX_OVERRIDE;
        virtual void                    setMaxDistance(PxReal distance) PX_OVERRIDE;
        virtual PxReal                  getMaxDistance()    const   PX_OVERRIDE;
        virtual void                    setTolerance(PxReal tolerance)  PX_OVERRIDE;
        virtual PxReal                  getTolerance()  const   PX_OVERRIDE;
        virtual void                    setStiffness(PxReal spring) PX_OVERRIDE;
        virtual PxReal                  getStiffness()  const   PX_OVERRIDE;
        virtual void                    setDamping(PxReal damping)  PX_OVERRIDE;
        virtual PxReal                  getDamping()    const   PX_OVERRIDE;
        virtual void                    setContactDistance(PxReal contactDistance)  PX_OVERRIDE;
        virtual PxReal                  getContactDistance()    const   PX_OVERRIDE;
        virtual void                    setDistanceJointFlags(PxDistanceJointFlags flags)   PX_OVERRIDE;
        virtual void                    setDistanceJointFlag(PxDistanceJointFlag::Enum flag, bool value)    PX_OVERRIDE;
        virtual PxDistanceJointFlags    getDistanceJointFlags() const   PX_OVERRIDE;
        //~PxDistanceJoint
 
        // PxConstraintConnector
        virtual PxConstraintSolverPrep  getPrep()   const   PX_OVERRIDE;
#if PX_SUPPORT_OMNI_PVD
        virtual void updateOmniPvdProperties() const PX_OVERRIDE;
#endif
        //~PxConstraintConnector
    };
 
} // namespace Ext
 
} // namespace physx
 
#endif