Struct SpringSettings

Namespace

BepuPhysics.Constraints

Assembly

BepuPhysics.dll

public struct SpringSettings

Inherited Members

ValueType.Equals(object)

ValueType.GetHashCode()

ValueType.ToString()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

SpringSettings(float, float)

Constructs a new spring settings instance.

public SpringSettings(float frequency, float dampingRatio)

Parameters

frequency float

Target number of undamped oscillations per unit of time.

dampingRatio float

Ratio of the spring's actual damping to its critical damping. 0 is undamped, 1 is critically damped, and higher values are overdamped.

Fields

AngularFrequency

Target number of undamped oscillations per unit of time, scaled by 2 * PI.

public float AngularFrequency

Field Value

float

TwiceDampingRatio

Twice the ratio of the spring's actual damping to its critical damping.

public float TwiceDampingRatio

Field Value

float

Properties

DampingRatio

Gets or sets the ratio of the spring's actual damping to its critical damping. 0 is undamped, 1 is critically damped, and higher values are overdamped.

public float DampingRatio { get; set; }

Property Value

float

Frequency

Gets or sets the target number of undamped oscillations per unit of time.

public float Frequency { get; set; }

Property Value

float

Methods

Validate(in SpringSettings)

Checks if a spring settings instance contains valid values.

public static bool Validate(in SpringSettings springSettings)

Parameters

springSettings SpringSettings

Settings to check.

Returns

bool

True if the spring settings are valid, false otherwise.