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

    Struct BlendConstraintJob

    The Blend constraint job.

    Namespace: UnityEngine.Animations.Rigging
    Syntax
    public struct BlendConstraintJob : IWeightedAnimationJob, IAnimationJob

    Fields

    blendPosition

    Toggles whether to blend position in the job.

    Declaration
    public BoolProperty blendPosition
    Field Value
    Type Description
    BoolProperty

    blendRotation

    Toggles whether to blend rotation in the job.

    Declaration
    public BoolProperty blendRotation
    Field Value
    Type Description
    BoolProperty

    driven

    The Transform handle for the constrained object Transform.

    Declaration
    public ReadWriteTransformHandle driven
    Field Value
    Type Description
    ReadWriteTransformHandle

    positionWeight

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

    Declaration
    public FloatProperty positionWeight
    Field Value
    Type Description
    FloatProperty

    rotationWeight

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

    Declaration
    public FloatProperty rotationWeight
    Field Value
    Type Description
    FloatProperty

    sourceA

    The Transform handle for sourceA Transform.

    Declaration
    public ReadOnlyTransformHandle sourceA
    Field Value
    Type Description
    ReadOnlyTransformHandle

    sourceAOffset

    TR offset to apply to sourceA if maintainOffset is enabled.

    Declaration
    public AffineTransform sourceAOffset
    Field Value
    Type Description
    AffineTransform

    sourceB

    The Transform handle for sourceB Transform.

    Declaration
    public ReadOnlyTransformHandle sourceB
    Field Value
    Type Description
    ReadOnlyTransformHandle

    sourceBOffset

    TR offset to apply to sourceB if maintainOffset is enabled.

    Declaration
    public AffineTransform sourceBOffset
    Field Value
    Type Description
    AffineTransform

    Properties

    jobWeight

    The main weight given to the constraint. This is a value in between 0 and 1.

    Declaration
    public FloatProperty jobWeight { get; set; }
    Property Value
    Type Description
    FloatProperty
    Implements
    IWeightedAnimationJob.jobWeight

    Methods

    ProcessAnimation(AnimationStream)

    Defines what to do when processing the animation.

    Declaration
    public void ProcessAnimation(AnimationStream stream)
    Parameters
    Type Name Description
    AnimationStream stream

    The animation stream to work on.

    Implements
    IAnimationJob.ProcessAnimation(AnimationStream)

    ProcessRootMotion(AnimationStream)

    Defines what to do when processing the root motion.

    Declaration
    public void ProcessRootMotion(AnimationStream stream)
    Parameters
    Type Name Description
    AnimationStream stream

    The animation stream to work on.

    Implements
    IAnimationJob.ProcessRootMotion(AnimationStream)
    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