Header menu logo Nu

ScreenDispatcher<'model, 'message, 'command> Type

The MMCC dispatcher for screens.

Constructors

Constructor Description

ScreenDispatcher(initial)

Full Usage: ScreenDispatcher(initial)

Parameters:
    initial : 'model

Returns: ScreenDispatcher<'model, 'message, 'command>
initial : 'model
Returns: ScreenDispatcher<'model, 'message, 'command>

ScreenDispatcher(makeInitial)

Full Usage: ScreenDispatcher(makeInitial)

Parameters:
    makeInitial : World -> 'model

Returns: ScreenDispatcher<'model, 'message, 'command>
makeInitial : World -> 'model
Returns: ScreenDispatcher<'model, 'message, 'command>

Instance members

Instance member Description

this.Command

Full Usage: this.Command

Parameters:
    model : 'model
    command : 'command
    screen : Screen
    world : World

Modifiers: abstract

The command handler of the MMCC programming model.

model : 'model
command : 'command
screen : Screen
world : World

this.Content

Full Usage: this.Content

Parameters:
    model : 'model
    screen : Screen

Returns: GroupContent list
Modifiers: abstract

The content specifier of the MMCC programming model.

model : 'model
screen : Screen
Returns: GroupContent list

this.Definitions

Full Usage: this.Definitions

Parameters:
    model : 'model
    screen : Screen

Returns: DefinitionContent<Screen> list
Modifiers: abstract

The screen's own MMCC definitions.

model : 'model
screen : Screen
Returns: DefinitionContent<Screen> list

this.Edit

Full Usage: this.Edit

Parameters:
Returns: Signal list * 'model
Modifiers: abstract

Implements additional editing behavior for a screen via the ImGui API.

model : 'model
op : EditOperation
screen : Screen
world : World
Returns: Signal list * 'model

this.GetFallbackModel

Full Usage: this.GetFallbackModel

Parameters:
Returns: 'model
Modifiers: abstract

The fallback model value.

modelSymbol : Symbol
screen : Screen
world : World
Returns: 'model

this.GetModel

Full Usage: this.GetModel

Parameters:
Returns: 'model

Get the screen's model.

screen : Screen
world : World
Returns: 'model

this.Message

Full Usage: this.Message

Parameters:
    model : 'model
    message : 'message
    screen : Screen
    world : World

Returns: Signal list * 'model
Modifiers: abstract

The message handler of the MMCC programming model.

model : 'model
message : 'message
screen : Screen
world : World
Returns: Signal list * 'model

this.Model

Full Usage: this.Model

Parameters:
Returns: Lens<'model, Screen>

The screen's model lens.

screen : Screen
Returns: Lens<'model, Screen>

this.Render

Full Usage: this.Render

Parameters:
Modifiers: abstract

Render the screen using the given model.

model : 'model
renderPass : RenderPass
screen : Screen
world : World

this.SetModel

Full Usage: this.SetModel

Parameters:

Set the screen's model.

model : 'model
screen : Screen
world : World

this.TruncateModel

Full Usage: this.TruncateModel

Parameters:
    model : 'model

Returns: 'model
Modifiers: abstract

Truncate the given model.

model : 'model
Returns: 'model

this.UntruncateModel

Full Usage: this.UntruncateModel

Parameters:
    current : 'model
    incoming : 'model

Returns: 'model
Modifiers: abstract

Untruncate the given model.

current : 'model
incoming : 'model
Returns: 'model

Type something to start searching.