Class TimelineClipExtensions | DOTS Timeline | 0.4.0-preview.5
docs.unity3d.com
    Show / Hide Table of Contents

    Class TimelineClipExtensions

    Inheritance
    Object
    TimelineClipExtensions
    Namespace: Unity.Timeline.Hybrid
    Syntax
    public static class TimelineClipExtensions

    Methods

    BuildClipWeightCurve(TimelineClip)

    Declaration
    public static BlobAssetReference<AnimationCurveBlob> BuildClipWeightCurve(this TimelineClip clip)
    Parameters
    Type Name Description
    TimelineClip clip
    Returns
    Type Description
    BlobAssetReference<AnimationCurveBlob>

    GetActiveRange(TimelineClip)

    Returns the start and end range for a TimelineClip as an ActiveRange

    Declaration
    public static ActiveRange GetActiveRange(this TimelineClip clip)
    Parameters
    Type Name Description
    TimelineClip clip
    Returns
    Type Description
    ActiveRange

    GetEffectiveRange(TimelineClip)

    Returns the extrapolated range of the timeline clip, clamped to the length of the timeline

    Declaration
    public static double2 GetEffectiveRange(this TimelineClip clip)
    Parameters
    Type Name Description
    TimelineClip clip
    Returns
    Type Description
    double2

    GetMixCurveHash(TimelineClip)

    Declaration
    public static Entities.Hash128 GetMixCurveHash(this TimelineClip clip)
    Parameters
    Type Name Description
    TimelineClip clip
    Returns
    Type Description
    Unity.Entities.Hash128

    GetSubTimelineRange(TimelineClip)

    Returns the active range of the subtimeline of this clip

    Declaration
    public static ActiveRange GetSubTimelineRange(this TimelineClip clip)
    Parameters
    Type Name Description
    TimelineClip clip
    Returns
    Type Description
    ActiveRange

    GetTimeTransform(TimelineClip)

    Gets the parent to local time transform for a TimelineClip

    Declaration
    public static TimeTransform GetTimeTransform(this TimelineClip clip)
    Parameters
    Type Name Description
    TimelineClip clip
    Returns
    Type Description
    TimeTransform

    InRangeInclLoops(TimelineClip, ActiveRange)

    Checks if a timeline clip is within range, including loops of the timeline asset.

    Declaration
    public static bool InRangeInclLoops(this TimelineClip clip, ActiveRange activeRange)
    Parameters
    Type Name Description
    TimelineClip clip

    The TimelineClip including Loops

    ActiveRange activeRange

    The active range to check. If this is larger than the timelines range, it is checked for loops

    Returns
    Type Description
    Boolean

    InRangeInclLoops(ActiveRange, ActiveRange, ActiveRange)

    Checks if a timeline clip is within range, including loops of the timeline asset.

    Declaration
    public static bool InRangeInclLoops(ActiveRange clipRange, ActiveRange activeRange, ActiveRange timelineRange)
    Parameters
    Type Name Description
    ActiveRange clipRange

    The range of the TimelineClip including Loops

    ActiveRange activeRange

    The active range to check. If this is larger than the timelines range, it is checked for loops

    ActiveRange timelineRange
    Returns
    Type Description
    Boolean
    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