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

    Struct MultiRotationConstraintData

    The MultiRotation constraint job.

    Namespace: UnityEngine.Animations.Rigging
    Syntax
    [Serializable]
    public struct MultiRotationConstraintData : IAnimationJobData, IMultiRotationConstraintData

    Properties

    constrainedObject

    The Transform affected by the constraint Source Transforms.

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

    constrainedXAxis

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

    Declaration
    public bool constrainedXAxis { get; set; }
    Property Value
    Type Description
    Boolean
    Implements
    IMultiRotationConstraintData.constrainedXAxis

    constrainedYAxis

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

    Declaration
    public bool constrainedYAxis { get; set; }
    Property Value
    Type Description
    Boolean
    Implements
    IMultiRotationConstraintData.constrainedYAxis

    constrainedZAxis

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

    Declaration
    public bool constrainedZAxis { get; set; }
    Property Value
    Type Description
    Boolean
    Implements
    IMultiRotationConstraintData.constrainedZAxis

    maintainOffset

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

    Declaration
    public bool maintainOffset { get; set; }
    Property Value
    Type Description
    Boolean
    Implements
    IMultiRotationConstraintData.maintainOffset

    offset

    Post-Rotation offset applied to the constrained Transform.

    Declaration
    public Vector3 offset { get; set; }
    Property Value
    Type Description
    Vector3

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

    IMultiRotationConstraintData.offsetVector3Property

    The path to the offset property in the constraint component.

    Declaration
    string IMultiRotationConstraintData.offsetVector3Property { get; }
    Returns
    Type Description
    String
    Implements
    IMultiRotationConstraintData.offsetVector3Property

    IMultiRotationConstraintData.sourceObjectsProperty

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

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