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.
CloseFor some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.
Closegoal | The AvatarIKGoal that is set. |
goalRotation | The rotation of the goal in world space which should follow Unity's world coordinates convention (see below). |
Sets the rotation of an IK goal.
An IK goal is a specified target position and rotation for a specific body part. Unity calculates how to move the body part towards this target from a starting point. This starting point could be, for example, the current position and rotation obtained from an animation.
This function sets the IK goal rotation in world space. When specifying the IK goal rotation, it should follow Unity's world coordinates convention:
• The X-Axis
is parallel to the palm of the hand (or sole of the foot), pointing sideways to the right of the hand (or foot).
• The Y-Axis
is perpendicular to the top of the hand (or foot), pointing upwards.
• The Z-Axis
is parallel to the palm of the hand (or sole of the foot), pointing forwards toward the fingers (or toes).
It is recommended that the bone orientation of the avatar skeleton pose should also follow Unity's world coordinates convention. If your avatar skeleton pose follows a different convention, the bone rotation applied to the corresponding GameObject
might differ from the IK goal rotation.
In addition, you can set a weight value to set the amount of influence that the IK goal rotation has over the starting rotation. Use the SetIKRotationWeight
method to set a weight value between 0..1 where a weight of 0 means no influence and a weight of 1 means full influence.
The following code example demonstrates how to use the SetIKRotation
method and SetIKRotationWeight
method.
using UnityEngine;
public class Example : MonoBehaviour { Transform objToAimAt; 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); } }
Additional resources: SetIKRotationWeight, SetIKPosition.
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.