Struct DistanceLimit

Namespace

BepuPhysics.Constraints

Assembly

BepuPhysics.dll

Constrains points on two bodies to be separated by a distance within a range.

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

Implements

ITwoBodyConstraintDescription<DistanceLimit>

IConstraintDescription<DistanceLimit>

Inherited Members

ValueType.Equals(object)

ValueType.GetHashCode()

ValueType.ToString()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

DistanceLimit(Vector3, Vector3, float, float, in SpringSettings)

Creates a distance limit description.

public DistanceLimit(Vector3 localOffsetA, Vector3 localOffsetB, float minimumDistance, float maximumDistance, in SpringSettings springSettings)

Parameters

localOffsetA Vector3

Local offset from the center of body A to its attachment point.

localOffsetB Vector3

Local offset from the center of body B to its attachment point.

minimumDistance float

Minimum distance permitted between the point on A and the point on B.

maximumDistance float

Maximum distance permitted between the point on A and the point on B.

springSettings SpringSettings

Spring frequency and damping parameters.

Fields

LocalOffsetA

Local offset from the center of body A to its attachment point.

public Vector3 LocalOffsetA

Field Value

Vector3

LocalOffsetB

Local offset from the center of body B to its attachment point.

public Vector3 LocalOffsetB

Field Value

Vector3

MaximumDistance

Maximum distance permitted between the point on A and the point on B.

public float MaximumDistance

Field Value

float

MinimumDistance

Minimum distance permitted between the point on A and the point on B.

public float MinimumDistance

Field Value

float

SpringSettings

Spring frequency and damping parameters.

public SpringSettings SpringSettings

Field Value

SpringSettings

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 DistanceLimit)

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

public static void BuildDescription(ref TypeBatch batch, int bundleIndex, int innerIndex, out DistanceLimit 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 DistanceLimit

Description of the constraint.

CreateTypeProcessor()

Creates a type processor for this constraint type.

public static TypeProcessor CreateTypeProcessor()

Returns

TypeProcessor