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.

Parameters

layerIndexThe index of the layer on which the IK solver is called.

Description

Callback for setting up animation IK (inverse kinematics).

OnAnimatorIK() is called by the Animator Component immediately before it updates its internal IK system. This callback can be used to set the positions of the IK goals and their respective weights.

var leftFootPositionWeight: float;
var leftFootRotationWeight: float;
var leftFootObj: Transform;

private var animator: Animator;


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


function OnAnimatorIK(layerIndex: int) {
	animator.SetIKPositionWeight(AvatarIKGoal.LeftFoot,leftFootPositionWeight);
	animator.SetIKRotationWeight(AvatarIKGoal.LeftFoot,leftFootRotationWeight);     
	animator.SetIKPosition(AvatarIKGoal.LeftFoot,leftFootObj.position);                    
	animator.SetIKRotation(AvatarIKGoal.LeftFoot,leftFootObj.rotation);
}
using UnityEngine;
using System.Collections;

public class ExampleClass : MonoBehaviour {
    public float leftFootPositionWeight;
    public float leftFootRotationWeight;
    public Transform leftFootObj;
    private Animator animator;
    void Start() {
        animator = GetComponent<Animator>();
    }
    void OnAnimatorIK(int layerIndex) {
        animator.SetIKPositionWeight(AvatarIKGoal.LeftFoot, leftFootPositionWeight);
        animator.SetIKRotationWeight(AvatarIKGoal.LeftFoot, leftFootRotationWeight);
        animator.SetIKPosition(AvatarIKGoal.LeftFoot, leftFootObj.position);
        animator.SetIKRotation(AvatarIKGoal.LeftFoot, leftFootObj.rotation);
    }
}
import UnityEngine
import System.Collections

public class ExampleClass(MonoBehaviour):

	public leftFootPositionWeight as float

	public leftFootRotationWeight as float

	public leftFootObj as Transform

	private animator as Animator

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

	def OnAnimatorIK(layerIndex as int) as void:
		animator.SetIKPositionWeight(AvatarIKGoal.LeftFoot, leftFootPositionWeight)
		animator.SetIKRotationWeight(AvatarIKGoal.LeftFoot, leftFootRotationWeight)
		animator.SetIKPosition(AvatarIKGoal.LeftFoot, leftFootObj.position)
		animator.SetIKRotation(AvatarIKGoal.LeftFoot, leftFootObj.rotation)