Search Results for

    Show / Hide Table of Contents

    Class ScreenContextManager

    Service to manage transitions between ScreenContext instances.

    Inheritance
    object
    IdentifiableObject
    DependencyObject
    AttachableObject
    Service
    ScreenContextManager
    Implements
    IDependencyObject
    Inherited Members
    AttachableObject.AttachableStateChanged
    AttachableObject.IsEnabled
    AttachableObject.State
    AttachableObject.IsLoaded
    AttachableObject.IsAttached
    AttachableObject.IsActivated
    AttachableObject.IsStarted
    AttachableObject.IsDestroyed
    AttachableObject.Destroy()
    DependencyObject.Dependencies
    DependencyObject.OnDependencyRemoved
    IdentifiableObject.Id
    Namespace: Evergine.Framework.Services
    Assembly: Evergine.Framework.dll
    Syntax
    public sealed class ScreenContextManager : Service, IDependencyObject

    Constructors

    ScreenContextManager()

    Initializes a new instance of the ScreenContextManager class.

    Declaration
    public ScreenContextManager()
    Exceptions
    Type Condition
    ArgumentNullException

    Thrown when the graphics device is null.

    ArgumentNullException

    Thrown if the graphics device is null.

    Properties

    CurrentContext

    Gets the current context.

    Declaration
    public ScreenContext CurrentContext { get; }
    Property Value
    Type Description
    ScreenContext

    The current context.

    Methods

    FindContextByName(string)

    Finds a context by name.

    Declaration
    public ScreenContext FindContextByName(string name)
    Parameters
    Type Name Description
    string name

    The name.

    Returns
    Type Description
    ScreenContext

    The screen context.

    OnDestroy()

    Destroys this instance.

    Declaration
    protected override void OnDestroy()
    Overrides
    Service.OnDestroy()

    OnLoaded()

    Invoked when the object is loaded.

    Declaration
    protected override void OnLoaded()
    Overrides
    Service.OnLoaded()

    Pop(bool)

    Pops this instance.

    Declaration
    public void Pop(bool doDispose = true)
    Parameters
    Type Name Description
    bool doDispose

    Specifies whether older scenes should be disposed. True by default.

    Push(ScreenContext)

    Pushes the specified next context.

    Declaration
    public void Push(ScreenContext nextContext)
    Parameters
    Type Name Description
    ScreenContext nextContext

    The next context.

    To(ScreenContext, bool)

    To the specified next context.

    Declaration
    public void To(ScreenContext nextContext, bool doDispose = true)
    Parameters
    Type Name Description
    ScreenContext nextContext

    The next context.

    bool doDispose

    True if older scenes should be disposed; true by default.

    Events

    OnActivatingScene

    Occurs when a new scene is activated.

    Declaration
    public event ScreenContextManager.SceneChanged OnActivatingScene
    Event Type
    Type Description
    ScreenContextManager.SceneChanged

    OnDesactivatingScene

    Occurs when a scene is deactivated.

    Declaration
    public event ScreenContextManager.SceneChanged OnDesactivatingScene
    Event Type
    Type Description
    ScreenContextManager.SceneChanged

    Implements

    IDependencyObject

    Extension Methods

    ReflectionHelper.GetMemberAssembly(object)
    ReflectionHelper.GetTypeName(object)
    In this article
    Back to top
    Generated by DocFX