Documentation

Unity Engine

User Manual

Script Reference

Unity Engine

SetIKRotationWeight(AvatarIKGoal, float)

Sets the rotational weight of an IK goal (0 = rotation before IK, 1 = rotation at the IK goal).
Read time 1 minuteLast updated 4 days ago

Definition

  • Type: Method
  • Namespace: UnityEngine
  • Assembly: UnityEngine.AnimationModule
public void SetIKRotationWeight(AvatarIKGoal goal, float value)

Parameters

goal

AvatarIKGoal
The AvatarIKGoal that is set.

value

float
The rotational weight.

Remarks

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 Animator.SetIKRotation.
Additional Resources: Animator.SetIKRotation, Animator.SetIKPositionWeight

Examples

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);    }}