Public Member Functions | Static Public Member Functions | Related Functions | List of all members
playrho::d2::JointKey Class Reference

Joint key. More...

#include <JointKey.hpp>

Public Member Functions

const PLAYRHO_CONSTEXPR Body * GetBody1 () const noexcept
 Gets body 1. More...
 
const PLAYRHO_CONSTEXPR Body * GetBody2 () const
 Gets body 2. More...
 

Static Public Member Functions

static PLAYRHO_CONSTEXPR JointKey Get (const Body *bodyA, const Body *bodyB) noexcept
 Gets the JointKey for the given bodies. More...
 

Related Functions

(Note that these are not member functions.)

PLAYRHO_CONSTEXPR bool IsFor (const JointKey key, const Body *body) noexcept
 Determines whether the given key is for the given body. More...
 

Detailed Description

Joint key.

Definition at line 38 of file JointKey.hpp.

Member Function Documentation

◆ Get()

static PLAYRHO_CONSTEXPR JointKey playrho::d2::JointKey::Get ( const Body *  bodyA,
const Body *  bodyB 
)
inlinestaticnoexcept

Gets the JointKey for the given bodies.

Definition at line 43 of file JointKey.hpp.

◆ GetBody1()

const PLAYRHO_CONSTEXPR Body* playrho::d2::JointKey::GetBody1 ( ) const
inlinenoexcept

Gets body 1.

Definition at line 49 of file JointKey.hpp.

◆ GetBody2()

const PLAYRHO_CONSTEXPR Body* playrho::d2::JointKey::GetBody2 ( ) const
inline

Gets body 2.

Definition at line 55 of file JointKey.hpp.

Friends And Related Function Documentation

◆ IsFor()

PLAYRHO_CONSTEXPR bool IsFor ( const JointKey  key,
const Body *  body 
)
related

Determines whether the given key is for the given body.

Definition at line 104 of file JointKey.hpp.

The documentation for this class was generated from the following file: