Class AnimationJobBinder<TJob, TData> | Animation Rigging | 1.0.3
docs.unity3d.com
    Show / Hide Table of Contents

    Class AnimationJobBinder<TJob, TData>

    The is the base class for all animation job binders.

    Inheritance
    Object
    AnimationJobBinder<TJob, TData>
    MultiAimInverseConstraintJobBinder<T>
    MultiParentInverseConstraintJobBinder<T>
    MultiPositionInverseConstraintJobBinder<T>
    MultiReferentialInverseConstraintJobBinder<T>
    MultiRotationInverseConstraintJobBinder<T>
    TwistChainInverseConstraintJobBinder<T>
    TwoBoneIKInverseConstraintJobBinder<T>
    BlendConstraintJobBinder<T>
    ChainIKConstraintJobBinder<T>
    DampedTransformJobBinder<T>
    MultiAimConstraintJobBinder<T>
    MultiParentConstraintJobBinder<T>
    MultiPositionConstraintJobBinder<T>
    MultiReferentialConstraintJobBinder<T>
    MultiRotationConstraintJobBinder<T>
    OverrideTransformJobBinder<T>
    TwistChainConstraintJobBinder<T>
    TwistCorrectionJobBinder<T>
    TwoBoneIKConstraintJobBinder<T>
    Namespace: UnityEngine.Animations.Rigging
    Syntax
    public abstract class AnimationJobBinder<TJob, TData> : IAnimationJobBinder where TJob : struct, IAnimationJob where TData : struct, IAnimationJobData
    Type Parameters
    Name Description
    TJob

    The constraint job.

    TData

    The constraint data.

    Methods

    Create(Animator, ref TData, Component)

    Creates the animation job.

    Declaration
    public abstract TJob Create(Animator animator, ref TData data, Component component)
    Parameters
    Type Name Description
    Animator animator

    The animated hierarchy Animator component.

    TData data

    The constraint data.

    Component component

    The constraint component.

    Returns
    Type Description
    TJob

    Returns a new job interface.

    Destroy(TJob)

    Destroys the animation job.

    Declaration
    public abstract void Destroy(TJob job)
    Parameters
    Type Name Description
    TJob job

    The animation job to destroy.

    Update(TJob, ref TData)

    Updates the animation job.

    Declaration
    public virtual void Update(TJob job, ref TData data)
    Parameters
    Type Name Description
    TJob job

    The animation job to update.

    TData data

    The constraint data.

    Explicit Interface Implementations

    IAnimationJobBinder.Create(Animator, IAnimationJobData, Component)

    Creates the animation job.

    Declaration
    IAnimationJob IAnimationJobBinder.Create(Animator animator, IAnimationJobData data, Component component)
    Parameters
    Type Name Description
    Animator animator

    The animated hierarchy Animator component.

    IAnimationJobData data

    The constraint data.

    Component component

    The constraint component.

    Returns
    Type Description
    IAnimationJob

    Returns a new job interface.

    Implements
    IAnimationJobBinder.Create(Animator, IAnimationJobData, Component)

    IAnimationJobBinder.CreatePlayable(PlayableGraph, IAnimationJob)

    Creates an AnimationScriptPlayable with the specified animation job.

    Declaration
    AnimationScriptPlayable IAnimationJobBinder.CreatePlayable(PlayableGraph graph, IAnimationJob job)
    Parameters
    Type Name Description
    PlayableGraph graph

    The PlayableGraph that will own the AnimationScriptPlayable.

    IAnimationJob job

    The animation job to use in the AnimationScriptPlayable.

    Returns
    Type Description
    AnimationScriptPlayable

    Returns a new AnimationScriptPlayable.

    Implements
    IAnimationJobBinder.CreatePlayable(PlayableGraph, IAnimationJob)

    IAnimationJobBinder.Destroy(IAnimationJob)

    Destroys the animation job.

    Declaration
    void IAnimationJobBinder.Destroy(IAnimationJob job)
    Parameters
    Type Name Description
    IAnimationJob job

    The animation job to destroy.

    Implements
    IAnimationJobBinder.Destroy(IAnimationJob)

    IAnimationJobBinder.Update(IAnimationJob, IAnimationJobData)

    Updates the animation job.

    Declaration
    void IAnimationJobBinder.Update(IAnimationJob job, IAnimationJobData data)
    Parameters
    Type Name Description
    IAnimationJob job

    The animation job to update.

    IAnimationJobData data

    The constraint data.

    Implements
    IAnimationJobBinder.Update(IAnimationJob, IAnimationJobData)
    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