HughPH.Box2D
Organised dotnet bindings for Box2D 3.1.1
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

unsafe Vec2 LinearOffset [get, set]
 The linear offset target on this motor joint.
 
unsafe float AngularOffset [get, set]
 The angular offset target in radians on this motor joint. When setting, this angle will be unwound so the motor will drive along the shortest arc.
 
unsafe float MaxForce [get, set]
 The maximum force on this motor joint.
 
unsafe float MaxTorque [get, set]
 The maximum torque on this motor joint.
 
unsafe float CorrectionFactor [get, set]
 The correction factor on this motor joint.
 
- Properties inherited from Box2D.Joint
unsafe bool Valid [get]
 Checks if this joint is valid.
 
unsafe JointType Type [get]
 Gets the joint type.
 
unsafe Body BodyA [get]
 Gets body A on this joint.
 
unsafe Body BodyB [get]
 Gets body B on this joint.
 
unsafe World World [get]
 Gets the world that owns this joint.
 
unsafe Vec2 LocalAnchorA [get, set]
 The local anchor on body A.
 
unsafe Vec2 LocalAnchorB [get, set]
 The local anchor on body B.
 
unsafe bool CollideConnected [get, set]
 Set this flag to true if the attached bodies should collide.
 
unsafe? object UserData [get, set]
 The user data object for this joint.
 
unsafe Vec2 ConstraintForce [get]
 Gets the current constraint force for this joint.
 
unsafe float ConstraintTorque [get]
 Gets the current constraint torque for this joint.
 
unsafe float LinearSeparation [get]
 Gets the current linear separation error for this joint.
 
unsafe float AngularSeparation [get]
 Gets the current angular separation error for this joint.
 
unsafe float ReferenceAngle [get, set]
 The reference angle in radians for joints that support it.
 
unsafe Vec2 LocalAxisA [get, set]
 The local axis on body A for joints that support it.
 

Additional Inherited Members

- Public Member Functions inherited from Box2D.Joint
unsafe void Destroy ()
 Destroys this joint.
 
unsafe void WakeBodies ()
 Wakes the bodies connected to this joint.
 
 unsafe (float hertz, float dampingRatio) ConstraintTuning
 Gets or sets the joint constraint tuning in Hertz and damping ratio. Advanced feature.
 

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

unsafe 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 files: