Options
All
  • Public
  • Public/Protected
  • All
Menu

A Module that allows the controller to set up and add a module to the current view.

Hierarchy

Index

Constructors

constructor

Properties

index

index: number

The position this Module has as seen in a list of currently active modules.

Protected inputCallback

inputCallback: (s: ControllerInputType | PlayerInputType) => void = ...

This function is called whenever a user interacts with the module.

Type declaration

Private isActive

isActive: boolean

If true, the module has been clicked and shows input masks.

Protected model

A Module View always holds a Module Model that has all the informations and settings.

module

module: DummyModel

Empty Module that serves the purpose to fulfill the inheritance criteria given by the ModuleViewController abstract class.

Private newModule

newModule: ModuleModel

Holds Model information from the input masks.

Private newModuleView

newModuleView: undefined | ModuleViewController

Shows Model specific input masks.

Protected renderCallback

renderCallback: () => void = ...

This function is called when the model changes it's view has to be rerendered.

Type declaration

    • (): void
    • This function is called when the model changes it's view has to be rerendered.

      Returns void

Accessors

active

  • get active(): boolean
  • Check if the view was clicked and shows inputs.

    Returns boolean

midiDevices

  • set midiDevices(deviceList: string[]): void
  • Update the list of Midi output devices.

    Parameters

    • deviceList: string[]

    Returns void

Methods

Private addModule

  • addModule(): void
  • Send the new module to the server.

    Returns void

Private changedSettingsCallback

  • Dummy class that is not needed when a controller is in the process of adding a new module.

    Parameters

    Returns void

Private composeActiveStateView

  • composeActiveStateView(): TemplateResult<ResultType>
  • Composes the view that shows user input options.

    Returns TemplateResult<ResultType>

composeControllerSettingsView

  • composeControllerSettingsView(): TemplateResult<ResultType>
  • Composes the controller view parts that are specific to this model. Has to be implemented by the child class that inherits from this class.

    Returns TemplateResult<ResultType>

composeNameInput

  • composeNameInput(): TemplateResult<ResultType>
  • Composes an input field where the name of the module can be set.

    Returns TemplateResult<ResultType>

    A Template Result without an outer div.

composePlayerTypeSelection

  • composePlayerTypeSelection(): TemplateResult<ResultType>
  • Composes a dropdown select element that let's the controller choose for which type of players this model is visible.

    Returns TemplateResult<ResultType>

    A Template Result without an outer div.

composePlayerView

  • composePlayerView(): TemplateResult<ResultType>
  • Composes the player view parts that are specific to this model. Has to be implemented by the child class that inherits from this class.

    Returns TemplateResult<ResultType>

Private createSettingsView

  • createSettingsView(): void
  • Composes the settings view of a module, and prepares the model that later holds all user input info.

    Returns void

getControllerView

  • Composes the general controller view of every model, regardless of the specific model type.

    Parameters

    Returns TemplateResult<ResultType>

    The controller view as Template Result.

getPlayerView

  • Composes the general player view of every model, regardless of the specific model type.

    Parameters

    • playerRole: PlayerRoleFlag

      The Role of the player that loadsand looks at this module.

    Returns TemplateResult<ResultType>

    The player view as Template Result. Might be empty if the player roles don't match.

Private moduleSelectId

  • moduleSelectId(idx: number): string
  • Generate an Id from the index.

    Parameters

    • idx: number

    Returns string

Private reset

  • reset(): void
  • Reset the view to it's initial state.

    Returns void

Private swapState

  • swapState(): void
  • Flip the state and request a new render callback.

    Returns void

Generated using TypeDoc