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

    Struct DampedTransformData

    The DampedTransform constraint data.

    Namespace: UnityEngine.Animations.Rigging
    Syntax
    [Serializable]
    public struct DampedTransformData : IAnimationJobData, IDampedTransformData

    Properties

    constrainedObject

    The Transform affected by the constraint Source Transform.

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

    dampPosition

    Damp position weight. Defines how much of constrained object position follows source object position. Constrained position will closely follow source object when set to 0, and will not move when set to 1.

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

    dampRotation

    Damp rotation weight. Defines how much of constrained object rotation follows source object rotation. Constrained rotation will closely follow source object when set to 0, and will not move when set to 1.

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

    maintainAim

    Toggles whether damping will enforces aim.

    Declaration
    public bool maintainAim { get; set; }
    Property Value
    Type Description
    Boolean
    Implements
    IDampedTransformData.maintainAim

    sourceObject

    The source Transform.

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

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

    IDampedTransformData.dampPositionFloatProperty

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

    Declaration
    string IDampedTransformData.dampPositionFloatProperty { get; }
    Returns
    Type Description
    String
    Implements
    IDampedTransformData.dampPositionFloatProperty

    IDampedTransformData.dampRotationFloatProperty

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

    Declaration
    string IDampedTransformData.dampRotationFloatProperty { get; }
    Returns
    Type Description
    String
    Implements
    IDampedTransformData.dampRotationFloatProperty
    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