Options
All
  • Public
  • Public/Protected
  • All
Menu

Button E。

Hierarchy

Implements

  • CommonArea
  • CommonArea

Index

Constructors

constructor

Properties

Private _hasTouchableChildren

_hasTouchableChildren: boolean

子にtouchableなものが含まれているかどうかを表す。

Private _matrix

_matrix: Matrix | undefined

変換行列のキャッシュ。 Object2D は状態に変更があった時、本値の_modifiedをtrueにする必要がある。 初期値は undefined であり、 getMatrix() によって必要な時に生成されるため、 if (this._matrix) this._matrix._modified = true という式で記述する必要がある。

エンジンに組み込まれているSprite等のエンティティ群は、 すでに本処理を組み込んでいるため通常ゲーム開発者はこの値を意識する必要はない。 Object2D を継承したクラスを新たに作る場合には、本フィールドを適切に操作しなければならない。

anchorX

anchorX: number | null

オブジェクトのアンカーの横位置。アンカーについては以下の通り。

  • アンカーとして設定した箇所がこのオブジェクトの基点 (位置、拡縮・回転の基点) となる。
  • 単位は相対値 (左上端が (0, 0) 中央が (0.5, 0,5) 右下端が (1,1) ) である。 初期値は 0 である。 ECamera2D においてこの値を変更した場合、 modified() を呼び出す必要がある。

NOTE: anchorX または anchorY のどちらを明示的に null に指定した場合、 このオブジェクトのアンカーは前バージョン(v2.x.x 以前)のデフォルトの挙動 (位置 x, y は左上端を基準に、拡大・縮小・回転の基点は中央を基準に決定) と同様になる。 これは前バージョンとの後方互換性のために存在する。

anchorY

anchorY: number | null

オブジェクトのアンカーの縦位置。アンカーについては以下の通り。

  • アンカーとして設定した箇所がこのオブジェクトの基点 (位置、拡縮・回転の基点) となる。
  • 単位は相対値 (左上端が (0, 0) 中央が (0.5, 0,5) 右下端が (1,1) ) である。 初期値は 0 である。 ECamera2D においてこの値を変更した場合、 modified() を呼び出す必要がある。

NOTE: anchorX または anchorY のどちらを明示的に null に指定した場合、 このオブジェクトのアンカーは前バージョン(v2.x.x 以前)のデフォルトの挙動 (位置 x, y は左上端を基準に、拡大・縮小・回転の基点は中央を基準に決定) と同様になる。 これは前バージョンとの後方互換性のために存在する。

angle

angle: number

オブジェクトの回転。度数 (時計回り) で指定する。 初期値は 0 である。 ECamera2D においてこの値を変更した場合、 modified() を呼び出す必要がある。

children

children: E[] | undefined

このエンティティの全子エンティティ。 子エンティティが存在しない場合、本フィールドの値は undefined または空配列である。

compositeOperation

compositeOperation: CompositeOperation | CompositeOperationString | undefined

描画時の合成方法を指定する。 初期値は undefined となり、合成方法を指定しないことを意味する。 E においてこの値を変更した場合、 modified() を呼び出す必要がある。

Protected Optional desiredHeight

desiredHeight: undefined | number

Protected Optional desiredWidth

desiredWidth: undefined | number

Private font

font: Font

gwid

gwid: string

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

グローバルウィジェットIDは Gui インスタンス内で一意の識別子である。

height

height: number

このオブジェクトの縦幅。 初期値は 0 である。実際の表示領域としてはscaleX, scaleY, angleの値も考慮する必要がある。 ECamera2D においてこの値を変更した場合、 modified() を呼び出す必要がある。

id

id: number

このエンティティに割り振られる Game 単位で一意のID。(ただし local が真である場合を除く)

isClicked

isClicked: boolean

local

local: boolean

このエンティティがローカルであるか否か。 コンストラクタで真が指定された時、または属するシーンがローカルシーンまたはローカルティック補間シーンである時、この値は真である。

この値が真である場合、このエンティティに対する point イベントはこのゲームインスタンスにのみ通知され、 他の参加者・視聴者には通知されない。また真である場合、 id の値の一意性は保証されない。

この値は参照のためにのみ公開されている。ゲーム開発者はこの値を直接変更してはならない。

