Class RigConstraint<TJob, TData, TBinder> | Animation Rigging | 0.3.4-preview
docs.unity3d.com
    Show / Hide Table of Contents

    Class RigConstraint<TJob, TData, TBinder>

    Inheritance
    Object
    Object
    Component
    Behaviour
    MonoBehaviour
    RigConstraint<TJob, TData, TBinder>
    BlendConstraint
    ChainIKConstraint
    DampedTransform
    MultiAimConstraint
    MultiParentConstraint
    MultiPositionConstraint
    MultiReferentialConstraint
    MultiRotationConstraint
    OverrideTransform
    TwistChainConstraint
    TwistCorrection
    TwoBoneIKConstraint
    Inherited Members
    MonoBehaviour.IsInvoking()
    MonoBehaviour.CancelInvoke()
    MonoBehaviour.Invoke(String, Single)
    MonoBehaviour.InvokeRepeating(String, Single, Single)
    MonoBehaviour.CancelInvoke(String)
    MonoBehaviour.IsInvoking(String)
    MonoBehaviour.StartCoroutine(String)
    MonoBehaviour.StartCoroutine(String, Object)
    MonoBehaviour.StartCoroutine(IEnumerator)
    MonoBehaviour.StartCoroutine_Auto(IEnumerator)
    MonoBehaviour.StopCoroutine(IEnumerator)
    MonoBehaviour.StopCoroutine(Coroutine)
    MonoBehaviour.StopCoroutine(String)
    MonoBehaviour.StopAllCoroutines()
    MonoBehaviour.print(Object)
    MonoBehaviour.useGUILayout
    MonoBehaviour.runInEditMode
    Behaviour.enabled
    Behaviour.isActiveAndEnabled
    Component.GetComponent(Type)
    Component.GetComponent<T>()
    Component.TryGetComponent(Type, Component)
    Component.TryGetComponent<T>(T)
    Component.GetComponent(String)
    Component.GetComponentInChildren(Type, Boolean)
    Component.GetComponentInChildren(Type)
    Component.GetComponentInChildren<T>(Boolean)
    Component.GetComponentInChildren<T>()
    Component.GetComponentsInChildren(Type, Boolean)
    Component.GetComponentsInChildren(Type)
    Component.GetComponentsInChildren<T>(Boolean)
    Component.GetComponentsInChildren<T>(Boolean, List<T>)
    Component.GetComponentsInChildren<T>()
    Component.GetComponentsInChildren<T>(List<T>)
    Component.GetComponentInParent(Type)
    Component.GetComponentInParent<T>()
    Component.GetComponentsInParent(Type, Boolean)
    Component.GetComponentsInParent(Type)
    Component.GetComponentsInParent<T>(Boolean)
    Component.GetComponentsInParent<T>(Boolean, List<T>)
    Component.GetComponentsInParent<T>()
    Component.GetComponents(Type)
    Component.GetComponents(Type, List<Component>)
    Component.GetComponents<T>(List<T>)
    Component.GetComponents<T>()
    Component.CompareTag(String)
    Component.SendMessageUpwards(String, Object, SendMessageOptions)
    Component.SendMessageUpwards(String, Object)
    Component.SendMessageUpwards(String)
    Component.SendMessageUpwards(String, SendMessageOptions)
    Component.SendMessage(String, Object)
    Component.SendMessage(String)
    Component.SendMessage(String, Object, SendMessageOptions)
    Component.SendMessage(String, SendMessageOptions)
    Component.BroadcastMessage(String, Object, SendMessageOptions)
    Component.BroadcastMessage(String, Object)
    Component.BroadcastMessage(String)
    Component.BroadcastMessage(String, SendMessageOptions)
    Component.transform
    Component.gameObject
    Component.tag
    Component.rigidbody
    Component.rigidbody2D
    Component.camera
    Component.light
    Component.animation
    Component.constantForce
    Component.renderer
    Component.audio
    Component.networkView
    Component.collider
    Component.collider2D
    Component.hingeJoint
    Component.particleSystem
    Object.GetInstanceID()
    Object.GetHashCode()
    Object.Equals(Object)
    Object.Instantiate(Object, Vector3, Quaternion)
    Object.Instantiate(Object, Vector3, Quaternion, Transform)
    Object.Instantiate(Object)
    Object.Instantiate(Object, Transform)
    Object.Instantiate(Object, Transform, Boolean)
    Object.Instantiate<T>(T)
    Object.Instantiate<T>(T, Vector3, Quaternion)
    Object.Instantiate<T>(T, Vector3, Quaternion, Transform)
    Object.Instantiate<T>(T, Transform)
    Object.Instantiate<T>(T, Transform, Boolean)
    Object.Destroy(Object, Single)
    Object.Destroy(Object)
    Object.DestroyImmediate(Object, Boolean)
    Object.DestroyImmediate(Object)
    Object.FindObjectsOfType(Type)
    Object.FindObjectsOfType(Type, Boolean)
    Object.DontDestroyOnLoad(Object)
    Object.DestroyObject(Object, Single)
    Object.DestroyObject(Object)
    Object.FindSceneObjectsOfType(Type)
    Object.FindObjectsOfTypeIncludingAssets(Type)
    Object.FindObjectsOfType<T>()
    UnityEngine.Object.FindObjectsOfType<T>(System.Boolean)
    Object.FindObjectOfType<T>()
    UnityEngine.Object.FindObjectOfType<T>(System.Boolean)
    Object.FindObjectsOfTypeAll(Type)
    Object.FindObjectOfType(Type)
    Object.FindObjectOfType(Type, Boolean)
    Object.ToString()
    Object.name
    Object.hideFlags
    Namespace: UnityEngine.Animations.Rigging
    Syntax
    public class RigConstraint<TJob, TData, TBinder> : MonoBehaviour, IRigConstraint where TJob : struct, IWeightedAnimationJob where TData : struct, IAnimationJobData where TBinder : AnimationJobBinder<TJob, TData>, new()
    Type Parameters
    Name Description
    TJob
    TData
    TBinder

    Fields

    m_Data

    Declaration
    [SerializeField]
    protected TData m_Data
    Field Value
    Type Description
    TData

    m_Weight

    Declaration
    [SerializeField]
    [Range(0F, 1F)]
    protected float m_Weight
    Field Value
    Type Description
    Single

    Properties

    data

    Declaration
    public TData data { get; }
    Property Value
    Type Description
    TData

    weight

    Declaration
    public float weight { get; set; }
    Property Value
    Type Description
    Single
    Implements
    IRigConstraint.weight

    Methods

    CreateJob(Animator)

    Declaration
    public IAnimationJob CreateJob(Animator animator)
    Parameters
    Type Name Description
    Animator animator
    Returns
    Type Description
    IAnimationJob
    Implements
    IRigConstraint.CreateJob(Animator)

    DestroyJob(IAnimationJob)

    Declaration
    public void DestroyJob(IAnimationJob job)
    Parameters
    Type Name Description
    IAnimationJob job
    Implements
    IRigConstraint.DestroyJob(IAnimationJob)

    IsValid()

    Declaration
    public bool IsValid()
    Returns
    Type Description
    Boolean
    Implements
    IRigConstraint.IsValid()

    Reset()

    Declaration
    public void Reset()

    UpdateJob(IAnimationJob)

    Declaration
    public void UpdateJob(IAnimationJob job)
    Parameters
    Type Name Description
    IAnimationJob job
    Implements
    IRigConstraint.UpdateJob(IAnimationJob)

    Explicit Interface Implementations

    IRigConstraint.binder

    Declaration
    IAnimationJobBinder IRigConstraint.binder { get; }
    Returns
    Type Description
    IAnimationJobBinder
    Implements
    IRigConstraint.binder

    IRigConstraint.component

    Declaration
    Component IRigConstraint.component { get; }
    Returns
    Type Description
    Component
    Implements
    IRigConstraint.component

    IRigConstraint.data

    Declaration
    IAnimationJobData IRigConstraint.data { get; }
    Returns
    Type Description
    IAnimationJobData
    Implements
    IRigConstraint.data
    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