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

    Struct TwistChainConstraintJob

    The TwistChain constraint job.

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

    Fields

    chain

    An array of Transform handles that represents the Transform chain.

    Declaration
    public NativeArray<ReadWriteTransformHandle> chain
    Field Value
    Type Description
    NativeArray<ReadWriteTransformHandle>

    rootTarget

    The Transform handle for the root target Transform.

    Declaration
    public ReadWriteTransformHandle rootTarget
    Field Value
    Type Description
    ReadWriteTransformHandle

    rotations

    An array of rotation offsets to maintain the chain initial shape.

    Declaration
    public NativeArray<Quaternion> rotations
    Field Value
    Type Description
    NativeArray<Quaternion>

    steps

    An array of interpolant values used to reevaluate the weights.

    Declaration
    public NativeArray<float> steps
    Field Value
    Type Description
    NativeArray<Single>

    tipTarget

    The Transform handle for the tip target Transform.

    Declaration
    public ReadWriteTransformHandle tipTarget
    Field Value
    Type Description
    ReadWriteTransformHandle

    weights

    An array of weight values used to adjust how twist is distributed along the chain.

    Declaration
    public NativeArray<float> weights
    Field Value
    Type Description
    NativeArray<Single>

    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