コンテンツにスキップ

abstract BindingBlock

アニメーション設定の標準インタフェース

オブジェクトのアニメーション可能パラメータにアニメーションを設定 (バインド) するための標準的なインタフェースを提供する。

具体的には内部で各パラメータに適した [[Binder]] インスタンスの生成し、ユーザーが簡単にアニメーションを設定できるようにする。

一般的に、アニメーション可能パラメータを持つオブジェクトの animation プロパティから、このインタフェースを得ることができる。

注意: アニメーションを設定しているパラメータは [[Updater]] のメソッドを通してのみ更新することができる。 それ以外の手段でパラメータを更新した場合はパラメータ値に矛盾が生じる可能性がある。

See

  • [[Binder]]
  • [[Updater]]

Extended by

Constructors

new BindingBlock()

new BindingBlock(): BindingBlock

Returns

BindingBlock

Methods

bind()

abstract bind(id, updater, curve): void

パラメータにアニメーションを結合

id が示すパラメータと updater と curve を結びつける。ただし、すでに id が示すパラメータに結合があれば、先にその結合を解除してから行う。

パラメータが結合されている間、updater によりそのパラメータを更新することができる。

Parameters

Parameter Type Description
id string パラメータ ID
updater Updater アニメーションパラメータ更新管理
curve Curve アニメーション関数

Returns

void

Throws

[[AnimationError]] id が示すパラメータはアニメーションに対応していない

Throws

[[TypeMismatchError]] id が示すパラメータの型と curve の型に互換性がないとき

See

[[Binder]]

Abstract


enumSupportedParameters()

abstract enumSupportedParameters(): Parameter[]

アニメーション可能パラメータの情報を取得

アニメーションに対応したパラメータの情報を配列として取得する。

返される配列は 0 個またはそれ以上の要素を含み、要素間のパラメータ ID は重複しない。

this の生存期間中、(順序以外) 常に同じ内容を返す。

Returns

Parameter[]


getBoundCurve()

abstract getBoundCurve(id): undefined | Curve

パラメータに結合されている Curve インスタンスを取得

id が示すパラメータが結合されている Curve インスタンスを返す。 ただし this.isBound( id ) == false のときは null を返す。

Parameters

Parameter Type Description
id string パラメータ ID

Returns

undefined | Curve


getBoundUpdater()

abstract getBoundUpdater(id): undefined | Updater

パラメータに結合されている Updater インスタンスを取得

id が示すパラメータが結合されている Updater インスタンスを返す。 ただし this.isBound( id ) == false のときは null を返す。

Parameters

Parameter Type Description
id string パラメータ ID

Returns

undefined | Updater


isBound()

abstract isBound(id): boolean

パラメータは結合中か?

id が示すパラメータが結合されているとき true, 結合されていないとき false を返す。

ただし id が示すパラメータがアニメーションに対応していないときは false を返す。

Parameters

Parameter Type Description
id string パラメータ ID

Returns

boolean


unbind()

abstract unbind(id): void

パラメータの結合を解除

id が示すパラメータの結合を解除する。

ただし this.isBound( id ) == false のときは何もしない。

Parameters

Parameter Type Description
id string パラメータ ID

Returns

void


unbindAll()

abstract unbindAll(): void

すべてのパラメータの結合を解除

現在結合されているすべてのパラメータの結合を解除する。

Returns

void


unbindAllRecursively()

abstract unbindAllRecursively(): void

すべてのパラメータの結合を解除 (子孫含む)

現在結合されているすべてのパラメータの結合を解除する。

もしパラメータを持つオブジェクトの子オブジェクトも BindingBlock インタフェースを持っていれば、子孫も含めて結合を解除する。

Returns

void