Class BoneRenderer

The BoneRenderer component is responsible for displaying pickable bones in the Scene View. This component does nothing during runtime.

Inheritance

object

Object

Component

Behaviour

MonoBehaviour

BoneRenderer

Inherited Members

MonoBehaviour.IsInvoking()

MonoBehaviour.CancelInvoke()

MonoBehaviour.Invoke(string, float)

MonoBehaviour.InvokeRepeating(string, float, float)

MonoBehaviour.CancelInvoke(string)

MonoBehaviour.IsInvoking(string)

MonoBehaviour.StartCoroutine(string)

MonoBehaviour.StartCoroutine(string, object)

MonoBehaviour.StartCoroutine(IEnumerator)

MonoBehaviour.StartCoroutine_Auto(IEnumerator)

MonoBehaviour.StopCoroutine(IEnumerator)

MonoBehaviour.StopCoroutine(Coroutine)

MonoBehaviour.StopCoroutine(string)

MonoBehaviour.StopAllCoroutines()

MonoBehaviour.print(object)

MonoBehaviour.destroyCancellationToken

MonoBehaviour.useGUILayout

MonoBehaviour.runInEditMode

Behaviour.enabled

Behaviour.isActiveAndEnabled

Component.GetComponent(Type)

Component.GetComponent<T>()

Component.TryGetComponent(Type, out Component)

Component.TryGetComponent<T>(out T)

Component.GetComponent(string)

Component.GetComponentInChildren(Type, bool)

Component.GetComponentInChildren(Type)

Component.GetComponentInChildren<T>(bool)

Component.GetComponentInChildren<T>()

Component.GetComponentsInChildren(Type, bool)

Component.GetComponentsInChildren(Type)

Component.GetComponentsInChildren<T>(bool)

Component.GetComponentsInChildren<T>(bool, List<T>)

Component.GetComponentsInChildren<T>()

Component.GetComponentsInChildren<T>(List<T>)

Component.GetComponentInParent(Type, bool)

Component.GetComponentInParent(Type)

Component.GetComponentInParent<T>(bool)

Component.GetComponentInParent<T>()

Component.GetComponentsInParent(Type, bool)

Component.GetComponentsInParent(Type)

Component.GetComponentsInParent<T>(bool)

Component.GetComponentsInParent<T>(bool, List<T>)

Component.GetComponentsInParent<T>()

Component.GetComponents(Type)

Component.GetComponents(Type, List<Component>)

Component.GetComponents<T>(List<T>)

Component.GetComponents<T>()

Component.CompareTag(string)

Component.SendMessageUpwards(string, object, SendMessageOptions)

Component.SendMessageUpwards(string, object)

Component.SendMessageUpwards(string)

Component.SendMessageUpwards(string, SendMessageOptions)

Component.SendMessage(string, object)

Component.SendMessage(string)

Component.SendMessage(string, object, SendMessageOptions)

Component.SendMessage(string, SendMessageOptions)

Component.BroadcastMessage(string, object, SendMessageOptions)

Component.BroadcastMessage(string, object)

Component.BroadcastMessage(string)

Component.BroadcastMessage(string, SendMessageOptions)

Component.transform

Component.gameObject

Component.tag

Object.GetInstanceID()

Object.GetHashCode()

Object.Equals(object)

Object.Instantiate(Object, Vector3, Quaternion)

Object.Instantiate(Object, Vector3, Quaternion, Transform)

Object.Instantiate(Object)

Object.Instantiate(Object, Transform)

Object.Instantiate(Object, Transform, bool)

Object.Instantiate<T>(T)

Object.Instantiate<T>(T, Vector3, Quaternion)

Object.Instantiate<T>(T, Vector3, Quaternion, Transform)

Object.Instantiate<T>(T, Transform)

Object.Instantiate<T>(T, Transform, bool)

Object.Destroy(Object, float)

Object.Destroy(Object)

Object.DestroyImmediate(Object, bool)

Object.DestroyImmediate(Object)

Object.FindObjectsOfType(Type)

Object.FindObjectsOfType(Type, bool)

Object.FindObjectsByType(Type, FindObjectsSortMode)

