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.
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
Field Value
Identity
Declaration
public static readonly BodyFrame Identity
Field Value
PerpendicularAxis
The bind pose orientation of the joint's y-axis in the space of its rigid body.
Declaration
public float3 PerpendicularAxis
Field Value
Position
The bind pose anchor or target position of the joint in the space of its rigid body.
Declaration
Field Value
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
Equals(BodyFrame)
Declaration
public bool Equals(BodyFrame other)
Parameters
Returns
GetHashCode()
Declaration
public override int GetHashCode()
Returns
ToString()
Declaration
public override string ToString()
Returns
Operators
Implicit(RigidTransform to BodyFrame)
Declaration
public static implicit operator BodyFrame(RigidTransform transform)
Parameters
| Type |
Name |
Description |
| RigidTransform |
transform |
|
Returns
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.