Protected Optional minHeight

minHeight: undefined | number

Protected Optional minWidth

minWidth: undefined | number

opacity

opacity: number

0~1でオブジェクトの不透明度を表す。 初期値は 1 である。本値が0の場合、Rendererは描画処理を省略する。 E においてこの値を変更した場合、 modified() を呼び出す必要がある。

parent

parent: E | Scene | undefined

親。

Private pressed

pressed: boolean

scaleX

scaleX: number

オブジェクトの横方向の倍率。 初期値は 1 である。 ECamera2D においてこの値を変更した場合、 modified() を呼び出す必要がある。

scaleY

scaleY: number

オブジェクトの縦方向の倍率。 初期値は 1 である。 ECamera2D においてこの値を変更した場合、 modified() を呼び出す必要がある。

scene

scene: Scene

このエンティティが属するシーン。

shaderProgram

shaderProgram: ShaderProgram | null | undefined

このエンティティの描画時に利用されるシェーダプログラム。 isSupportedShaderProgram() が偽を返す g.Rendere で描画される時、 g.Renderer#setShaderProgram() は呼ばれないことに注意。

また g.FilledRect やその親エンティティに本値を指定した場合、対象の g.FilledRect の描画結果は不定である。 これは実装上の制限に基づく現バージョンの仕様である。

この値が undefined である場合、親のシェーダプログラムが利用される。 この値が null である場合、明示的にデフォルトのシェーダプログラムが利用される。

この値を変更した場合、 this.modified() を呼び出す必要がある。

state

state: EntityStateFlags

様々な状態を表すビットフラグ。

tag

tag: any

ゲーム開発者向けのタグ情報管理コンテナ。 この値はゲームエンジンのロジックからは使用されず、ゲーム開発者は任意の目的に使用してよい。

title

title: string

タイトル。

タイトルはボタンのラベルやウインドウのタイトルなどに用いられるとともに、 ウィジェットのID(WID)としても利用される。

width

width: number

このオブジェクトの横幅。 初期値は 0 である。実際の表示領域としてはscaleX, scaleY, angleの値も考慮する必要がある。 ECamera2D においてこの値を変更した場合、 modified() を呼び出す必要がある。

x

x: number

このオブジェクトの横位置。 初期値は 0 である。実際の座標位置はscaleX, scaleY, angle, anchorX, anchorYの値も考慮する必要がある。 ECamera2D においてこの値を変更した場合、 modified() を呼び出す必要がある。

y

y: number

このオブジェクトの縦位置。 初期値は 0 である。実際の座標位置はscaleX, scaleY, angle, anchorX, anchorYの値も考慮する必要がある。 ECamera2D においてこの値を変更した場合、 modified() を呼び出す必要がある。

Accessors

message

  • get message(): Trigger<MessageEvent>
  • このエンティティのmessageイベント。

    deprecated

    非推奨である。将来的に削除される。代わりに onMessage を利用すること。

    Returns Trigger<MessageEvent>

onMessage

  • get onMessage(): Trigger<MessageEvent>
  • このエンティティのmessageイベント。

    Returns Trigger<MessageEvent>

onPointDown

  • get onPointDown(): Trigger<PointDownEvent>
  • このエンティティのpoint downイベント。

    Returns Trigger<PointDownEvent>

onPointMove

  • get onPointMove(): Trigger<PointMoveEvent>
  • このエンティティのpoint moveイベント。

    Returns Trigger<PointMoveEvent>

onPointUp

  • get onPointUp(): Trigger<PointUpEvent>
  • このエンティティのpoint upイベント。

    Returns Trigger<PointUpEvent>

onUpdate

  • get onUpdate(): Trigger<void>
  • 時間経過イベント。本イベントの一度のfireにつき、常に1フレーム分の時間経過が起こる。

    Returns Trigger<void>

pointDown

  • get pointDown(): Trigger<PointDownEvent>
  • このエンティティのpoint downイベント。

    deprecated

    非推奨である。将来的に削除される。代わりに onPointDown を利用すること。

    Returns Trigger<PointDownEvent>

pointMove

  • get pointMove(): Trigger<PointMoveEvent>
  • このエンティティのpoint moveイベント。

    deprecated

    非推奨である。将来的に削除される。代わりに onPointMove を利用すること。

    Returns Trigger<PointMoveEvent>

