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

    Struct OverrideTransformData

    The OverrideTransform constraint data.

    Namespace: UnityEngine.Animations.Rigging
    Syntax
    [Serializable]
    public struct OverrideTransformData : IAnimationJobData, IOverrideTransformData

    Properties

    constrainedObject

    The Transform affected by the constraint source Transform.

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

    position

    The override position. This is taken into account only if sourceObject is null.

    Declaration
    public Vector3 position { get; set; }
    Property Value
    Type Description
    Vector3

    positionWeight

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

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

    rotation

    The override rotation. This is taken into account only if sourceObject is null.

    Declaration
    public Vector3 rotation { get; set; }
    Property Value
    Type Description
    Vector3

    rotationWeight

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

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

    sourceObject

    The override source Transform.

    Declaration
    public Transform sourceObject { get; set; }
    Property Value
    Type Description
    Transform
    Implements
    IOverrideTransformData.sourceObject

    space

    The override space.

    Declaration
    public OverrideTransformData.Space space { get; set; }
    Property Value
    Type Description
    OverrideTransformData.Space

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

    IOverrideTransformData.positionVector3Property

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

    Declaration
    string IOverrideTransformData.positionVector3Property { get; }
    Returns
    Type Description
    String
    Implements
    IOverrideTransformData.positionVector3Property

    IOverrideTransformData.positionWeightFloatProperty

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

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

    IOverrideTransformData.rotationVector3Property

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

    Declaration
    string IOverrideTransformData.rotationVector3Property { get; }
    Returns
    Type Description
    String
    Implements
    IOverrideTransformData.rotationVector3Property

    IOverrideTransformData.rotationWeightFloatProperty

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

    Declaration
    string IOverrideTransformData.rotationWeightFloatProperty { get; }
    Returns
    Type Description
    String
    Implements
    IOverrideTransformData.rotationWeightFloatProperty

    IOverrideTransformData.space

    The override space.

    Declaration
    int IOverrideTransformData.space { get; }
    Returns
    Type Description
    Int32
    Implements
    IOverrideTransformData.space
    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