Class DistanceJointOptions

Namespace

Stride.CommunityToolkit.Box2D

Assembly

Stride.CommunityToolkit.Box2D.dll

A rod or a rope: keeps two anchors a set distance apart, or within a range, optionally sprung or driven along its length.

public sealed record DistanceJointOptions : JointOptionsBase, IEquatable<JointOptionsBase>, IEquatable<DistanceJointOptions>

Inheritance

object

JointOptionsBase

DistanceJointOptions

Implements

IEquatable<JointOptionsBase>

IEquatable<DistanceJointOptions>

Inherited Members

JointOptionsBase.CollideConnected

JointOptionsBase.ForceThreshold

JointOptionsBase.TorqueThreshold

Properties

DampingRatio

Spring damping ratio; 1 is critical.

public float? DampingRatio { get; init; }

Property Value

float?

EnableLimit

Clamp the length to MinLength..MaxLength - a rope when the spring is on.

public bool? EnableLimit { get; init; }

Property Value

bool?

EnableMotor

Drive the length at MotorSpeed.

public bool? EnableMotor { get; init; }

Property Value

bool?

EnableSpring

Turn the spring on; the joint then behaves as a soft rod rather than a rigid one.

public bool? EnableSpring { get; init; }

Property Value

bool?

Hertz

Spring stiffness, in hertz.

public float? Hertz { get; init; }

Property Value

float?

Length

Rest length, in metres. Defaults to the distance between the anchors at creation.

public float? Length { get; init; }

Property Value

float?

LowerSpringForce

Lowest force the spring may apply, in newtons; negative pulls.

public float? LowerSpringForce { get; init; }

Property Value

float?

MaxLength

Longest allowed length, in metres.

public float? MaxLength { get; init; }

Property Value

float?

MaxMotorForce

The most force the motor may apply, in newtons.

public float? MaxMotorForce { get; init; }

Property Value

float?

MinLength

Shortest allowed length, in metres.

public float? MinLength { get; init; }

Property Value

float?

MotorSpeed

Motor speed, in metres per second.

public float? MotorSpeed { get; init; }

Property Value

float?

UpperSpringForce

Highest force the spring may apply, in newtons.

public float? UpperSpringForce { get; init; }

Property Value

float?