docs.unity3d.com
Search Results for

    Show / Hide Table of Contents

    Struct MultiAimConstraintJob

    The MultiAim constraint job.

    Implements
    IWeightedAnimationJob
    IAnimationJob
    Inherited Members
    ValueType.Equals(object)
    ValueType.GetHashCode()
    ValueType.ToString()
    object.Equals(object, object)
    object.GetType()
    object.ReferenceEquals(object, object)
    Namespace: UnityEngine.Animations.Rigging
    Assembly: Unity.Animation.Rigging.dll
    Syntax
    [BurstCompile]
    public struct MultiAimConstraintJob : IWeightedAnimationJob, IAnimationJob

    Fields

    aimAxis

    Local aim axis of the constrained object Transform.

    Declaration
    public Vector3 aimAxis
    Field Value
    Type Description
    Vector3

    axesMask

    Axes mask. Rotation will apply on the local axis for a value of 1.0, and will be kept as is for a value of 0.0.

    Declaration
    public Vector3 axesMask
    Field Value
    Type Description
    Vector3

    driven

    The Transform handle for the constrained object Transform.

    Declaration
    public ReadWriteTransformHandle driven
    Field Value
    Type Description
    ReadWriteTransformHandle

    drivenOffset

    The post-rotation offset applied to the constrained object.

    Declaration
    public Vector3Property drivenOffset
    Field Value
    Type Description
    Vector3Property

    drivenParent

    The Transform handle for the constrained object parent Transform.

    Declaration
    public ReadOnlyTransformHandle drivenParent
    Field Value
    Type Description
    ReadOnlyTransformHandle

    maxLimit

    Maximum rotation value.

    Declaration
    public FloatProperty maxLimit
    Field Value
    Type Description
    FloatProperty

    minLimit

    Minimum rotation value.

    Declaration
    public FloatProperty minLimit
    Field Value
    Type Description
    FloatProperty

    sourceOffsets

    List of offsets to apply to source rotations if maintainOffset is enabled.

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

    sourceTransforms

    List of Transform handles for the source objects.

    Declaration
    public NativeArray<ReadOnlyTransformHandle> sourceTransforms
    Field Value
    Type Description
    NativeArray<ReadOnlyTransformHandle>

    sourceWeights

    List of weights for the source objects.

    Declaration
    public NativeArray<PropertyStreamHandle> sourceWeights
    Field Value
    Type Description
    NativeArray<PropertyStreamHandle>

    upAxis

    Local up axis of the constrained object Transform.

    Declaration
    public Vector3 upAxis
    Field Value
    Type Description
    Vector3

    weightBuffer

    Buffer used to store weights during job execution.

    Declaration
    public NativeArray<float> weightBuffer
    Field Value
    Type Description
    NativeArray<float>

    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
    public Vector3 worldUpAxis
    Field Value
    Type Description
    Vector3

    worldUpObject

    The Transform handle for the world up object. This is used when World Up Type is set to WorldUpType.ObjectUp or WorldUpType.ObjectRotationUp.

    Declaration
    public ReadOnlyTransformHandle worldUpObject
    Field Value
    Type Description
    ReadOnlyTransformHandle

    worldUpType

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

    Declaration
    public MultiAimConstraintJob.WorldUpType worldUpType
    Field Value
    Type Description
    MultiAimConstraintJob.WorldUpType

    Properties

    jobWeight

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

    Declaration
    public FloatProperty jobWeight { readonly get; set; }
    Property Value
    Type Description
    FloatProperty

    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.

    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

    IWeightedAnimationJob
    IAnimationJob
    In This Article
    Back to top
    Copyright © 2025 Unity Technologies — Trademarks and terms of use
    • Legal
    • Privacy Policy
    • Cookie Policy
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)