Weld joint definition. More...
#include <WeldJointConf.hpp>
Public Types | |
using | super = JointBuilder< WeldJointConf > |
Super type. More... | |
Public Types inherited from playrho::d2::JointBuilder< WeldJointConf > | |
using | value_type = WeldJointConf |
Value type. More... | |
using | reference = value_type & |
Reference type. More... | |
Public Member Functions | |
PLAYRHO_CONSTEXPR | WeldJointConf () noexcept |
WeldJointConf (NonNull< Body * > bodyA, NonNull< Body * > bodyB, const Length2 anchor) noexcept | |
Initializing constructor. More... | |
PLAYRHO_CONSTEXPR WeldJointConf & | UseFrequency (Frequency v) noexcept |
Uses the given frequency value. More... | |
PLAYRHO_CONSTEXPR WeldJointConf & | UseDampingRatio (Real v) noexcept |
Uses the given damping ratio. More... | |
Public Member Functions inherited from playrho::d2::JointBuilder< WeldJointConf > | |
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{} |
The local anchor point relative to body A's origin. More... | |
Length2 | localAnchorB = Length2{} |
The local anchor point relative to body B's origin. More... | |
Angle | referenceAngle = 0_deg |
The body-B angle minus body-A angle in the reference state (radians). More... | |
Frequency | frequency = 0_Hz |
Mass-spring-damper frequency. More... | |
Real | dampingRatio = 0 |
Damping ratio. 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
Weld joint definition.
- Note
- A weld joint essentially glues two bodies together. A weld joint may distort somewhat because the island constraint solver is approximate.
- You need to specify local anchor points where they are attached and the relative body angle.
- The position of the anchor points is important for computing the reaction torque.
- See also
- WeldJoint
- Examples
- World.cpp.
Definition at line 41 of file WeldJointConf.hpp.
Member Typedef Documentation
◆ super
Super type.
Definition at line 44 of file WeldJointConf.hpp.
Constructor & Destructor Documentation
◆ WeldJointConf() [1/2]
|
inlinenoexcept |
Definition at line 46 of file WeldJointConf.hpp.
◆ WeldJointConf() [2/2]
|
noexcept |
Initializing constructor.
Initializes the bodies, anchors, and reference angle using a world anchor point.
Definition at line 29 of file WeldJointConf.cpp.
Member Function Documentation
◆ UseFrequency()
|
inlinenoexcept |
Uses the given frequency value.
Definition at line 81 of file WeldJointConf.hpp.
◆ UseDampingRatio()
|
inlinenoexcept |
Uses the given damping ratio.
Definition at line 87 of file WeldJointConf.hpp.
Member Data Documentation
◆ localAnchorA
The local anchor point relative to body A's origin.
Definition at line 63 of file WeldJointConf.hpp.
◆ localAnchorB
The local anchor point relative to body B's origin.
Definition at line 66 of file WeldJointConf.hpp.
◆ referenceAngle
Angle playrho::d2::WeldJointConf::referenceAngle = 0_deg |
The body-B angle minus body-A angle in the reference state (radians).
Definition at line 69 of file WeldJointConf.hpp.
◆ frequency
Frequency playrho::d2::WeldJointConf::frequency = 0_Hz |
Mass-spring-damper frequency.
- Note
- Rotation only.
- Disable softness with a value of 0.
Definition at line 74 of file WeldJointConf.hpp.
◆ dampingRatio
Real playrho::d2::WeldJointConf::dampingRatio = 0 |
Damping ratio.
- Note
- 0 = no damping, 1 = critical damping.
Definition at line 78 of file WeldJointConf.hpp.
The documentation for this struct was generated from the following files:
- Dynamics/Joints/WeldJointConf.hpp
- Dynamics/Joints/WeldJointConf.cpp