Struct DistanceServo

Namespace

BepuPhysics.Constraints

Assembly

BepuPhysics.dll

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

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

Implements

ITwoBodyConstraintDescription<DistanceServo>

IConstraintDescription<DistanceServo>

Inherited Members

ValueType.Equals(object)

ValueType.GetHashCode()

ValueType.ToString()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

DistanceServo(Vector3, Vector3, float, in SpringSettings)

public DistanceServo(Vector3 localOffsetA, Vector3 localOffsetB, float targetDistance, in SpringSettings springSettings)

Parameters

localOffsetA Vector3

localOffsetB Vector3

targetDistance float

springSettings SpringSettings

DistanceServo(Vector3, Vector3, float, in SpringSettings, in ServoSettings)

Creates a distance servo description.

public DistanceServo(Vector3 localOffsetA, Vector3 localOffsetB, float targetDistance, in SpringSettings springSettings, in ServoSettings servoSettings)

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.

targetDistance float

Distance that the constraint will try to reach between the attachment points.

springSettings SpringSettings

Spring frequency and damping parameters.

servoSettings ServoSettings

Servo control 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

ServoSettings

Servo control parameters.

public ServoSettings ServoSettings

Field Value

ServoSettings

SpringSettings

Spring frequency and damping parameters.

public SpringSettings SpringSettings

Field Value

SpringSettings

TargetDistance

Distance that the constraint will try to reach between the attachment points.

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

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

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

Description of the constraint.

CreateTypeProcessor()

Creates a type processor for this constraint type.

public static TypeProcessor CreateTypeProcessor()

Returns

TypeProcessor