pointUp

  • get pointUp(): Trigger<PointUpEvent>
  • このエンティティのpoint upイベント。

    deprecated

    非推奨である。将来的に削除される。代わりに onPointUp を利用すること。

    Returns Trigger<PointUpEvent>

touchable

  • get touchable(): boolean
  • set touchable(v: boolean): any
  • プレイヤーにとって触れられるオブジェクトであるかを表す。

    この値が偽である場合、ポインティングイベントの対象にならない。 初期値は false である。

    E の他のプロパティと異なり、この値の変更後に this.modified() を呼び出す必要はない。

    Returns boolean

  • プレイヤーにとって触れられるオブジェクトであるかを表す。

    この値が偽である場合、ポインティングイベントの対象にならない。 初期値は false である。

    E の他のプロパティと異なり、この値の変更後に this.modified() を呼び出す必要はない。

    Parameters

    • v: boolean

    Returns any

update

  • get update(): Trigger<void>
  • 時間経過イベント。本イベントの一度のfireにつき、常に1フレーム分の時間経過が起こる。

    deprecated

    非推奨である。将来的に削除される。代わりに onUpdate を利用すること。

    Returns Trigger<void>

Methods

Private _calculateBoundingRect

  • _calculateBoundingRect(m?: Matrix): CommonRect | undefined
  • Parameters

    • Optional m: Matrix

    Returns CommonRect | undefined

Private _calculateMatrixTo

  • _calculateMatrixTo(target?: E | Scene): Matrix
  • このエンティティの座標系を、指定された祖先エンティティ (またはシーン) の座標系に変換する行列を求める。

    指定されたエンティティが、このエンティティの祖先でない時、その値は無視される。 指定されたシーンが、このエンティティの属するシーン出ない時、その値は無視される。

    Parameters

    • Optional target: E | Scene

      座標系の変換先エンティティまたはシーン。省略した場合、このエンティティの属するシーン(グローバル座標系への変換行列になる)

    Returns Matrix

Private _disableTouchPropagation

  • _disableTouchPropagation(): void

Private _enableTouchPropagation

  • _enableTouchPropagation(): void

Private _findLowestCommonAncestorWith

  • _findLowestCommonAncestorWith(target: E): E | Scene | undefined
  • このエンティティと与えられたエンティティの共通祖先のうち、もっとも子孫側にあるものを探す。 共通祖先がない場合、 undefined を返す。

    Parameters

    • target: E

      このエンティティとの共通祖先を探すエンティティ

    Returns E | Scene | undefined

Private _isTargetOperation

  • _isTargetOperation(e: PointEvent): boolean
  • Parameters

    • e: PointEvent

    Returns boolean

Private _updateMatrix

  • _updateMatrix(): void
  • 公開のプロパティから内部の変換行列キャッシュを更新する。

    Returns void

anchor

  • anchor(x: number, y: number): void
  • オブジェクトのアンカーの位置を設定する。 このメソッドは anchorXanchorY を同時に設定するためのユーティリティメソッドである。 ECamera2D においてこのメソッドを呼び出した場合、 modified() を呼び出す必要がある。

    Parameters

    • x: number
    • y: number

    Returns void

append

  • append(e: E): void
  • 子を追加する。

    Parameters

    • e: E

      子エンティティとして追加するエンティティ

    Returns void

calculateBoundingRect

  • calculateBoundingRect(): CommonRect | undefined
  • このEの包含矩形を計算する。

    Returns CommonRect | undefined

destroy

  • destroy(): void
  • このエンティティを破棄する。

    親がある場合、親からは remove() される。 子孫を持っている場合、子孫も破棄される。

    Returns void

destroyed

  • destroyed(): boolean
  • このエンティティが破棄済みであるかを返す。

    Returns boolean

Protected drawAABB

  • drawAABB(renderer: Renderer, aabb: AABB, cssColor: string): void

drawFrame

  • drawFrame(renderer: Renderer, cssColor: string, width?: undefined | number, height?: undefined | number): void

Private drawLabel

  • drawLabel(renderer: Renderer): void

Protected drawLayout

  • drawLayout(_renderer: Renderer): void

