Class MouseMoveFSM

The FSM for mouseover interactions

Hierarchy

  • FSMImpl<MouseMoveFSMHandler>
    • MouseMoveFSM

Constructors

constructor

Properties

_currentState _dataHandler _log _started _states currentStatePublisher currentSubFSM currentTimeout eventsToProcess handlers initState inner logger startingState

Accessors

currentState currentStateObservable dataHandler log started states

Methods

acceptVisitor addCancellingState addHandler addRemaningEventsToProcess addStdState addTerminalState checkTimeoutTransition enterStdState fullReinit getEventsToProcess notifyHandlerOnCancel notifyHandlerOnError notifyHandlerOnStart notifyHandlerOnStop notifyHandlerOnUpdate onCancelling onError onStarting onTerminating onTimeout onUpdating process processRemainingEvents reinit removeHandler stopCurrentTimeout uninstall

Constructors

constructor

Properties

Protected _currentState

_currentState: OutputState

Protected _dataHandler

_dataHandler: undefined | MouseMoveFSMHandler

_log

_log: boolean

Protected _started

_started: boolean

Goes with 'startingState'. It permits to know whether the FSM has started, ie whether the 'starting state' has been reached.

Protected Readonly _states

_states: State[]

The states that compose the finite state machine.

Protected Readonly currentStatePublisher

currentStatePublisher: Subject<[OutputState, OutputState]>

currentSubFSM

currentSubFSM: undefined | FSM

The current sub FSM in which this FSM is while running.

Protected currentTimeout

currentTimeout: undefined | TimeoutTransition

The current timeout in progress.

Protected Readonly eventsToProcess

eventsToProcess: Event[]

The events still in process. For example when the user press key ctrl and scroll one time using the wheel of the mouse, the interaction scrolling is finished but the event keyPressed 'ctrl' is still in process. At the end of the interaction, these events are re-introduced into the state machine of the interaction for processing.

Protected Readonly handlers

handlers: FSMHandler[]

The handlers to be notified on FSM state changes.

Readonly initState

initState: InitState

The initial state of the FSM

inner

inner: boolean

Defines whether the FSM is an inner FSM (ie, whether it is included into another FSM as a sub-FSM transition).

Protected Readonly logger

logger: Logger

startingState

startingState: State

By default an FSM triggers its 'start' event when it leaves its initial state. In some cases, this is not the case. For example, a double-click interaction is an FSM that must trigger its start event when the FSM reaches... its terminal state. Similarly, a DnD must trigger its start event on the first move, not on the first press. The goal of this attribute is to identify the state of the FSM that must trigger the start event. By default, this attribute is set with the initial state of the FSM.

Accessors

currentState

currentStateObservable

dataHandler

  • get dataHandler(): undefined | T

  • Returns undefined | T

  • set dataHandler(dataHandler): void

  • Parameters

    • dataHandler: undefined | T

    Returns void

log

  • get log(): boolean

  • Logs (or not) information about the execution of the FSM.

    Returns boolean

  • set log(log): void

  • Logs (or not) information about the execution of the FSM.

    Parameters

    • log: boolean

    Returns void

started

  • get started(): boolean

  • True: The FSM started.

    Returns boolean

states

  • get states(): readonly State[]

  • The set of the states that compose the FSM. This returns a copy of the real set.

    Returns readonly State[]

Methods

acceptVisitor

addCancellingState

addHandler

addRemaningEventsToProcess

addStdState

  • addStdState(name, startingState?): StdState

  • Adds a standard state to the state machine.

    Parameters

    • name: string

      The name of the state to add.

    • startingState: boolean = false

      States whether the new state is the one that starts the FSM.

    Returns StdState

    The created state.

addTerminalState

Protected checkTimeoutTransition

enterStdState

fullReinit

  • fullReinit(): void

  • Reinitialises the FSM. Compared to [[FSM#reinit]] this method flushes the remaining events to process.

    Returns void

getEventsToProcess

Protected notifyHandlerOnCancel

Protected notifyHandlerOnError

Protected notifyHandlerOnStart

notifyHandlerOnStop

Protected notifyHandlerOnUpdate

onCancelling

onError

onStarting

onTerminating

onTimeout

  • onTimeout(): void

  • Jobs to do when a timeout transition is executed. Because the timeout transition is based on a separated thread, the job done by this method must be executed in the UI thread. UI Platforms must override this method to do that.

    Returns void

onUpdating

process

  • process(event): boolean

  • Processes the provided event to run the FSM.

    Parameters

    • event: Event

      The event to process.

    Returns boolean

    True: the FSM correctly processed the event.

Protected processRemainingEvents

reinit

  • reinit(): void

  • Reinitialises the FSM. Remaining events to process are however not clear. See [[FSM#fullReinit]] for that.

    Returns void

removeHandler

stopCurrentTimeout

uninstall

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc