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

    Struct BlendConstraintData

    The Blend constraint data.

    Namespace: UnityEngine.Animations.Rigging
    Syntax
    [Serializable]
    public struct BlendConstraintData : IAnimationJobData, IBlendConstraintData

    Properties

    blendPosition

    Toggles whether position is blended in the constraint.

    Declaration
    public bool blendPosition { get; set; }
    Property Value
    Type Description
    Boolean

    blendRotation

    Toggles whether rotation is blended in the constraint.

    Declaration
    public bool blendRotation { get; set; }
    Property Value
    Type Description
    Boolean

    constrainedObject

    The Transform affected by the two source Transforms.

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

    maintainPositionOffsets

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

    Declaration
    public bool maintainPositionOffsets { get; set; }
    Property Value
    Type Description
    Boolean
    Implements
    IBlendConstraintData.maintainPositionOffsets

    maintainRotationOffsets

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

    Declaration
    public bool maintainRotationOffsets { get; set; }
    Property Value
    Type Description
    Boolean
    Implements
    IBlendConstraintData.maintainRotationOffsets

    positionWeight

    Specifies the weight with which to blend position. A weight of zero will result in the position of sourceObjectA, while a weight of one will result in the position of sourceObjectB.

    Declaration
    public float positionWeight { get; set; }
    Property Value
    Type Description
    Single

    rotationWeight

    Specifies the weight with which to blend rotation. A weight of zero will result in the rotation of sourceObjectA, while a weight of one will result in the rotation of sourceObjectB.

    Declaration
    public float rotationWeight { get; set; }
    Property Value
    Type Description
    Single

    sourceObjectA

    First Transform in blend.

    Declaration
    public Transform sourceObjectA { get; set; }
    Property Value
    Type Description
    Transform
    Implements
    IBlendConstraintData.sourceObjectA

    sourceObjectB

    Second Transform in blend.

    Declaration
    public Transform sourceObjectB { get; set; }
    Property Value
    Type Description
    Transform
    Implements
    IBlendConstraintData.sourceObjectB

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

    IBlendConstraintData.blendPositionBoolProperty

    The path to the blend position property in the constraint component.

    Declaration
    string IBlendConstraintData.blendPositionBoolProperty { get; }
    Returns
    Type Description
    String
    Implements
    IBlendConstraintData.blendPositionBoolProperty

    IBlendConstraintData.blendRotationBoolProperty

    The path to the blend rotation property in the constraint component.

    Declaration
    string IBlendConstraintData.blendRotationBoolProperty { get; }
    Returns
    Type Description
    String
    Implements
    IBlendConstraintData.blendRotationBoolProperty

    IBlendConstraintData.positionWeightFloatProperty

    The path to the position weight property in the constraint component.

    Declaration
    string IBlendConstraintData.positionWeightFloatProperty { get; }
    Returns
    Type Description
    String
    Implements
    IBlendConstraintData.positionWeightFloatProperty

    IBlendConstraintData.rotationWeightFloatProperty

    The path to the rotation weight property in the constraint component.

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