Class: Type

mapray.animation~ Type

アニメーションする値の型を表現するための抽象クラスである。

Binder インスタンスと結合するパラメータ値の型と、Curve インスタンスが返却する値の型を表現する。

Type の具象クラスのインスタンスは mapray.animation.Type.register() により登録し、mapray.animation.Type.find() により取得することができる。

特定の Type の具象クラスのインスタンスは 1 つしか存在しない。そのため Type インスタンスが表す型の同一性は === 演算子で判断することができる。


<abstract, protected> new Type(name)

アニメーション値の型

Parameters:
Name Type Description
name string

型の登録名

Source:

Classes

AlreadyRegisteredError

型の多重登録エラー

NotRegisteredError

型の未登録エラー

Members


<readonly> name :string

型名

Type:
  • string
Source:

Methods


<static> find(name)

型を検索

名前が name として登録された Type インスタンスを返す。

name の型が登録されている場合、name に対して常に同じインスタンスを返す。

Parameters:
Name Type Description
name string

型の名前

Source:
See:
Throws:

mapray.animation.Type.NotRegisteredError name に対応する型が登録されていないとき

Returns:
Type
mapray.animation.Type

<static> register(name, type)

型を登録

名前を name として type 型を登録する。

登録された type は name により検索することができる。

Parameters:
Name Type Description
name string

型の名前

type mapray.animation.Type

Type インスタンス

Source:
See:
Throws:

mapray.animation.Type.AlreadyRegisteredError name がすでに登録されているとき

Returns:

type

Type
mapray.animation.Type

<abstract> convertValue(from, value)

値を変換

value を this 型へ変換したオブジェクトを返す。

変換結果が value と同じ値の場合、value 自身を返すことも可能である。

事前条件1: value は from 型のオブジェクトである
事前条件2: this.isConvertible( from ) == true

Parameters:
Name Type Description
from mapray.animation.Type

変換元の型

value object

変換元の値 (from 型)

Source:
See:
Returns:

変換された値 (this 型)

Type
object

<abstract> getCloneValue(value)

値の複製を取得

value の新しい複製を返す。

ただし value がイミュータブルの場合、value 自身を返すことも可能である。

事前条件: value は this 型のオブジェクトである

Parameters:
Name Type Description
value object

複製元の値 (this 型)

Source:
Returns:

複製された値 (this 型)

Type
object

<abstract> getDefaultValue()

既定値を取得

this 型の既定値を返す。

Source:
Returns:

既定値 (this 型)

Type
object

<abstract> isConvertible(from)

変換可能か?

from 型の値を this 型の値への変換が可能かどうかを返す。

this と from が同一なら、必ず true を返す。

このメソッドが true を返した場合は convertValue() により from 型の値を this 型の値に変換することが可能である。

Parameters:
Name Type Description
from mapray.animation.Type

変換元の型

Source:
See:
Returns:

変換可能かなら true, そうでないなら false

Type
boolean