findPointSourceByPoint

  • findPointSourceByPoint(point: CommonOffset, m?: Matrix, force?: undefined | false | true): PointSource | undefined
  • 自身と自身の子孫の中で、その座標に反応する PointSource を返す。

    戻り値は、対象が見つかった場合、 target に見つかったエンティティを持つ PointSource である。 対象が見つからなかった場合、 undefined である。戻り値が undefined でない場合、その target プロパティは次を満たす:

    • このエンティティ(this) またはその子孫である
    • E#touchable が真である

    Parameters

    • point: CommonOffset

      対象の座標

    • Optional m: Matrix

      this に適用する変換行列。省略された場合、単位行列

    • Optional force: undefined | false | true

      touchable指定を無視する場合真を指定する。省略された場合、偽

    Returns PointSource | undefined

game

  • game(): Game
  • このエンティティが属する Game を返す。

    Returns Game

getMatrix

  • getMatrix(): Matrix
  • このオブジェクトの変換行列を得る。

    Returns Matrix

Protected getMemory

  • getMemory(): unknown

globalToLocal

  • globalToLocal(offset: CommonOffset): CommonOffset
  • ゲームの左上端を基準とした座標をこのEの位置を基準とした相対座標に変換する。

    Parameters

    • offset: CommonOffset

      ゲームの左上端を基準とした座標

    Returns CommonOffset

Private handlePointDown

  • handlePointDown(_ev: PointDownEvent): void

Private handlePointUp

  • handlePointUp(_ev: PointUpEvent): void

hide

  • hide(): void
  • このEを非表示状態にする。

    this.show() が呼ばれるまでの間、このエンティティは各 Renderer によって描画されない。 また Game#findPointSource() で返されることもなくなる。 this#pointDown, pointMove, pointUp なども通常の方法ではfireされなくなる。

    Returns void

insertBefore

  • insertBefore(e: E, target: E | undefined): void
  • 子を挿入する。

    targetthis の子でない場合、append(e) と同じ動作となる。

    Parameters

    • e: E

      子エンティティとして追加するエンティティ

    • target: E | undefined

      挿入位置にある子エンティティ

    Returns void

localToGlobal

  • localToGlobal(offset: CommonOffset): CommonOffset
  • このEの位置を基準とした相対座標をゲームの左上端を基準とした座標に変換する。

    Parameters

    • offset: CommonOffset

      Eの位置を基準とした相対座標

    Returns CommonOffset

modified

  • modified(_isBubbling?: undefined | false | true): void
  • このエンティティに対する変更をエンジンに通知する。

    このメソッドの呼び出し後、 this に対する変更が各 Renderer の描画に反映される。 ただし逆は真ではない。すなわち、再描画は他の要因によって行われることもある。 ゲーム開発者は、このメソッドを呼び出していないことをもって再描画が行われていないことを仮定してはならない。

    本メソッドは、このオブジェクトの Object2D 由来のプロパティ (x, y, angle など) を変更した場合にも呼びだす必要がある。 本メソッドは、描画キャッシュの無効化処理を含まない。描画キャッシュを持つエンティティは、このメソッドとは別に invalidate() を提供している。 描画キャッシュの無効化も必要な場合は、このメソッドではなくそちらを呼び出す必要がある。

    Parameters

    • Optional _isBubbling: undefined | false | true

    Returns void

moveBy

  • moveBy(x: number, y: number): void
  • オブジェクトを相対的に移動する。 このメソッドは xy を同時に加算するためのユーティリティメソッドである。 ECamera2D においてこのメソッドを呼び出した場合、 modified() を呼び出す必要がある。

    Parameters

    • x: number

      X座標に加算する値

    • y: number

      Y座標に加算する値

    Returns void

moveTo

  • moveTo(x: number, y: number): void
  • moveTo(obj: CommonOffset): void
  • オブジェクトを移動する。 このメソッドは xy を同時に設定するためのユーティリティメソッドである。 ECamera2D においてこのメソッドを呼び出した場合、 modified() を呼び出す必要がある。

    Parameters

    • x: number

      X座標

    • y: number

      Y座標

    Returns void

  • オブジェクトを移動する。 このメソッドは xy を同時に設定するためのユーティリティメソッドである。 ECamera2D においてこのメソッドを呼び出した場合、 modified() を呼び出す必要がある。

    Parameters

    • obj: CommonOffset

      X,Y座標

    Returns void

