Struct LinearAxisLimit

Namespace

BepuPhysics.Constraints

Assembly

BepuPhysics.dll

Constrains points on two bodies to a range of offsets from each other along a direction anchored to body A.

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

Implements

ITwoBodyConstraintDescription<LinearAxisLimit>

IConstraintDescription<LinearAxisLimit>

Inherited Members

ValueType.Equals(object)

ValueType.GetHashCode()

ValueType.ToString()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Fields

LocalAxis

Direction of the motorized axis in the local space of body A.

public Vector3 LocalAxis

Field Value

Vector3

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

MaximumOffset

Maximum offset along the world axis between A and B's anchor points.

public float MaximumOffset

Field Value

float

MinimumOffset

Minimum offset along the world axis between A and B's anchor points.

public float MinimumOffset

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

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

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

Description of the constraint.

CreateTypeProcessor()

Creates a type processor for this constraint type.

public static TypeProcessor CreateTypeProcessor()

Returns

TypeProcessor