Legacy Documentation: Version 4.5.0

Script language:

  • JS
  • C#
  • Boo
Script language

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

Animator.SetIKRotationWeight

Switch to Manual
SetIKRotationWeight(goal: AvatarIKGoal, value: float): void;
void SetIKRotationWeight(AvatarIKGoal goal, float value);
def SetIKRotationWeight(goal as AvatarIKGoal, value as float) as void

Parameters

goalThe AvatarIKGoal that is set.
valueThe rotational weight.

Description

Sets 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).

This function sets a weight value in the range 0..1 to determine how far between the start and goal rotations the IK will aim. The goal itself is set separately using SetIKRotation.

var objToAimAt: Transform;

private var animator: Animator;


function Start() {
	animator = GetComponent.<Animator>();
}


function OnAnimatorIK(layerIndex: int) {
	var handRotation = Quaternion.LookRotation(objToAimAt.position - transform.position);
	animator.SetIKRotationWeight(AvatarIKGoal.RightHand, 1.0);
	animator.SetIKRotation(AvatarIKGoal.RightHand, handRotation);                    
}
using UnityEngine;
using System.Collections;

public class ExampleClass : MonoBehaviour {
    public Transform objToAimAt;
    private Animator animator;
    void Start() {
        animator = GetComponent<Animator>();
    }
    void OnAnimatorIK(int layerIndex) {
        Quaternion handRotation = Quaternion.LookRotation(objToAimAt.position - transform.position);
        animator.SetIKRotationWeight(AvatarIKGoal.RightHand, 1.0F);
        animator.SetIKRotation(AvatarIKGoal.RightHand, handRotation);
    }
}
import UnityEngine
import System.Collections

public class ExampleClass(MonoBehaviour):

	public objToAimAt as Transform

	private animator as Animator

	def Start() as void:
		animator = GetComponent[of Animator]()

	def OnAnimatorIK(layerIndex as int) as void:
		handRotation as Quaternion = Quaternion.LookRotation((objToAimAt.position - transform.position))
		animator.SetIKRotationWeight(AvatarIKGoal.RightHand, 1.0F)
		animator.SetIKRotation(AvatarIKGoal.RightHand, handRotation)