Struct AngularAxisGearMotor

Namespace

BepuPhysics.Constraints

Assembly

BepuPhysics.dll

Constrains body B's angular velocity around an axis anchored to body A to equal body A's velocity around that axis with a scaling factor applied.

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

Implements

ITwoBodyConstraintDescription<AngularAxisGearMotor>

IConstraintDescription<AngularAxisGearMotor>

Inherited Members

ValueType.Equals(object)

ValueType.GetHashCode()

ValueType.ToString()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Fields

LocalAxisA

Axis of rotation in body A's local space.

public Vector3 LocalAxisA

Field Value

Vector3

Settings

Motor control parameters.

public MotorSettings Settings

Field Value

MotorSettings

VelocityScale

Scale to apply to body A's velocity around the axis to get body B's target velocity.

In other words, a VelocityScale of 2 means that body A could have a velocity of 3 while body B has a velocity of 6.

public float VelocityScale

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

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

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

Description of the constraint.

CreateTypeProcessor()

Creates a type processor for this constraint type.

public static TypeProcessor CreateTypeProcessor()

Returns

TypeProcessor