Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Gui

GUI。

Hierarchy

  • Gui

Index

Constructors

constructor

  • new Gui(scene: Scene, root: E, font: Font, memory: Memory): Gui
  • コンストラクタ。

    Parameters

    • scene: Scene

      シーン。

    • root: E

      ウインドウを接続する E 。画面の原点(左上隅)に配置する。

    • font: Font

      ウィジェットの利用するフォント。

    • memory: Memory

      ウィジェットの状態を保存するメモリ。

    Returns Gui

Properties

aliveWidgets

aliveWidgets: WidgetE[]

Private coverE

coverE: E

font

font: Font

GUIで使用されるフォント。

読み取り専用。

Private idStack

idStack: string[]

memory

memory: Memory

ウィジェットの状態を保持するためのメモリ。

Private modalWindowManager

modalWindowManager: WindowManager

Private placerStack

placerStack: Placer[]

Private root

root: E

scene

scene: Scene

GUIを描画するシーン。

読み取り専用。

Private widgetStack

widgetStack: WidgetE[]

Private windowManager

windowManager: WindowManager

Accessors

currentPlacer

  • get currentPlacer(): Placer | null
  • 現在のプレイサー。

    ウィジェットの追加はこのプレイサーと交渉して位置と場所を決める。

    Returns Placer | null

currentWidget

  • get currentWidget(): WidgetE | null
  • 現在のウィジェット。

    ウィジェットの追加はこのウィジェットに対して行う。

    Returns WidgetE | null

Methods

add

  • add(factory: (ui: Gui) => boolean): boolean
  • ファクトリでウィジェットを生成し配置する。

    Parameters

    • factory: (ui: Gui) => boolean

      ウィジェット生成するファクトリ。

        • (ui: Gui): boolean
        • Parameters

          Returns boolean

    Returns boolean

    ウィジェットが操作された時、真。

attach

  • 現在の親ウィジェットにウィジェットを配置する。

    Parameters

    • widgetE: WidgetE

      ウィジェット。

    Returns void

button

  • button(title: string): boolean
  • ボタンを配置する。

    Parameters

    • title: string

      のタイトル。

    Returns boolean

    ボタンが押下された時、真。

checkbox

  • チェックボックスを配置する。

    Type parameters

    • T

    Parameters

    • title: string

      チェックボックスのタイトル。

    • valueObject: T

      チェックボックスのオン・オフの真偽値を持つオブジェクト。

    • key: ExtractPropertyNames<T, boolean>

      チェックボックスのオン・オフの真偽値のプロパティ名。

    Returns boolean

    チェックボックスが押下された時、真。

collapsing

  • collapsing(title: string, addContents: (ui: Gui) => void): boolean
  • 折りたたみを配置する。

    Parameters

    • title: string

      折りたたみのタイトル。

    • addContents: (ui: Gui) => void

      折りたたみにウィジェットを配置する関数。

        • (ui: Gui): void
        • Parameters

          Returns void

    Returns boolean

    折りたたみを開閉した時、真。

findWidgetByGwidAndType

  • findWidgetByGwidAndType<T>(gwid: string, ctor: Constructor<T>): T | null
  • グローバルウィジェットIDとウィジェットの型に一致するウィジェットを返す。

    Type parameters

    Parameters

    • gwid: string

      グローバルウィジェット ID 。

    • ctor: Constructor<T>

      ウィジェットのコンストラクタ。

    Returns T | null

    ウィジェット。見つからなかった時 null 。

getWidget

  • getWidget(title: string): WidgetE | null
  • ウィジェットの取得。

    Parameters

    • title: string

      ウィジェットのタイトル。

    Returns WidgetE | null

    ウィジェット。

horizontal

  • horizontal(title: string, addContents: (ui: Gui) => void): void
  • 水平配置を開始する。

    Parameters

    • title: string

      水平配置のタイトル

    • addContents: (ui: Gui) => void

      水平に配置されるウィジェットを配置する関数。

        • (ui: Gui): void
        • Parameters

          Returns void

    Returns void

