Interface IMultiAimConstraintData | Animation Rigging | 1.0.3
docs.unity3d.com
    Show / Hide Table of Contents

    Interface IMultiAimConstraintData

    This interface defines the data mapping for the MultiAim constraint.

    Namespace: UnityEngine.Animations.Rigging
    Syntax
    public interface IMultiAimConstraintData

    Properties

    aimAxis

    Specifies the local aim axis of the constrained Transform to use in order to orient itself to the Source Transforms.

    Declaration
    Vector3 aimAxis { get; }
    Property Value
    Type Description
    Vector3

    constrainedObject

    The Transform affected by the constraint Source Transforms.

    Declaration
    Transform constrainedObject { get; }
    Property Value
    Type Description
    Transform

    constrainedXAxis

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

    Declaration
    bool constrainedXAxis { get; }
    Property Value
    Type Description
    Boolean

    constrainedYAxis

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

    Declaration
    bool constrainedYAxis { get; }
    Property Value
    Type Description
    Boolean

    constrainedZAxis

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

    Declaration
    bool constrainedZAxis { get; }
    Property Value
    Type Description
    Boolean

    maintainOffset

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

    Declaration
    bool maintainOffset { get; }
    Property Value
    Type Description
    Boolean

    maxLimitFloatProperty

    The path to the maximum limit property in the constraint component.

    Declaration
    string maxLimitFloatProperty { get; }
    Property Value
    Type Description
    String

    minLimitFloatProperty

    The path to the minimum limit property in the constraint component.

    Declaration
    string minLimitFloatProperty { get; }
    Property Value
    Type Description
    String

    offsetVector3Property

    The path to the offset property in the constraint component.

    Declaration
    string offsetVector3Property { get; }
    Property Value
    Type Description
    String

    sourceObjects

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

    Declaration
    WeightedTransformArray sourceObjects { get; }
    Property Value
    Type Description
    WeightedTransformArray

    sourceObjectsProperty

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

    Declaration
    string sourceObjectsProperty { get; }
    Property Value
    Type Description
    String

    upAxis

    Specified the local up axis of the constrained Transform to use in order to orient itself to the Source Transforms.

    Declaration
    Vector3 upAxis { get; }
    Property Value
    Type Description
    Vector3

    worldUpAxis

    A static vector in world coordinates that is the general upward direction. This is used when World Up Type is set to WorldUpType.Vector.

    Declaration
    Vector3 worldUpAxis { get; }
    Property Value
    Type Description
    Vector3

    worldUpObject

    The Transform used to calculate the upward direction. This is used when World Up Type is set to WorldUpType.ObjectUp or WorldUpType.ObjectRotationUp.

    Declaration
    Transform worldUpObject { get; }
    Property Value
    Type Description
    Transform

    worldUpType

    Specifies which mode to use to keep the upward direction of the constrained Object.

    Declaration
    int worldUpType { get; }
    Property Value
    Type Description
    Int32
    See Also
    MultiAimConstraintJob.WorldUpType
    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