DOCS
References

Class: EasyBindingBlock

mapray.animation~ EasyBindingBlock

new EasyBindingBlock()

アニメーションパラメータ設定のヘルパークラス

Source:

Extends

Methods

addDescendantUnbinder(unbinder)

子孫の結合を解除するための関数を追加

Parameters:
Name Type Description
unbinder mapray.animation.EasyBindingBlock.DescendantUnbinder

子孫の結合を解除するための関数
Source:
See:

addEntry(id, types, type_solver, setter)

アニメーション可能パラメータを追加

識別子を id としてアニメーション可能なパラメータを登録する。

types にはこのパラメータに結合可能なアニメーション関数の 1 つまたはそれ以上の型を配列で与える。

types に 2 つ以上の型が存在するときは type_solver に型を決定する関数を指定しなければならない。 1 つしか型が存在しないとき type_solver は無視されるので null を与えてもよい。

setter は実際のパラメータに値を設定する関数である。

id に対応するパラメータがすでに結合されている場合はその結合が解除される。

Parameters:
Name Type Argument Description
id string

パラメータ ID
types Array.<mapray.animation.Type>

サポートする型のリスト
type_solver mapray.animation.EasyBindingBlock.TypeSolver <nullable>

型決定関数
setter mapray.animation.Binder.Setter

パラメータ設定関数
Source:
See:

bind(id, updater, curve)

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

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

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

Parameters:
Name Type Description
id string

パラメータ ID
updater mapray.animation.Updater

アニメーションパラメータ更新管理
curve mapray.animation.Curve

アニメーション関数
Inherited From:
Overrides:
Source:
See:
Throws:

enumSupportedParameters()

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

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

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

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

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

getBoundCurve(id)

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

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

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

Parameters:
Name Type Description
id string

パラメータ ID
Inherited From:
Overrides:
Source:
Returns:
Type
mapray.animation.Curve

getBoundUpdater(id)

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

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

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

Parameters:
Name Type Description
id string

パラメータ ID
Inherited From:
Overrides:
Source:
Returns:
Type
mapray.animation.Updater

isBound(id)

パラメータは結合中か？

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

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

Parameters:
Name Type Description
id string

パラメータ ID
Inherited From:
Overrides:
Source:
Returns:
Type
boolean

unbind(id)

パラメータの結合を解除

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

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

Parameters:
Name Type Description
id string

パラメータ ID
Inherited From:
Overrides:
Source:

unbindAll()

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

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

Inherited From:
Overrides:
Source:

unbindAllRecursively()

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

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

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

Inherited From:
Overrides:
Source:

Type Definitions

DescendantUnbinder()

子孫の結合を解除するための関数

一般的な実装では、直接の子オブジェクトの .animation.unbindAllRecursively() を呼び出す。

Source:
See:

TypeSolver(curve)

型決定関数

ここで説明する types と setter は addEntry() の引数、curve は bind() の引数である。

types と curve がサポートする型から、setter 関数に渡されるパラメータの型 (curve から得る関数値の型も同じ) を決定して返す。

この関数は types に含まれる型、かつ curve がサポートする型以外は返さない。そのような型が決定できなければ null を返す。

この関数は types に複数の型を指定したときに、bind() の呼び出しのタイミングで呼び出される。types に 1 つの型しか存在しないときは呼び出されない。

Parameters:
Name Type Description
curve mapray.animation.Curve
Source:
See:
Returns:
Type
mapray.animation.Type