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

    Struct OverrideTransformJob

    The OverrideTransform job.

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

    Fields

    cache

    Cache for static properties in the job.

    Declaration
    public AnimationJobCache cache
    Field Value
    Type Description
    AnimationJobCache

    driven

    The Transform handle for the constrained object Transform.

    Declaration
    public ReadWriteTransformHandle driven
    Field Value
    Type Description
    ReadWriteTransformHandle

    position

    The override position.

    Declaration
    public Vector3Property position
    Field Value
    Type Description
    Vector3Property

    positionWeight

    The weight for which override position has an effect on the constrained Transform. This is a value in between 0 and 1.

    Declaration
    public FloatProperty positionWeight
    Field Value
    Type Description
    FloatProperty

    rotation

    The override rotation.

    Declaration
    public Vector3Property rotation
    Field Value
    Type Description
    Vector3Property

    rotationWeight

    The weight for which override rotation has an effect on the constrained Transform. This is a value in between 0 and 1.

    Declaration
    public FloatProperty rotationWeight
    Field Value
    Type Description
    FloatProperty

    source

    The Transform handle for the override source object Transform.

    Declaration
    public ReadOnlyTransformHandle source
    Field Value
    Type Description
    ReadOnlyTransformHandle

    sourceInvLocalBindTx

    Cached inverse local TR used in space switching calculations.

    Declaration
    public AffineTransform sourceInvLocalBindTx
    Field Value
    Type Description
    AffineTransform

    sourceToCurrSpaceRotIdx

    CacheIndex to source to space quaternion used in current space.

    Declaration
    public CacheIndex sourceToCurrSpaceRotIdx
    Field Value
    Type Description
    CacheIndex
    See Also
    AnimationJobCache

    sourceToLocalRot

    Cached source to local coordinates quaternion. Used when Space is set to Local.

    Declaration
    public Quaternion sourceToLocalRot
    Field Value
    Type Description
    Quaternion

    sourceToPivotRot

    Cached source to pivot coordinates quaternion. Used when Space is set to Pivot.

    Declaration
    public Quaternion sourceToPivotRot
    Field Value
    Type Description
    Quaternion

    sourceToWorldRot

    Cached source to world coordinates quaternion. Used when Space is set to World.

    Declaration
    public Quaternion sourceToWorldRot
    Field Value
    Type Description
    Quaternion

    spaceIdx

    CacheIndex to the override space.

    Declaration
    public CacheIndex spaceIdx
    Field Value
    Type Description
    CacheIndex
    See Also
    AnimationJobCache

    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