Class BakeUtils | Animation Rigging | 1.0.3
docs.unity3d.com
    Show / Hide Table of Contents

    Class BakeUtils

    Utility class that groups bi-directional baking utilities.

    Inheritance
    Object
    BakeUtils
    Namespace: UnityEditor.Animations.Rigging
    Syntax
    public static class BakeUtils

    Methods

    TransferMotionToConstraint(Rig)

    Bakes motion from the skeleton to the constraints in the Rig.

    Declaration
    public static void TransferMotionToConstraint(Rig rig)
    Parameters
    Type Name Description
    Rig rig

    The Rig whose RigConstraints are to be baked.

    TransferMotionToConstraint(RigBuilder)

    Bakes motion from the skeleton to the constraints in the RigBuilder.

    Declaration
    public static void TransferMotionToConstraint(RigBuilder rigBuilder)
    Parameters
    Type Name Description
    RigBuilder rigBuilder

    The RigBuilder whose RigConstraints are to be baked.

    TransferMotionToConstraint<T>(T)

    Bakes motion from the skeleton to the RigConstraint

    Declaration
    public static void TransferMotionToConstraint<T>(T constraint)
        where T : MonoBehaviour, IRigConstraint
    Parameters
    Type Name Description
    T constraint

    The RigConstraint that will be baked to.

    Type Parameters
    Name Description
    T

    Type of RigConstraint that is to be baked.

    TransferMotionToSkeleton(Rig)

    Bakes motion from any RigConstraints in the Rig to the skeleton.

    Declaration
    public static void TransferMotionToSkeleton(Rig rig)
    Parameters
    Type Name Description
    Rig rig

    The Rig whose RigConstraints are to be baked.

    TransferMotionToSkeleton(RigBuilder)

    Bakes motion from any RigConstraints in the RigBuilder to the skeleton.

    Declaration
    public static void TransferMotionToSkeleton(RigBuilder rigBuilder)
    Parameters
    Type Name Description
    RigBuilder rigBuilder

    The RigBuilder whose RigConstraints are to be baked.

    TransferMotionToSkeleton<T>(T)

    Bakes motion from the RigConstraint to the skeleton.

    Declaration
    public static void TransferMotionToSkeleton<T>(T constraint)
        where T : MonoBehaviour, IRigConstraint
    Parameters
    Type Name Description
    T constraint

    The RigConstraint that will be baked to the skeleton.

    Type Parameters
    Name Description
    T

    Type of RigConstraint that is to be baked.

    TransferMotionValidate(Rig)

    Validates if the Editor and the provided Rig are in a correct state to do motion transfer.

    Declaration
    public static bool TransferMotionValidate(Rig rig)
    Parameters
    Type Name Description
    Rig rig

    The Rig that will be used for motion transfer.

    Returns
    Type Description
    Boolean

    Returns true if both the editor and the provided Rig are in a valid state for motion transfer. Returns false if the requirements are not met.

    TransferMotionValidate(RigBuilder)

    Validates if the Editor and the provided RigBuilder are in a correct state to do motion transfer.

    Declaration
    public static bool TransferMotionValidate(RigBuilder rigBuilder)
    Parameters
    Type Name Description
    RigBuilder rigBuilder

    The RigBuilder that will be used for motion transfer.

    Returns
    Type Description
    Boolean

    Returns true if both the editor and the provided RigBuilder are in a valid state for motion transfer. Returns false if the requirements are not met.

    TransferMotionValidate<T>(T)

    Validates if the Editor and the provided RigConstraint are in a correct state to do motion transfer.

    Declaration
    public static bool TransferMotionValidate<T>(T constraint)
        where T : MonoBehaviour, IRigConstraint
    Parameters
    Type Name Description
    T constraint

    The RigConstraint that will be used for motion transfer.

    Returns
    Type Description
    Boolean

    Returns true if both the editor and the provided RigConstraint are in a valid state for motion transfer. Returns false if the requirements are not met.

    Type Parameters
    Name Description
    T

    Type of RigConstraint that is to be validated.

    Back to top
    Copyright © 2023 Unity Technologies — Terms of use
    • Legal
    • Privacy Policy
    • Cookies
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)
    "Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S. and elsewhere (more info here). Other names or brands are trademarks of their respective owners.
    Generated by DocFX on 18 October 2023