playrho::d2::FrictionJointConf Struct Reference
Friction joint definition. More...
#include <FrictionJointConf.hpp>
Public Types | |
| using | super = JointBuilder< FrictionJointConf > |
| Super type. More... | |
 Public Types inherited from playrho::d2::JointBuilder< FrictionJointConf > | |
| using | value_type = FrictionJointConf |
| Value type. More... | |
| using | reference = value_type & |
| Reference type. More... | |
Public Member Functions | |
| PLAYRHO_CONSTEXPR | FrictionJointConf () noexcept |
| FrictionJointConf (Body *bodyA, Body *bodyB, const Length2 anchor) noexcept | |
| Initializing constructor. More... | |
| PLAYRHO_CONSTEXPR FrictionJointConf & | UseMaxForce (NonNegative< Force > v) noexcept |
| Uses the given maximum force value. More... | |
| PLAYRHO_CONSTEXPR FrictionJointConf & | UseMaxTorque (NonNegative< Torque > v) noexcept |
| Uses the given maximum torque value. More... | |
| Public Member Functions inherited from playrho::d2::JointBuilder< FrictionJointConf > | |
| PLAYRHO_CONSTEXPR | JointBuilder (JointType t) noexcept |
| Initializing constructor. More... | |
| PLAYRHO_CONSTEXPR reference | UseBodyA (Body *b) noexcept |
| Use value for body A setting. More... | |
| PLAYRHO_CONSTEXPR reference | UseBodyB (Body *b) noexcept |
| Use value for body B setting. More... | |
| PLAYRHO_CONSTEXPR reference | UseCollideConnected (bool v) noexcept |
| Use value for collide connected setting. More... | |
| PLAYRHO_CONSTEXPR reference | UseUserData (void *v) noexcept |
| Use value for user data setting. More... | |
| Public Member Functions inherited from playrho::d2::JointConf | |
| JointConf ()=delete | |
| Deleted default constructor for abstract base class. More... | |
| PLAYRHO_CONSTEXPR | JointConf (JointType t) noexcept |
| Initializing constructor. More... | |
Public Attributes | |
| Length2 | localAnchorA = Length2{} |
| Local anchor point relative to body A's origin. More... | |
| Length2 | localAnchorB = Length2{} |
| Local anchor point relative to body B's origin. More... | |
| NonNegative< Force > | maxForce = NonNegative<Force>{0_N} |
| Maximum friction force. More... | |
| NonNegative< Torque > | maxTorque = NonNegative<Torque>{0_Nm} |
| Maximum friction torque. More... | |
| Public Attributes inherited from playrho::d2::JointConf | |
| JointType | type = JointType::Unknown |
| Type of the joint is set automatically for concrete joint types. More... | |
| Body * | bodyA = nullptr |
| 1st attached body. More... | |
| Body * | bodyB = nullptr |
| 2nd attached body. More... | |
| bool | collideConnected = false |
| Collide connected. More... | |
| void * | userData = nullptr |
| User data. More... | |
Additional Inherited Members | |
| Related Functions inherited from playrho::d2::JointConf | |
| void | Set (JointConf &def, const Joint &joint) noexcept |
| Sets the joint definition data for the given joint. More... | |
Detailed Description
Member Typedef Documentation
◆ super
Super type.
Definition at line 40 of file FrictionJointConf.hpp.
Constructor & Destructor Documentation
◆ FrictionJointConf() [1/2]
|
inlinenoexcept |
Definition at line 42 of file FrictionJointConf.hpp.
◆ FrictionJointConf() [2/2]
|
noexcept |
Initializing constructor.
Initialize the bodies, anchors, axis, and reference angle using the world anchor and world axis.
Definition at line 28 of file FrictionJointConf.cpp.
Member Function Documentation
◆ UseMaxForce()
|
inlinenoexcept |
Uses the given maximum force value.
Definition at line 68 of file FrictionJointConf.hpp.
◆ UseMaxTorque()
|
inlinenoexcept |
Uses the given maximum torque value.
Definition at line 74 of file FrictionJointConf.hpp.
Member Data Documentation
◆ localAnchorA
Local anchor point relative to body A's origin.
Definition at line 56 of file FrictionJointConf.hpp.
◆ localAnchorB
Local anchor point relative to body B's origin.
Definition at line 59 of file FrictionJointConf.hpp.
◆ maxForce
| NonNegative<Force> playrho::d2::FrictionJointConf::maxForce = NonNegative<Force>{0_N} |
Maximum friction force.
Definition at line 62 of file FrictionJointConf.hpp.
◆ maxTorque
| NonNegative<Torque> playrho::d2::FrictionJointConf::maxTorque = NonNegative<Torque>{0_Nm} |
Maximum friction torque.
Definition at line 65 of file FrictionJointConf.hpp.
The documentation for this struct was generated from the following files:
- Dynamics/Joints/FrictionJointConf.hpp
- Dynamics/Joints/FrictionJointConf.cpp
