LanguageEnglish
  • C#
  • JS

Script language

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

Animator.GetIKRotationWeight

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

Sumbission failed

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

Close

Cancel

Switch to Manual
public function GetIKRotationWeight(goal: AvatarIKGoal): float;
public float GetIKRotationWeight(AvatarIKGoal goal);

Parameters

goal The AvatarIKGoal that is queried.

Description

Gets the rotational weight of an IK goal (0 = rotation before IK, 1 = rotation at the IK goal).

An IK goal is a target position and rotation for a specific body part. Unity can calculate how to move the part toward the target from the starting point (ie, the current position and rotation obtained from the animation).

The rotation calculated by the IK is also influenced by a weight value in the range 0..1 that determines how far between the start and the goal to aim. This function returns the current weight value for the rotation of the goal.

See Also: GetIKRotation, SetIKRotation.

Copyright © 2015 Unity Technologies
Learn Community Asset Store Buy Download