Legacy Documentation: Version 4.6.2
Language: English
  • C#
  • JS
  • Boo

Script language

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

Animator.GetIKPositionWeight

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 GetIKPositionWeight(goal: AvatarIKGoal): float;
public float GetIKPositionWeight(AvatarIKGoal goal);
public def GetIKPositionWeight(goal as AvatarIKGoal) as float

Parameters

goal The AvatarIKGoal that is queried.

Description

Gets the translative weight of an IK goal (0 = at the original animation before IK, 1 = at the 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 point 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 position of the goal.

See Also: GetIKPosition, SetIKPosition.

Copyright © 2014 Unity Technologies
LearnCommunityAsset StoreBuyDownload