Struct MultiReferentialConstraintData | Animation Rigging | 1.0.3
docs.unity3d.com
    Show / Hide Table of Contents

    Struct MultiReferentialConstraintData

    The MultiReferential constraint data.

    Namespace: UnityEngine.Animations.Rigging
    Syntax
    [Serializable]
    public struct MultiReferentialConstraintData : IAnimationJobData, IMultiReferentialConstraintData

    Properties

    driver

    The driver index. This is a value in between 0 and the number of sourceObjects.

    Declaration
    public int driver { get; set; }
    Property Value
    Type Description
    Int32

    sourceObjects

    The list of Transforms that are affected by the specified driver.

    Declaration
    public List<Transform> sourceObjects { get; set; }
    Property Value
    Type Description
    List<Transform>

    Methods

    UpdateDriver()

    Updates the driver index to match the number of source objects.

    Declaration
    public void UpdateDriver()

    Explicit Interface Implementations

    IAnimationJobData.IsValid()

    Retrieves the data valid state.

    Declaration
    bool IAnimationJobData.IsValid()
    Returns
    Type Description
    Boolean

    Returns true if data can be successfully used in a constraint. Returns false otherwise.

    Implements
    IAnimationJobData.IsValid()

    IAnimationJobData.SetDefaultValues()

    Resets values to defaults.

    Declaration
    void IAnimationJobData.SetDefaultValues()
    Implements
    IAnimationJobData.SetDefaultValues()

    IMultiReferentialConstraintData.driverIntProperty

    The path to the driver property in the constraint component.

    Declaration
    string IMultiReferentialConstraintData.driverIntProperty { get; }
    Returns
    Type Description
    String
    Implements
    IMultiReferentialConstraintData.driverIntProperty

    IMultiReferentialConstraintData.driverValue

    The driver index. This is a value in between 0 and the number of sourceObjects.

    Declaration
    int IMultiReferentialConstraintData.driverValue { get; }
    Returns
    Type Description
    Int32
    Implements
    IMultiReferentialConstraintData.driverValue

    IMultiReferentialConstraintData.sourceObjects

    The list of Transforms that can act as drivers for the constrained Transform.

    Declaration
    Transform[] IMultiReferentialConstraintData.sourceObjects { get; }
    Returns
    Type Description
    Transform[]
    Implements
    IMultiReferentialConstraintData.sourceObjects
    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