Legacy Documentation: Version 5.5
LanguageEnglish
  • C#
  • JS

Script language

Select your preferred scripting language. All code snippets will be displayed in this language.

ModelImporterClipAnimation.ConfigureClipFromMask

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

public function ConfigureClipFromMask(mask: Animations.AvatarMask): void;
public void ConfigureClipFromMask(Animations.AvatarMask mask);

Parameters

mask AvatarMask from which the mask settings will be imported.

Description

Copy the mask settings from an AvatarMask to the clip configuration.

When writing an AssetPostprocessor, use this method to copy an AvatarMask to your clip configuration.

See also: ModelImporterClipAnimation.ConfigureMaskFromClip.

no example available in JavaScript
public class CopyAvatarMask : AssetPostprocessor 
{
	void OnPreprocessAnimation()
	{
		var modelImporter = assetImporter as ModelImporter;
		
		//Create a new AvatarMask to edit the mask
		var mask = new AvatarMask();
		var clips = modelImporter.clipAnimations;
		
		//Acquire the mask from the clip
		clips[0].ConfigureMaskFromClip(ref mask);
		
		//Filter out the first non-root (0) bone
		mask.SetTransformActive(1, false);
		
		//Apply the mask back to the clip
		clips[0].ConfigureClipFromMask(mask);
		
		//Apply the clips back to the ModelImporter
		modelImporter.clipAnimations = clips;
		
		//Destroy the AvatarMask since we're not using it anymore
		DestroyImmediate(mask);
	}
}