Struct JointFrame

A target in the space of a rigid body that will align with a corresponding target in the space of the other body to which it is joined.

Namespace: Unity.Physics
Syntax
public struct JointFrame : IEquatable<JointFrame>

Constructors

JointFrame(RigidTransform)

Declaration
public JointFrame(RigidTransform transform)
Parameters
Type Name Description
RigidTransform transform

Fields

Axis

The bind pose orientation of the joint's x-axis in the space of its rigid body.

Declaration
public float3 Axis
Field Value
Type Description
float3

Identity

Declaration
public static readonly JointFrame Identity
Field Value
Type Description
JointFrame

PerpendicularAxis

The bind pose orientation of the joint's y-axis in the space of its rigid body.

Declaration
public float3 PerpendicularAxis
Field Value
Type Description
float3

Position

The bind pose anchor or target position of the joint in the space of its rigid body.

Declaration
public float3 Position
Field Value
Type Description
float3

Methods

AsRigidTransform()

Declaration
public RigidTransform AsRigidTransform()
Returns
Type Description
RigidTransform

Equals(Object)

Declaration
public override bool Equals(object obj)
Parameters
Type Name Description
Object obj
Returns
Type Description
Boolean
Overrides

Equals(JointFrame)

Declaration
public bool Equals(JointFrame other)
Parameters
Type Name Description
JointFrame other
Returns
Type Description
Boolean

GetHashCode()

Declaration
public override int GetHashCode()
Returns
Type Description
Int32
Overrides

ToString()

Declaration
public override string ToString()
Returns
Type Description
String
Overrides

Operators

Implicit(RigidTransform to JointFrame)

Declaration
public static implicit operator JointFrame(RigidTransform transform)
Parameters
Type Name Description
RigidTransform transform
Returns
Type Description
JointFrame