Class ViewportOffset | Package Manager UI website
docs.unity3d.com
    Show / Hide Table of Contents

    Class ViewportOffset

    Inheritance
    System.Object
    ChangeNotifier
    ViewportOffset
    ScrollPosition
    Inherited Members
    ChangeNotifier.hasListeners
    ChangeNotifier.addListener(VoidCallback)
    ChangeNotifier.removeListener(VoidCallback)
    ChangeNotifier.dispose()
    ChangeNotifier.notifyListeners()
    Namespace: Unity.UIWidgets.rendering
    Syntax
    public abstract class ViewportOffset : ChangeNotifier, Listenable

    Constructors

    ViewportOffset()

    Declaration
    protected ViewportOffset()

    Properties

    allowImplicitScrolling

    Declaration
    public abstract bool allowImplicitScrolling { get; }
    Property Value
    Type Description
    System.Boolean

    pixels

    Declaration
    public abstract float pixels { get; }
    Property Value
    Type Description
    System.Single

    userScrollDirection

    Declaration
    public abstract ScrollDirection userScrollDirection { get; }
    Property Value
    Type Description
    ScrollDirection

    Methods

    animateTo(Single, TimeSpan, Curve)

    Declaration
    public abstract IPromise animateTo(float to, TimeSpan duration, Curve curve)
    Parameters
    Type Name Description
    System.Single to
    System.TimeSpan duration
    Curve curve
    Returns
    Type Description
    IPromise

    applyContentDimensions(Single, Single)

    Declaration
    public abstract bool applyContentDimensions(float minScrollExtent, float maxScrollExtent)
    Parameters
    Type Name Description
    System.Single minScrollExtent
    System.Single maxScrollExtent
    Returns
    Type Description
    System.Boolean

    applyViewportDimension(Single)

    Declaration
    public abstract bool applyViewportDimension(float viewportDimension)
    Parameters
    Type Name Description
    System.Single viewportDimension
    Returns
    Type Description
    System.Boolean

    correctBy(Single)

    Declaration
    public abstract void correctBy(float correction)
    Parameters
    Type Name Description
    System.Single correction

    debugFillDescription(List<String>)

    Declaration
    protected virtual void debugFillDescription(List<string> description)
    Parameters
    Type Name Description
    System.Collections.Generic.List<System.String> description

    fixed(Single)

    Declaration
    public static ViewportOffset fixed(float value)
    Parameters
    Type Name Description
    System.Single value
    Returns
    Type Description
    ViewportOffset

    jumpTo(Single)

    Declaration
    public abstract void jumpTo(float pixels)
    Parameters
    Type Name Description
    System.Single pixels

    moveTo(Single, Nullable<TimeSpan>, Curve, Boolean)

    Declaration
    public virtual IPromise moveTo(float to, TimeSpan? duration, Curve curve = null, bool clamp = true)
    Parameters
    Type Name Description
    System.Single to
    System.Nullable<System.TimeSpan> duration
    Curve curve
    System.Boolean clamp
    Returns
    Type Description
    IPromise

    ToString()

    Declaration
    public override string ToString()
    Returns
    Type Description
    System.String
    Overrides
    System.Object.ToString()

    zero()

    Declaration
    public static ViewportOffset zero()
    Returns
    Type Description
    ViewportOffset
    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