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.

SetIKRotation(goal: AvatarIKGoal, goalRotation: Quaternion): void;
void SetIKRotation(AvatarIKGoal goal, Quaternion goalRotation);
def SetIKRotation(goal as AvatarIKGoal, goalRotation as Quaternion) as void

Parameters

goalThe AvatarIKGoal that is set.
goalRotationThe rotation in world space.

Description

Sets the rotation of an 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 the rotation of the ultimate goal in world space; the actual rotation where the body part ends up is also influenced by a weight parameter that specifies how far between the start and the goal the IK should aim (a value in the range 0..1).

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)