playrho::d2::JointConf Struct Reference

Abstract base Joint definition class. More...

#include <JointConf.hpp>

Public Member Functions

 JointConf ()=delete
 Deleted default constructor for abstract base class. More...
 
PLAYRHO_CONSTEXPR JointConf (JointType t) noexcept
 Initializing constructor. More...
 

Public Attributes

JointType type = JointType::Unknown
 Type of the joint is set automatically for concrete joint types. More...
 
BodybodyA = nullptr
 1st attached body. More...
 
BodybodyB = nullptr
 2nd attached body. More...
 
bool collideConnected = false
 Collide connected. More...
 
void * userData = nullptr
 User data. More...
 

Related Functions

(Note that these are not member functions.)

void Set (JointConf &def, const Joint &joint) noexcept
 Sets the joint definition data for the given joint. More...
 

Detailed Description

Abstract base Joint definition class.

Joint definitions are used to construct joints.

Note
This class is not meant to be directly instantiated; it is meant to be inherited from.
Examples
World.cpp.

Definition at line 38 of file JointConf.hpp.

Constructor & Destructor Documentation

◆ JointConf() [1/2]

playrho::d2::JointConf::JointConf ( )
delete

Deleted default constructor for abstract base class.

◆ JointConf() [2/2]

PLAYRHO_CONSTEXPR playrho::d2::JointConf::JointConf ( JointType  t)
inlineexplicitnoexcept

Initializing constructor.

Definition at line 44 of file JointConf.hpp.

Friends And Related Function Documentation

◆ Set()

void Set ( JointConf def,
const Joint joint 
)
related

Sets the joint definition data for the given joint.

Definition at line 28 of file JointConf.cpp.

Member Data Documentation

◆ type

JointType playrho::d2::JointConf::type = JointType::Unknown

Type of the joint is set automatically for concrete joint types.

Definition at line 50 of file JointConf.hpp.

◆ bodyA

Body* playrho::d2::JointConf::bodyA = nullptr

1st attached body.

Examples
World.cpp.

Definition at line 53 of file JointConf.hpp.

◆ bodyB

Body* playrho::d2::JointConf::bodyB = nullptr

2nd attached body.

Examples
World.cpp.

Definition at line 56 of file JointConf.hpp.

◆ collideConnected

bool playrho::d2::JointConf::collideConnected = false

Collide connected.

Set this flag to true if the attached bodies should collide.

Definition at line 60 of file JointConf.hpp.

◆ userData

void* playrho::d2::JointConf::userData = nullptr

User data.

Use this to attach application specific data to your joints.

Definition at line 64 of file JointConf.hpp.


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