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.

SetIKPosition(goal: AvatarIKGoal, goalPosition: Vector3): void;
void SetIKPosition(AvatarIKGoal goal, Vector3 goalPosition);
def SetIKPosition(goal as AvatarIKGoal, goalPosition as Vector3) as void

Parameters

goalThe AvatarIKGoal that is set.
goalPositionThe position in world space.

Description

Sets the position 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 position of the ultimate goal in world space; the actual point in space 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 objToPickUp: Transform;

private var animator: Animator;


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


function OnAnimatorIK(layerIndex: int) {
	var reach: float = animator.GetFloat("RightHandReach");
	animator.SetIKPositionWeight(AvatarIKGoal.RightHand, reach);
	animator.SetIKPosition(AvatarIKGoal.RightHand, objToPickUp.position);                    
}
using UnityEngine;
using System.Collections;

public class ExampleClass : MonoBehaviour {
    public Transform objToPickUp;
    private Animator animator;
    void Start() {
        animator = GetComponent<Animator>();
    }
    void OnAnimatorIK(int layerIndex) {
        float reach = animator.GetFloat("RightHandReach");
        animator.SetIKPositionWeight(AvatarIKGoal.RightHand, reach);
        animator.SetIKPosition(AvatarIKGoal.RightHand, objToPickUp.position);
    }
}
import UnityEngine
import System.Collections

public class ExampleClass(MonoBehaviour):

	public objToPickUp as Transform

	private animator as Animator

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

	def OnAnimatorIK(layerIndex as int) as void:
		reach as float = animator.GetFloat('RightHandReach')
		animator.SetIKPositionWeight(AvatarIKGoal.RightHand, reach)
		animator.SetIKPosition(AvatarIKGoal.RightHand, objToPickUp.position)