Object.FindObjectsByType(Type, FindObjectsInactive, FindObjectsSortMode)

Object.DontDestroyOnLoad(Object)

Object.DestroyObject(Object, float)

Object.DestroyObject(Object)

Object.FindSceneObjectsOfType(Type)

Object.FindObjectsOfTypeIncludingAssets(Type)

Object.FindObjectsOfType<T>()

Object.FindObjectsByType<T>(FindObjectsSortMode)

Object.FindObjectsOfType<T>(bool)

Object.FindObjectsByType<T>(FindObjectsInactive, FindObjectsSortMode)

Object.FindObjectOfType<T>()

Object.FindObjectOfType<T>(bool)

Object.FindFirstObjectByType<T>()

Object.FindAnyObjectByType<T>()

Object.FindFirstObjectByType<T>(FindObjectsInactive)

Object.FindAnyObjectByType<T>(FindObjectsInactive)

Object.FindObjectsOfTypeAll(Type)

Object.FindObjectOfType(Type)

Object.FindFirstObjectByType(Type)

Object.FindAnyObjectByType(Type)

Object.FindObjectOfType(Type, bool)

Object.FindFirstObjectByType(Type, FindObjectsInactive)

Object.FindAnyObjectByType(Type, FindObjectsInactive)

Object.ToString()

Object.name

Object.hideFlags

object.Equals(object, object)

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Namespace: UnityEngine.Animations.Rigging

Assembly: Unity.Animation.Rigging.dll

Syntax

[ExecuteInEditMode]
[AddComponentMenu("Animation Rigging/Setup/Bone Renderer")]
[HelpURL("https://docs.unity3d.com/Packages/com.unity.animation.rigging@1.3/manual/RiggingWorkflow.html#bone-renderer-component")]
public class BoneRenderer : MonoBehaviour

Fields

boneColor

Color of the bones.

Declaration

public Color boneColor

Field Value

Type	Description
Color

boneShape

Shape of the bones.

Declaration

public BoneRenderer.BoneShape boneShape

Field Value

Type	Description
BoneRenderer.BoneShape

boneSize

Size of the bones.

Declaration

[Range(0.01, 5)]
public float boneSize

Field Value

Type	Description
float

drawBones

Toggles whether to render bone shapes or not.

Declaration

public bool drawBones

Field Value

Type	Description
bool

drawTripods

Toggles whether to draw tripods on bones or not.

Declaration

public bool drawTripods

Field Value

Type	Description
bool

onAddBoneRenderer

Notification callback that is sent whenever a BoneRenderer calls OnEnable.

Declaration

public static BoneRenderer.OnAddBoneRendererCallback onAddBoneRenderer

Field Value

Type	Description
BoneRenderer.OnAddBoneRendererCallback

onRemoveBoneRenderer

Notification callback that is sent whenever a BoneRenderer calls OnDisable.

Declaration

public static BoneRenderer.OnRemoveBoneRendererCallback onRemoveBoneRenderer

Field Value

Type	Description
BoneRenderer.OnRemoveBoneRendererCallback

tripodSize

Size of the tripod axis.

Declaration

[Range(0.01, 5)]
public float tripodSize

Field Value

Type	Description
float

Properties

bones

Retrieves the bones isolated from the Transform references.

Declaration

public BoneRenderer.TransformPair[] bones { get; }

Property Value

Type	Description
TransformPair[]

See Also

transforms

tips

Retrieves the tip bones isolated from the Transform references.

Declaration

public Transform[] tips { get; }

Property Value

Type	Description
Transform[]

See Also

transforms

transforms

Transform references in the BoneRenderer hierarchy that are used to build bones.

Declaration

public Transform[] transforms { get; set; }

Property Value

Type	Description
Transform[]

Methods

ClearBones()

Clears bones and tip bones.

Declaration

public void ClearBones()

ExtractBones()

Builds bones and tip bones from Transform references.

Declaration

public void ExtractBones()

Invalidate()

Invalidate and Rebuild bones and tip bones from Transform references.

Declaration

public void Invalidate()

Reset()

Resets the BoneRenderer to default values.

Declaration

public void Reset()