Skip to content

WeldJointComponent Class

Definition

Namespace: Brine2D.ECS.Components.Joints

Locks two bodies together at a shared anchor with optional spring softness. A rigid weld \([LinearHertz](LinearHertz.md 'Brine2D\.ECS\.Components\.Joints\.WeldJointComponent\.LinearHertz') = 0\) is equivalent to merging the two bodies.

C#
public sealed class WeldJointComponent : Brine2D.ECS.Components.Joints.JointComponent

Inheritance System.ObjectComponentJointComponent → WeldJointComponent

Remarks

\<b>Break force limitation:\</b> Box2D 3.x only reports constraint force for soft joints. BreakForce has no effect when LinearHertz is 0 \(the default\). Set LinearHertz to a positive value to enable break detection.

Properties
AngularHertz Angular spring frequency in Hz. 0 = rigid.
LinearHertz Linear spring frequency in Hz. 0 = rigid.
ReferenceAngle Initial relative angle between the bodies in radians. Requires a joint rebuild — set once at construction time.