Class: BindingBlock

mapray.animation~ BindingBlock

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

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

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

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


<abstract, protected> new BindingBlock()

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

Source:
See:

Classes

Parameter

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

Methods


<abstract> bind(id, updater, curve)

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

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

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

Parameters:
Name Type Description
id string

パラメータ ID

updater mapray.animation.Updater

アニメーションパラメータ更新管理

curve mapray.animation.Curve

アニメーション関数

Source:
See:
Throws:

<abstract> enumSupportedParameters()

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

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

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

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

Source:
Returns:
Type
Array.<mapray.animation.BindingBlock.Parameter>

<abstract> getBoundCurve(id)

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

id が示すパラメータが結合されている Curve インスタンスを返す。

ただし this.isBound( id ) == false のときは null を返す。

Parameters:
Name Type Description
id string

パラメータ ID

Source:
Returns:
Type
mapray.animation.Curve

<abstract> getBoundUpdater(id)

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

id が示すパラメータが結合されている Updater インスタンスを返す。

ただし this.isBound( id ) == false のときは null を返す。

Parameters:
Name Type Description
id string

パラメータ ID

Source:
Returns:
Type
mapray.animation.Updater

<abstract> isBound(id)

パラメータは結合中か?

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

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

Parameters:
Name Type Description
id string

パラメータ ID

Source:
Returns:
Type
boolean

<abstract> unbind(id)

パラメータの結合を解除

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

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

Parameters:
Name Type Description
id string

パラメータ ID

Source:

<abstract> unbindAll()

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

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

Source:

<abstract> unbindAllRecursively()

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

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

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

Source: