Struct BodyFrame

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 constrained.

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

Constructors

BodyFrame(RigidTransform)

Declaration
public BodyFrame(RigidTransform transform)
Parameters
Type Name Description
Unity.Mathematics.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
Unity.Mathematics.float3

Identity

Declaration
public static readonly BodyFrame Identity
Field Value
Type Description
BodyFrame

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
Unity.Mathematics.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
Unity.Mathematics.float3

Methods

AsRigidTransform()

Declaration
public RigidTransform AsRigidTransform()
Returns
Type Description
Unity.Mathematics.RigidTransform

Equals(Object)

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

Equals(BodyFrame)

Declaration
public bool Equals(BodyFrame other)
Parameters
Type Name Description
BodyFrame 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 BodyFrame)

Declaration
public static implicit operator BodyFrame(RigidTransform transform)
Parameters
Type Name Description
Unity.Mathematics.RigidTransform transform
Returns
Type Description
BodyFrame