label

  • label(title: string): void
  • ラベルを配置する。

    Parameters

    • title: string

      タイトル。

    Returns void

margin

  • margin(title: string): void
  • マージンを配置する。

    何も描画しないウィジェットを配置します。

    Parameters

    • title: string

      マージンのタイトル。

    Returns void

modalWindow

  • モーダルウインドウを準備する。

    Parameters

    • title: string

      モーダルウインドウのタイトル。

    Returns WindowCreator

    ウインドウクリエータ。これに対して show() を呼ぶことでウインドウが表示される。

popPlacer

  • popPlacer(): Placer | undefined
  • プレイサーをスタックからポップする。

    Returns Placer | undefined

    ポップされたプレイサー。

popWid

  • popWid(): void
  • ウィジェット ID をスタックからポップする。

    Returns void

popWidget

  • ウィジェットをスタックからポップする。

    Returns WidgetE | undefined

    ポップされたウィジェット。

postRun

  • postRun(): void
  • run() 実行後に実行するメソッド。

    Returns void

preRun

  • preRun(): void
  • run() 実行前に実行するメソッド。

    Returns void

pushPlacer

  • pushPlacer(placer: Placer): void
  • プレイサーをスタックにプッシュする。

    Parameters

    • placer: Placer

      プレイサー。

    Returns void

pushWid

  • pushWid(wid: number | string): void
  • ウィジェット ID をスタックにプッシュする。

    通常、ウィジェットのタイトルをウィジェット ID に用いる。

    Parameters

    • wid: number | string

      ウィジェット ID 。

    Returns void

pushWidget

  • pushWidget(widgetE: WidgetE): void
  • ウィジェットをスタックにプッシュする。

    プッシュされたウィジェットは、以降アタッチされるウィジェットの親になる。

    Parameters

    • widgetE: WidgetE

      プッシュされるウィジェット。

    Returns void

radioButton

  • radioButton<T, U>(title: string, valueObject: T, key: ExtractPropertyNames<T, U>, buttonValue: U): boolean
  • ラジオボタンを配置する。

    Type parameters

    • T

    • U

    Parameters

    • title: string

      ラジオボタンのタイトル。

    • valueObject: T

      ラジオボタンのオン・オフの真偽値を持つオブジェクト。

    • key: ExtractPropertyNames<T, U>

      ラジオボタンのオン・オフの真偽値のプロパティ名。

    • buttonValue: U

    Returns boolean

    ラジオボタンが押下された時、真。

Private setupLayer

  • setupLayer(): void

slider

  • slider<T>(title: string, valueObject: T, key: ExtractPropertyNames<T, number>, min: number, max: number): boolean
  • スライダーを配置する。

    Type parameters

    • T

    Parameters

    • title: string
    • valueObject: T

      スライダーの値を持つオブジェクト。

    • key: ExtractPropertyNames<T, number>

      スライダーのオン・オフの値のプロパティ名。

    • min: number

      最小値。

    • max: number

      最大値。

    Returns boolean

    スライダーによって値が変更された時、真。

textBox

  • textBox(title: string, height: number, text: string): void
  • テキストボックスを配置する。

    Parameters

    • title: string

      テキストボックスのタイトル。

    • height: number

      高さ。

    • text: string

      テキストボックスに表示する文字列。

    Returns void

titleToGwid

  • titleToGwid(title: string): string
  • ウィジェットタイトル(ID)からグローバルウィジェット ID を得る。

    Parameters

    • title: string

      ウィジェットのタイトル。

    Returns string

    グローバルウィジェット ID 。

window

  • ウインドウを準備する。

    Parameters

    • title: string

      ウインドウのタイトル。

    Returns WindowCreator

    ウインドウクリエータ。これに対して show() を呼ぶことでウインドウが表示される。

Generated using TypeDoc