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

    Struct MultiParentConstraintData

    The MultiParent constraint data.

    Namespace: UnityEngine.Animations.Rigging
    Syntax
    [Serializable]
    public struct MultiParentConstraintData : IAnimationJobData, IMultiParentConstraintData

    Properties

    constrainedObject

    The Transform affected by the constraint Source Transforms.

    Declaration
    public Transform constrainedObject { get; set; }
    Property Value
    Type Description
    Transform
    Implements
    IMultiParentConstraintData.constrainedObject

    constrainedPositionXAxis

    Toggles whether the constrained transform will translate along the X axis.

    Declaration
    public bool constrainedPositionXAxis { get; set; }
    Property Value
    Type Description
    Boolean
    Implements
    IMultiParentConstraintData.constrainedPositionXAxis

    constrainedPositionYAxis

    Toggles whether the constrained transform will translate along the Y axis.

    Declaration
    public bool constrainedPositionYAxis { get; set; }
    Property Value
    Type Description
    Boolean
    Implements
    IMultiParentConstraintData.constrainedPositionYAxis

    constrainedPositionZAxis

    Toggles whether the constrained transform will translate along the Z axis.

    Declaration
    public bool constrainedPositionZAxis { get; set; }
    Property Value
    Type Description
    Boolean
    Implements
    IMultiParentConstraintData.constrainedPositionZAxis

    constrainedRotationXAxis

    Toggles whether the constrained transform will rotate along the X axis.

    Declaration
    public bool constrainedRotationXAxis { get; set; }
    Property Value
    Type Description
    Boolean
    Implements
    IMultiParentConstraintData.constrainedRotationXAxis

    constrainedRotationYAxis

    Toggles whether the constrained transform will rotate along the Y axis.

    Declaration
    public bool constrainedRotationYAxis { get; set; }
    Property Value
    Type Description
    Boolean
    Implements
    IMultiParentConstraintData.constrainedRotationYAxis

    constrainedRotationZAxis

    Toggles whether the constrained transform will rotate along the Z axis.

    Declaration
    public bool constrainedRotationZAxis { get; set; }
    Property Value
    Type Description
    Boolean
    Implements
    IMultiParentConstraintData.constrainedRotationZAxis

    maintainPositionOffset

    This is used to maintain the current position offset from the constrained GameObject to the source GameObjects.

    Declaration
    public bool maintainPositionOffset { get; set; }
    Property Value
    Type Description
    Boolean
    Implements
    IMultiParentConstraintData.maintainPositionOffset

    maintainRotationOffset

    This is used to maintain the current rotation offset from the constrained GameObject to the source GameObjects.

    Declaration
    public bool maintainRotationOffset { get; set; }
    Property Value
    Type Description
    Boolean
    Implements
    IMultiParentConstraintData.maintainRotationOffset

    sourceObjects

    The list of Transforms that influence the constrained Transform rotation. Each source has a weight from 0 to 1.

    Declaration
    public WeightedTransformArray sourceObjects { get; set; }
    Property Value
    Type Description
    WeightedTransformArray
    Implements
    IMultiParentConstraintData.sourceObjects

    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()

    IMultiParentConstraintData.sourceObjectsProperty

    The path to the source objects property in the constraint component.

    Declaration
    string IMultiParentConstraintData.sourceObjectsProperty { get; }
    Returns
    Type Description
    String
    Implements
    IMultiParentConstraintData.sourceObjectsProperty
    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