Struct CenterDistanceConstraint

Namespace

BepuPhysics.Constraints

Assembly

BepuPhysics.dll

Constrains the center of two bodies to be separated by a goal distance.

public struct CenterDistanceConstraint : ITwoBodyConstraintDescription<CenterDistanceConstraint>, IConstraintDescription<CenterDistanceConstraint>

Implements

ITwoBodyConstraintDescription<CenterDistanceConstraint>

IConstraintDescription<CenterDistanceConstraint>

Inherited Members

ValueType.Equals(object)

ValueType.GetHashCode()

ValueType.ToString()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

CenterDistanceConstraint(float, in SpringSettings)

public CenterDistanceConstraint(float targetDistance, in SpringSettings springSettings)

Parameters

targetDistance float

springSettings SpringSettings

Fields

SpringSettings

Spring frequency and damping parameters.

public SpringSettings SpringSettings

Field Value

SpringSettings

TargetDistance

Target distance between the body centers.

public float TargetDistance

Field Value

float

Properties

ConstraintTypeId

Gets the type id of the constraint that this is a description of.

public static int ConstraintTypeId { get; }

Property Value

int

TypeProcessorType

Gets the type of the type batch which contains described constraints.

public static Type TypeProcessorType { get; }

Property Value

Type

Methods

ApplyDescription(ref TypeBatch, int, int)

Changes the batch-held memory at a given location to match the given description.

public readonly void ApplyDescription(ref TypeBatch batch, int bundleIndex, int innerIndex)

Parameters

batch TypeBatch

Batch to modify.

bundleIndex int

Index of the target constraint's bundle.

innerIndex int

Index of the target constraint within its bundle.

BuildDescription(ref TypeBatch, int, int, out CenterDistanceConstraint)

Creates a description from the batch-held memory at a given location.

public static void BuildDescription(ref TypeBatch batch, int bundleIndex, int innerIndex, out CenterDistanceConstraint description)

Parameters

batch TypeBatch

Batch to read.

bundleIndex int

Index of the source constraint's bundle.

innerIndex int

Index of the source constraint within its bundle.

description CenterDistanceConstraint

Description of the constraint.

CreateTypeProcessor()

Creates a type processor for this constraint type.

public static TypeProcessor CreateTypeProcessor()

Returns

TypeProcessor