Version: 1.10
LanguageEnglish
  • C#

AnimationAvatarMaskPlayable

struct in UnityEngine.Animations

/

Implemented in:UnityEngine.AnimationModule


Implements interfaces:IPlayable

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 Playable that applies an AvatarMask to animation data.

Used by AnimGraph as an AnimationAvatarMaskNode. NOTE: You can use PlayableExtensions methods with AnimationAvatarMaskPlayable objects.

Public Methods

EqualsDetermines whether this playable and another AnimationAvatarMaskPlayable reference the same handle.
GetHandleReturns the PlayableHandle associated with this playable.
GetUseReferenceReturns whether the playable uses the reference pose when applying the avatar mask.
GetWeightReturns whether the animation channel identified by the specified index is enabled in the mask.
SetAvatarMaskSets the AvatarMask used by this playable.
SetMaskSets whether the animation channel identified by the specified index is enabled in the mask.
SetUseReferenceSets whether the playable uses the reference pose when applying the avatar mask.

Static Methods

CreateCreates an AnimationAvatarMaskPlayable in the specified PlayableGraph.

Operators

AnimationAvatarMaskPlayableExplicitly converts a Playable to an AnimationAvatarMaskPlayable.
PlayableImplicitly converts an AnimationAvatarMaskPlayable to a Playable.