HughPH.Box2D
Organised dotnet bindings for Box2D 3.1.0
Loading...
Searching...
No Matches
Properties | List of all members
Box2D.MotorJoint Class Referencesealed

The motor joint is used to drive the relative transform between two bodies. It takes a relative position and rotation and applies the forces and torques needed to achieve that relative transform over time. More...

Inheritance diagram for Box2D.MotorJoint:
Inheritance graph
[legend]
Collaboration diagram for Box2D.MotorJoint:
Collaboration graph
[legend]

Properties

Vec2 LinearOffset [get, set]
 The linear offset target on this motor joint.
 
float AngularOffset [get, set]
 The angular offset target in radians on this motor joint.
 
float MaxForce [get, set]
 The maximum force on this motor joint.
 
float MaxTorque [get, set]
 The maximum torque on this motor joint.
 
float CorrectionFactor [get, set]
 The correction factor on this motor joint.
 
- Properties inherited from Box2D.Joint
bool Valid [get]
 Checks if this joint is valid.
 
JointType Type [get]
 Gets the joint type.
 
Body BodyA [get]
 Gets body A on this joint.
 
Body BodyB [get]
 Gets body B on this joint.
 
World World [get]
 Gets the world that owns this joint.
 
Vec2 LocalAnchorA [get]
 Gets the local anchor on body A.
 
Vec2 LocalAnchorB [get]
 Gets the local anchor on body B.
 
bool CollideConnected [get, set]
 Set this flag to true if the attached bodies should collide.
 
object? UserData [get, set]
 The user data object for this joint.
 
Vec2 ConstraintForce [get]
 Gets the current constraint force for this joint.
 
float ConstraintTorque [get]
 Gets the current constraint torque for this joint.
 

Additional Inherited Members

- Public Member Functions inherited from Box2D.Joint
void Destroy ()
 Destroys this joint.
 
void WakeBodies ()
 Wakes the bodies connected to this joint.
 

Detailed Description

The motor joint is used to drive the relative transform between two bodies. It takes a relative position and rotation and applies the forces and torques needed to achieve that relative transform over time.

Property Documentation

◆ CorrectionFactor

float Box2D.MotorJoint.CorrectionFactor
getset

The correction factor on this motor joint.

0 means no correction, 1 means full correction


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