place

  • place(ui: Gui, addContents?: undefined | ((ui: Gui) => void)): void
  • 自身を Gui に配置する。

    処理の実体は placeSelf() で実装する。

    Parameters

    • ui: Gui

      配置先の Gui 。

    • Optional addContents: undefined | ((ui: Gui) => void)

      自身に子ウィジェットを配置する処理。WidgetE はこれを利用しない。

    Returns void

Protected placeSelf

  • placeSelf(placer: Placer, _addContents?: undefined | ((ui: Gui) => void)): void

postRun

  • postRun(): void

remove

  • remove(e?: E): void
  • 子を削除する。

    ethis の子でない場合、 AssertionError がthrowされる。 e === undefined であり親がない場合、 AssertionError がthrowされる。

    Parameters

    • Optional e: E

      削除する子エンティティ。省略された場合、自身を親から削除する

    Returns void

render

  • render(renderer: Renderer, camera?: Camera): void
  • 自分自身と子孫の内容を描画する。

    このメソッドは、 Renderer#draw() からエンティティのツリー構造をトラバースする過程で暗黙に呼び出される。 通常、ゲーム開発者がこのメソッドを呼び出す必要はない。

    Parameters

    • renderer: Renderer

      描画先に対するRenderer

    • Optional camera: Camera

      対象のカメラ。省略された場合、undefined

    Returns void

renderSelf

  • renderSelf(renderer: Renderer, _camera?: g.Camera): true

resizeBy

  • resizeBy(width: number, height: number): void
  • オブジェクトのサイズを相対的に変更する。 このメソッドは widthheight を同時に加算するためのユーティリティメソッドである。 ECamera2D においてこのメソッドを呼び出した場合、 modified() を呼び出す必要がある。

    Parameters

    • width: number

      加算する幅

    • height: number

      加算する高さ

    Returns void

resizeTo

  • resizeTo(width: number, height: number): void
  • resizeTo(size: CommonSize): void
  • オブジェクトのサイズを設定する。 このメソッドは widthheight を同時に設定するためのユーティリティメソッドである。 ECamera2D においてこのメソッドを呼び出した場合、 modified() を呼び出す必要がある。

    Parameters

    • width: number

    • height: number

      高さ

    Returns void

  • オブジェクトのサイズを設定する。 このメソッドは widthheight を同時に設定するためのユーティリティメソッドである。 ECamera2D においてこのメソッドを呼び出した場合、 modified() を呼び出す必要がある。

    Parameters

    • size: CommonSize

      幅と高さ

    Returns void

scale

  • scale(scale: number): void
  • オブジェクトの拡大率を設定する。 このメソッドは scaleXscaleY に同じ値を同時に設定するためのユーティリティメソッドである。 ECamera2D においてこのメソッドを呼び出した場合、 modified() を呼び出す必要がある。

    Parameters

    • scale: number

      拡大率

    Returns void

Protected setMemory

  • setMemory(memory: unknown): void
  • このウィジェットインスタンスのフレームを跨ぐ情報の設定。

    Parameters

    • memory: unknown

      メモリ。

    Returns void

shouldFindChildrenByPoint

  • shouldFindChildrenByPoint(_point: CommonOffset): boolean
  • このメソッドは、 E#findPointSourceByPoint() 内で子孫の探索をスキップすべきか判断するために呼ばれる。 通常、子孫の描画方法をカスタマイズする一部のサブクラスにおいて、与えられた座標に対する子孫の探索を制御する場合に利用する。 ゲーム開発者がこのメソッドを呼び出す必要はない。

    戻り値は、子孫の探索をスキップすべきであれば偽、でなければ真である。

    Parameters

    • _point: CommonOffset

    Returns boolean

show

  • show(): void
  • このEを表示状態にする。

    this.hide() によって非表示状態にされたエンティティを表示状態に戻す。 生成直後のエンティティは表示状態であり、 hide() を呼び出さない限りこのメソッドを呼び出す必要はない。

    Returns void

visible

  • visible(): boolean
  • このEが表示状態であるかどうかを返す。

    Returns boolean

Generated using TypeDoc