Struct JointDefinition

Namespace: Box3D

Assembly: Box3D.NET.dll

The settings every joint shares.

public readonly record struct JointDefinition : IEquatable<JointDefinition>

Implements

IEquatable<JointDefinition>

Inherited Members

object.Equals(object?)

object.Equals(object?, object?)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object?, object?)

object.ToString()

Remarks

The specific joint definitions embed this, mirroring how the C API composes them. Build one with Box3D.Joint.FramesFromWorldAnchor(Box3D.Body,Box3D.Body,System.Numerics.Vector3,System.Numerics.Vector3) unless you already know the local frames.

Properties

BodyA: Gets the first attached body.
BodyB: Gets the second attached body.
CollideConnected: Gets a value indicating whether the two attached bodies may collide.
ConstraintDampingRatio: Gets the constraint damping ratio. Advanced.
ConstraintHertz: Gets the constraint stiffness in cycles per second. Advanced.
Default: Gets the engine's default joint settings, with no bodies attached.
DrawScale: Gets the scale used when drawing this joint.
ForceThreshold: Gets the force above which the joint raises an event, in newtons.
FrameA: Gets the joint frame on Box3D.JointDefinition.BodyA.
FrameB: Gets the joint frame on Box3D.JointDefinition.BodyB.
TorqueThreshold: Gets the torque above which the joint raises an event, in newton-metres.

Methods