docs.unity3d.com
    Show / Hide Table of Contents

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

    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

    ToString()

    Declaration
    public override string ToString()
    Returns
    Type Description
    String

    Operators

    Implicit(RigidTransform to BodyFrame)

    Declaration
    public static implicit operator BodyFrame(RigidTransform transform)
    Parameters
    Type Name Description
    RigidTransform transform
    Returns
    Type Description
    BodyFrame
    In This Article
    • Constructors
      • BodyFrame(RigidTransform)
    • Fields
      • Axis
      • Identity
      • PerpendicularAxis
      • Position
    • Methods
      • AsRigidTransform()
      • Equals(Object)
      • Equals(BodyFrame)
      • GetHashCode()
      • ToString()
    • Operators
      • Implicit(RigidTransform to BodyFrame)
    Back to top
    Terms of use
    Copyright © 2023 Unity Technologies — Terms of use
    • Legal
    • Privacy Policy
    • Cookies
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)
    "Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S. and elsewhere (more info here). Other names or brands are trademarks of their respective owners.
    Generated by DocFX on 18 October 2023