Class ModalRoute | UIWidgets | 1.5.4-preview.12
docs.unity3d.com
    Show / Hide Table of Contents

    Class ModalRoute

    Inheritance
    Object
    Route
    OverlayRoute
    TransitionRoute
    LocalHistoryRouteTransitionRoute
    ModalRoute
    PageRoute
    PopupRoute
    Inherited Members
    LocalHistoryRouteTransitionRoute.addLocalHistoryEntry(LocalHistoryEntry)
    LocalHistoryRouteTransitionRoute.removeLocalHistoryEntry(LocalHistoryEntry)
    LocalHistoryRouteTransitionRoute.didPop(Object)
    LocalHistoryRouteTransitionRoute.willHandlePopInternally
    LocalHistoryRouteTransitionRoute.route
    TransitionRoute.completed
    TransitionRoute.transitionDuration
    TransitionRoute.opaque
    TransitionRoute.finishedWhenPopped
    TransitionRoute.controller
    TransitionRoute.createAnimationController()
    TransitionRoute.createAnimation()
    TransitionRoute.didReplace(Route)
    TransitionRoute.didPopNext(Route)
    TransitionRoute.didChangeNext(Route)
    TransitionRoute.canTransitionTo(TransitionRoute)
    TransitionRoute.canTransitionFrom(TransitionRoute)
    TransitionRoute.debugLabel
    OverlayRoute.overlayEntries
    Route.navigator
    Route.settings
    Route.currentResult
    Route.popped
    Route.didComplete(Object)
    Route.isCurrent
    Route.isFirst
    Route.isActive
    Namespace: Unity.UIWidgets.widgets
    Syntax
    public abstract class ModalRoute : LocalHistoryRouteTransitionRoute, LocalHistoryRoute

    Constructors

    ModalRoute()

    Declaration
    protected ModalRoute()

    ModalRoute(RouteSettings)

    Declaration
    protected ModalRoute(RouteSettings settings)
    Parameters
    Type Name Description
    RouteSettings settings

    Fields

    _kTransparent

    Declaration
    public static Color _kTransparent
    Field Value
    Type Description
    Color

    focusScopeNode

    Declaration
    public readonly FocusScopeNode focusScopeNode
    Field Value
    Type Description
    FocusScopeNode

    Properties

    animation

    Declaration
    public override Animation<float> animation { get; }
    Property Value
    Type Description
    Animation<Single>
    Overrides
    TransitionRoute.animation

    barrierColor

    Declaration
    public virtual Color barrierColor { get; }
    Property Value
    Type Description
    Color

    barrierDismissible

    Declaration
    public virtual bool barrierDismissible { get; }
    Property Value
    Type Description
    Boolean

    canPop

    Declaration
    public bool canPop { get; }
    Property Value
    Type Description
    Boolean

    hasScopedWillPopCallback

    Declaration
    public bool hasScopedWillPopCallback { get; }
    Property Value
    Type Description
    Boolean

    maintainState

    Declaration
    public virtual bool maintainState { get; }
    Property Value
    Type Description
    Boolean

    offstage

    Declaration
    public bool offstage { get; set; }
    Property Value
    Type Description
    Boolean

    secondaryAnimation

    Declaration
    public override Animation<float> secondaryAnimation { get; }
    Property Value
    Type Description
    Animation<Single>
    Overrides
    TransitionRoute.secondaryAnimation

    subtreeContext

    Declaration
    public BuildContext subtreeContext { get; }
    Property Value
    Type Description
    BuildContext

    Methods

    addScopedWillPopCallback(WillPopCallback)

    Declaration
    public void addScopedWillPopCallback(WillPopCallback callback)
    Parameters
    Type Name Description
    WillPopCallback callback

    buildPage(BuildContext, Animation<Single>, Animation<Single>)

    Declaration
    public abstract Widget buildPage(BuildContext context, Animation<float> animation, Animation<float> secondaryAnimation)
    Parameters
    Type Name Description
    BuildContext context
    Animation<Single> animation
    Animation<Single> secondaryAnimation
    Returns
    Type Description
    Widget

    buildTransitions(BuildContext, Animation<Single>, Animation<Single>, Widget)

    Declaration
    public virtual Widget buildTransitions(BuildContext context, Animation<float> animation, Animation<float> secondaryAnimation, Widget child)
    Parameters
    Type Name Description
    BuildContext context
    Animation<Single> animation
    Animation<Single> secondaryAnimation
    Widget child
    Returns
    Type Description
    Widget

    changedExternalState()

    Declaration
    protected override void changedExternalState()
    Overrides
    Route.changedExternalState()

    changedInternalState()

    Declaration
    protected override void changedInternalState()
    Overrides
    Route.changedInternalState()

    createOverlayEntries()

    Declaration
    public override ICollection<OverlayEntry> createOverlayEntries()
    Returns
    Type Description
    ICollection<OverlayEntry>
    Overrides
    OverlayRoute.createOverlayEntries()

    didChangePrevious(Route)

    Declaration
    protected override void didChangePrevious(Route previousRoute)
    Parameters
    Type Name Description
    Route previousRoute
    Overrides
    Route.didChangePrevious(Route)

    didPush()

    Declaration
    protected override TickerFuture didPush()
    Returns
    Type Description
    TickerFuture
    Overrides
    TransitionRoute.didPush()

    dispose()

    Declaration
    protected override void dispose()
    Overrides
    TransitionRoute.dispose()

    install(OverlayEntry)

    Declaration
    protected override void install(OverlayEntry insertionPoint)
    Parameters
    Type Name Description
    OverlayEntry insertionPoint
    Overrides
    TransitionRoute.install(OverlayEntry)

    of(BuildContext)

    Declaration
    public static ModalRoute of(BuildContext context)
    Parameters
    Type Name Description
    BuildContext context
    Returns
    Type Description
    ModalRoute

    removeScopedWillPopCallback(WillPopCallback)

    Declaration
    public void removeScopedWillPopCallback(WillPopCallback callback)
    Parameters
    Type Name Description
    WillPopCallback callback

    setState(VoidCallback)

    Declaration
    protected virtual void setState(VoidCallback fn)
    Parameters
    Type Name Description
    VoidCallback fn

    ToString()

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

    willPop()

    Declaration
    public override IPromise<RoutePopDisposition> willPop()
    Returns
    Type Description
    IPromise<RoutePopDisposition>
    Overrides
    LocalHistoryRouteTransitionRoute.willPop()

    withName(String)

    Declaration
    public RoutePredicate withName(string name)
    Parameters
    Type Name Description
    String name
    Returns
    Type Description
    RoutePredicate
    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