Struct Joint

Namespace: ValveResourceFormat.ResourceTypes.RubikonPhysics
Assembly: ValveResourceFormat.dll

Represents a constraint between two physics bodies.

public readonly struct Joint

Constructors

Joint(KVObject)

Initializes a new instance of the Joint struct.

public Joint(KVObject data)

Parameters

data KVObject

Properties

AngularDampingRatio

Gets the angular spring damping ratio.

public float AngularDampingRatio { get; }

Property Value

float

AngularFrequency

Gets the angular spring frequency.

public float AngularFrequency { get; }

Property Value

float

AngularTargetVelocity

Gets the target angular velocity driven by the angular motor.

public Vector3 AngularTargetVelocity { get; }

Property Value

Vector3

Body1

Index into PhysAggregateData.Parts for the first body.

public int Body1 { get; }

Property Value

int

Body2

Index into PhysAggregateData.Parts for the second body.

public int Body2 { get; }

Property Value

int

ElasticDamping

Gets the elastic damping.

public float ElasticDamping { get; }

Property Value

float

Elasticity

Gets the joint elasticity (restitution).

public float Elasticity { get; }

Property Value

float

EnableAngularMotor

Gets whether the angular motor is enabled.

public bool EnableAngularMotor { get; }

Property Value

bool

EnableCollision

Gets whether the two connected bodies still collide with each other.

public bool EnableCollision { get; }

Property Value

bool

EnableLinearLimit

Gets whether Joint.LinearLimit is enforced.

public bool EnableLinearLimit { get; }

Property Value

bool

EnableLinearMotor

Gets whether the linear motor is enabled.

public bool EnableLinearMotor { get; }

Property Value

bool

EnableSwingLimit

Gets whether Joint.SwingLimit is enforced.

public bool EnableSwingLimit { get; }

Property Value

bool

EnableTwistLimit

Gets whether Joint.TwistLimit is enforced.

public bool EnableTwistLimit { get; }

Property Value

bool

Flags

Gets the joint flags.

public JointFlags Flags { get; }

Property Value

JointFlags

Frame1

The joint frame local to the first body, as (position, scale, rotation).

public (Vector3 Position, float Scale, Quaternion Rotation) Frame1 { get; }

Property Value

(Vector3 Position, float Scale, Quaternion Rotation)

Frame2

The joint frame local to the second body, as (position, scale, rotation).

public (Vector3 Position, float Scale, Quaternion Rotation) Frame2 { get; }

Property Value

(Vector3 Position, float Scale, Quaternion Rotation)

Friction

Gets the joint friction.

public float Friction { get; }

Property Value

float

HasFriction

Gets whether the record carries Joint.Friction. Older records have no motion resistance fields.

public bool HasFriction { get; }

Property Value

bool

IsAngularConstraintDisabled

Gets whether the angular degrees of freedom are locked out entirely.

public bool IsAngularConstraintDisabled { get; }

Property Value

bool

IsLinearConstraintDisabled

Gets whether the linear degrees of freedom are locked out entirely.

public bool IsLinearConstraintDisabled { get; }

Property Value

bool

LinearDampingRatio

Gets the linear spring damping ratio.

public float LinearDampingRatio { get; }

Property Value

float

LinearFrequency

Gets the linear spring frequency.

public float LinearFrequency { get; }

Property Value

float

LinearLimit

Gets the linear motion limit along the joint axis.

public Joint.Range LinearLimit { get; }

Property Value

Joint.Range

LinearTargetVelocity

Gets the target linear velocity driven by the linear motor.

public Vector3 LinearTargetVelocity { get; }

Property Value

Vector3

MaxForce

Gets the maximum force the linear motor may apply.

public float MaxForce { get; }

Property Value

float

MaxTorque

Gets the maximum torque the angular motor may apply.

public float MaxTorque { get; }

Property Value

float

Plasticity

Gets the plasticity, how much the joint drives back to its bind pose.

public float Plasticity { get; }

Property Value

float

SwingLimit

Gets the swing cone limit.

public Joint.Range SwingLimit { get; }

Property Value

Joint.Range

Tag

Gets an editor label for this joint.

public string? Tag { get; }

Property Value

string?

TwistLimit

Gets the twist limit around the joint axis.

public Joint.Range TwistLimit { get; }

Property Value

Joint.Range

Type

Gets the constraint type.

public JointType Type { get; }

Property Value

JointType

See Also

VPhysXJoint_t