PxArticulationLink.h

Fully qualified name: include/PxArticulationLink.h

File members: include/PxArticulationLink.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_LINK_H
#define PX_ARTICULATION_LINK_H

#include "PxPhysXConfig.h"
#include "PxRigidBody.h"

#if !PX_DOXYGEN
namespace physx
{
#endif

class PxArticulationLink : public PxRigidBody
{
public:
    virtual     void                        release() = 0;

    virtual     PxArticulationReducedCoordinate&            getArticulation() const = 0;

    virtual     PxArticulationJointReducedCoordinate*   getInboundJoint() const = 0;

    virtual     PxU32                       getInboundJointDof() const = 0;

    virtual     PxU32                       getNbChildren() const = 0;

    virtual     PxU32                       getLinkIndex() const = 0;

    virtual     PxU32                       getChildren(PxArticulationLink** userBuffer, PxU32 bufferSize, PxU32 startIndex = 0) const = 0;

    virtual     void                        setCfmScale(const PxReal cfm) = 0;

    virtual     PxReal                      getCfmScale() const = 0;

    virtual     PxVec3                      getLinearVelocity() const = 0;

    virtual     PxVec3                      getAngularVelocity() const = 0;

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

protected:
    PX_INLINE                               PxArticulationLink(PxType concreteType, PxBaseFlags baseFlags) : PxRigidBody(concreteType, baseFlags) {}
    PX_INLINE                               PxArticulationLink(PxBaseFlags baseFlags) : PxRigidBody(baseFlags)  {}
    virtual                                 ~PxArticulationLink()   {}
    virtual     bool                        isKindOf(const char* name)  const       { PX_IS_KIND_OF(name, "PxArticulationLink", PxRigidBody);   }
};

#if !PX_DOXYGEN
} // namespace physx
#endif

#endif