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

MuscleHandle

struct in UnityEngine.Experimental.Animations

Switch to Manual

Description

Handle for a muscle in the AnimationHumanStream.

MuscleHandle can only be used on AnimationHumanStream, otherwise an InvalidOperationException is thrown.

using UnityEngine;
using UnityEngine.Animations;
using UnityEngine.Playables;
using UnityEngine.Experimental.Animations;

public struct MuscleHandleExampleJob : IAnimationJob { public MuscleHandle muscleHandle;

public void ProcessRootMotion(AnimationStream stream) {} public void ProcessAnimation(AnimationStream stream) { AnimationHumanStream humanStream = stream.AsHuman();

// Get a muscle value. float muscleValue = humanStream.GetMuscle(muscleHandle);

// Set a muscle value. humanStream.SetMuscle(muscleHandle, muscleValue); } }

[RequireComponent(typeof(Animator))] public class MuscleHandleExample : MonoBehaviour { void Start() { var graph = PlayableGraph.Create(); var output = AnimationPlayableOutput.Create(graph, "output", GetComponent<Animator>());

var job = new MuscleHandleExampleJob(); job.muscleHandle = new MuscleHandle(HumanPartDof.LeftArm, ArmDof.HandDownUp);

var scriptPlayable = AnimationScriptPlayable.Create(graph, job); output.SetSourcePlayable(scriptPlayable);

graph.Evaluate(1.0f);

graph.Destroy(); } }

Static Variables

muscleHandleCountThe total number of DoF parts in a humanoid. (Read Only)

Variables

dofThe muscle human sub-part. (Read Only)
humanPartDofThe muscle human part. (Read Only)
nameThe name of the muscle. (Read Only)

Constructors

MuscleHandleThe different constructors that creates the muscle handle.

Static Functions

GetMuscleHandlesFills the array with all the possible muscle handles on a humanoid.