Friction joint. More...
#include <FrictionJoint.hpp>
Public Member Functions | |
FrictionJoint (const FrictionJointConf &def) | |
Initializing constructor. More... | |
void | Accept (JointVisitor &visitor) const override |
Accepts a visitor. More... | |
void | Accept (JointVisitor &visitor) override |
Accepts a visitor. More... | |
Length2 | GetAnchorA () const override |
Get the anchor point on body-A in world coordinates. More... | |
Length2 | GetAnchorB () const override |
Get the anchor point on body-B in world coordinates. More... | |
Momentum2 | GetLinearReaction () const override |
Get the linear reaction on body-B at the joint anchor. More... | |
AngularMomentum | GetAngularReaction () const override |
Get the angular reaction on body-B. More... | |
Length2 | GetLocalAnchorA () const |
The local anchor point relative to body A's origin. More... | |
Length2 | GetLocalAnchorB () const |
The local anchor point relative to body B's origin. More... | |
void | SetMaxForce (NonNegative< Force > force) |
Set the maximum friction force in N. More... | |
NonNegative< Force > | GetMaxForce () const |
Get the maximum friction force in N. More... | |
void | SetMaxTorque (NonNegative< Torque > torque) |
Set the maximum friction torque in N*m. More... | |
NonNegative< Torque > | GetMaxTorque () const |
Get the maximum friction torque in N*m. More... | |
Public Member Functions inherited from playrho::d2::Joint | |
virtual | ~Joint () noexcept=default |
Body * | GetBodyA () const noexcept |
Gets the first body attached to this joint. More... | |
Body * | GetBodyB () const noexcept |
Gets the second body attached to this joint. More... | |
void * | GetUserData () const noexcept |
Get the user data pointer. More... | |
void | SetUserData (void *data) noexcept |
Set the user data pointer. More... | |
bool | GetCollideConnected () const noexcept |
Gets collide connected. More... | |
virtual bool | ShiftOrigin (const Length2) |
Shifts the origin for any points stored in world coordinates. More... | |
Related Functions | |
(Note that these are not member functions.) | |
FrictionJointConf | GetFrictionJointConf (const FrictionJoint &joint) noexcept |
Gets the definition data for the given joint. More... | |
Related Functions inherited from playrho::d2::Joint | |
bool | IsEnabled (const Joint &j) noexcept |
Short-cut function to determine if both bodies are enabled. More... | |
void | SetAwake (Joint &j) noexcept |
Wakes up the joined bodies. More... | |
JointCounter | GetWorldIndex (const Joint *joint) |
Gets the world index of the given joint. More... | |
JointType | GetType (const Joint &joint) noexcept |
Gets the type of the given joint. More... | |
Additional Inherited Members | |
Public Types inherited from playrho::d2::Joint | |
enum | LimitState { e_inactiveLimit, e_atLowerLimit, e_atUpperLimit, e_equalLimits } |
Limit state. More... | |
Static Public Member Functions inherited from playrho::d2::Joint | |
static bool | IsOkay (const JointConf &def) noexcept |
Is the given definition okay. More... | |
Protected Member Functions inherited from playrho::d2::Joint | |
Joint (const JointConf &def) | |
Initializing constructor. More... | |
Detailed Description
Friction joint.
This is used for top-down friction. It provides 2-D translational friction and angular friction.
Definition at line 39 of file FrictionJoint.hpp.
Constructor & Destructor Documentation
◆ FrictionJoint()
playrho::d2::FrictionJoint::FrictionJoint | ( | const FrictionJointConf & | def | ) |
Initializing constructor.
- Attention
- To create or use the joint within a world instance, call that world instance's create joint method instead of calling this constructor directly.
- See also
- World::CreateJoint
Definition at line 45 of file FrictionJoint.cpp.
Member Function Documentation
◆ Accept() [1/2]
|
overridevirtual |
Accepts a visitor.
This is the Accept method definition of a "visitor design pattern" for for doing joint subclass specific types of processing for a constant joint.
Implements playrho::d2::Joint.
Definition at line 55 of file FrictionJoint.cpp.
◆ Accept() [2/2]
|
overridevirtual |
Accepts a visitor.
This is the Accept method definition of a "visitor design pattern" for for doing joint subclass specific types of processing.
Implements playrho::d2::Joint.
Definition at line 60 of file FrictionJoint.cpp.
◆ GetAnchorA()
|
overridevirtual |
Get the anchor point on body-A in world coordinates.
Implements playrho::d2::Joint.
Definition at line 219 of file FrictionJoint.cpp.
◆ GetAnchorB()
|
overridevirtual |
Get the anchor point on body-B in world coordinates.
Implements playrho::d2::Joint.
Definition at line 224 of file FrictionJoint.cpp.
◆ GetLinearReaction()
|
overridevirtual |
Get the linear reaction on body-B at the joint anchor.
Implements playrho::d2::Joint.
Definition at line 229 of file FrictionJoint.cpp.
◆ GetAngularReaction()
|
overridevirtual |
Get the angular reaction on body-B.
Implements playrho::d2::Joint.
Definition at line 234 of file FrictionJoint.cpp.
◆ GetLocalAnchorA()
|
inline |
The local anchor point relative to body A's origin.
Definition at line 59 of file FrictionJoint.hpp.
◆ GetLocalAnchorB()
|
inline |
The local anchor point relative to body B's origin.
Definition at line 62 of file FrictionJoint.hpp.
◆ SetMaxForce()
|
inline |
Set the maximum friction force in N.
Definition at line 100 of file FrictionJoint.hpp.
◆ GetMaxForce()
|
inline |
Get the maximum friction force in N.
Definition at line 105 of file FrictionJoint.hpp.
◆ SetMaxTorque()
|
inline |
Set the maximum friction torque in N*m.
Definition at line 110 of file FrictionJoint.hpp.
◆ GetMaxTorque()
|
inline |
Get the maximum friction torque in N*m.
Definition at line 115 of file FrictionJoint.hpp.
Friends And Related Function Documentation
◆ GetFrictionJointConf()
|
related |
Gets the definition data for the given joint.
Definition at line 36 of file FrictionJointConf.cpp.
The documentation for this class was generated from the following files:
- Dynamics/Joints/FrictionJoint.hpp
- Dynamics/Joints/FrictionJoint.cpp
- Dynamics/Joints/FrictionJointConf.hpp