include/PxArticulationMimicJoint.h

File members: include/PxArticulationMimicJoint.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_ARTICULATION_MIMIC_JOINT_H
#define PX_ARTICULATION_MIMIC_JOINT_H

#include "foundation/PxSimpleTypes.h"
#include "solver/PxSolverDefs.h"
#include "common/PxBase.h"

#if !PX_DOXYGEN
namespace physx
{
#endif

class PxArticulationReducedCoordinate;
class PxArticulationJointReducedCoordinate;

class PxArticulationMimicJoint : public PxBase
{
public:

    virtual void release() = 0;

    virtual PxArticulationReducedCoordinate& getArticulation() const = 0;

    virtual PxReal getGearRatio() const = 0;

    virtual void setGearRatio(PxReal gearRatio) = 0;

    virtual PxReal getOffset() const = 0;

    virtual void setOffset(PxReal offset) = 0;

    virtual PxReal getNaturalFrequency() const = 0;

    virtual void setNaturalFrequency(PxReal naturalFrequency) = 0;

    virtual PxReal getDampingRatio() const = 0;

    virtual void setDampingRatio(PxReal dampingRatio) = 0;

    virtual PxArticulationJointReducedCoordinate& getJointA() const = 0;

    virtual PxArticulationJointReducedCoordinate& getJointB() const = 0;

    virtual PxArticulationAxis::Enum getAxisA() const = 0;

    virtual PxArticulationAxis::Enum getAxisB() const = 0;

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

    virtual                                 ~PxArticulationMimicJoint() {}

            void*                           userData;

protected:
    PX_INLINE   PxArticulationMimicJoint(PxType concreteType, PxBaseFlags baseFlags) : PxBase(concreteType, baseFlags) {}
    PX_INLINE   PxArticulationMimicJoint(PxBaseFlags baseFlags) : PxBase(baseFlags) {}
};

#if !PX_DOXYGEN
} // namespace physx
#endif

#endif //PX_ARTICULATION_MIMIC_JOINT_H