Experimental: this API is experimental and might be changed or removed in the future.

SpriteBone

struct in UnityEngine.Experimental.U2D

/

Implemented in:UnityEngine.CoreModule

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Description

A struct that holds a rich set of information that describes the bind pose of this Sprite.

Most importantly this struct describes the hierarchy and various other spatial relationships between the bones.

Properties

lengthThe length of the bone. This is important for the leaf bones to describe their length without needing another bone as the terminal bone.
nameThe name of the bone. This is useful when recreating bone hierarchy at editor or runtime. You can also use this as a way of resolving the bone path when a Sprite is bound to a more complex or richer hierarchy.
parentIdThe ID of the parent of this bone.
positionThe position in local space of this bone.
rotationThe rotation of this bone in local space.

Did you find this page useful? Please give it a rating: