Motor joint definition. More...
#include <MotorJointConf.hpp>
Public Types | |
using | super = JointBuilder< MotorJointConf > |
Super type. More... | |
Public Types inherited from playrho::d2::JointBuilder< MotorJointConf > | |
using | value_type = MotorJointConf |
Value type. More... | |
using | reference = value_type & |
Reference type. More... | |
Public Member Functions | |
PLAYRHO_CONSTEXPR | MotorJointConf () noexcept |
MotorJointConf (NonNull< Body * > bodyA, NonNull< Body * > bodyB) noexcept | |
Initialize the bodies and offsets using the current transforms. More... | |
MotorJointConf & | UseLinearOffset (Length2 v) noexcept |
Uses the given linear offset value. More... | |
MotorJointConf & | UseAngularOffset (Angle v) noexcept |
Uses the given angular offset value. More... | |
MotorJointConf & | UseMaxForce (NonNegative< Force > v) noexcept |
Uses the given maximum force value. More... | |
MotorJointConf & | UseMaxTorque (NonNegative< Torque > v) noexcept |
Uses the given max torque value. More... | |
MotorJointConf & | UseCorrectionFactor (Real v) noexcept |
Uses the given correction factor. More... | |
Public Member Functions inherited from playrho::d2::JointBuilder< MotorJointConf > | |
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 | linearOffset = Length2{} |
Position of body-B minus the position of body-A, in body-A's frame. More... | |
Angle | angularOffset = 0_deg |
Angle of body-B minus angle of body-A. More... | |
NonNegative< Force > | maxForce = NonNegative<Force>(1_N) |
Maximum motor force. More... | |
NonNegative< Torque > | maxTorque = NonNegative<Torque>(1_Nm) |
Maximum motor torque. More... | |
Real | correctionFactor = Real(0.3) |
Position correction factor in the range [0,1]. 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 39 of file MotorJointConf.hpp.
Constructor & Destructor Documentation
◆ MotorJointConf() [1/2]
|
inlinenoexcept |
Definition at line 41 of file MotorJointConf.hpp.
◆ MotorJointConf() [2/2]
|
noexcept |
Initialize the bodies and offsets using the current transforms.
Definition at line 29 of file MotorJointConf.cpp.
Member Function Documentation
◆ UseLinearOffset()
|
inlinenoexcept |
Uses the given linear offset value.
Definition at line 77 of file MotorJointConf.hpp.
◆ UseAngularOffset()
|
inlinenoexcept |
Uses the given angular offset value.
Definition at line 83 of file MotorJointConf.hpp.
◆ UseMaxForce()
|
inlinenoexcept |
Uses the given maximum force value.
Definition at line 89 of file MotorJointConf.hpp.
◆ UseMaxTorque()
|
inlinenoexcept |
Uses the given max torque value.
Definition at line 95 of file MotorJointConf.hpp.
◆ UseCorrectionFactor()
|
inlinenoexcept |
Uses the given correction factor.
Definition at line 101 of file MotorJointConf.hpp.
Member Data Documentation
◆ linearOffset
Position of body-B minus the position of body-A, in body-A's frame.
Definition at line 62 of file MotorJointConf.hpp.
◆ angularOffset
Angle playrho::d2::MotorJointConf::angularOffset = 0_deg |
Angle of body-B minus angle of body-A.
Definition at line 65 of file MotorJointConf.hpp.
◆ maxForce
NonNegative<Force> playrho::d2::MotorJointConf::maxForce = NonNegative<Force>(1_N) |
Maximum motor force.
Definition at line 68 of file MotorJointConf.hpp.
◆ maxTorque
NonNegative<Torque> playrho::d2::MotorJointConf::maxTorque = NonNegative<Torque>(1_Nm) |
Maximum motor torque.
Definition at line 71 of file MotorJointConf.hpp.
◆ correctionFactor
Position correction factor in the range [0,1].
Definition at line 74 of file MotorJointConf.hpp.
The documentation for this struct was generated from the following files:
- Dynamics/Joints/MotorJointConf.hpp
- Dynamics/Joints/MotorJointConf.cpp