コンテンツにスキップ

abstract Type

アニメーション値の型

アニメーションする値の型を表現するための抽象クラスである。 Binder インスタンスと結合するパラメータ値の型と、Curve インスタンスが返却する値の型を表現する。

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

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

Constructors

new Type()

protected new Type(name): Type

Parameters

Parameter Type Description
name string 型の登録名

Returns

Type

Accessors

name

get name(): string

型名

Returns

string

Methods

convertValue()

abstract convertValue(from, value): any

値を変換

value を this 型へ変換したオブジェクトを返す。 変換結果が value と同じ値の場合、value 自身を返すことも可能である。

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

Parameters

Parameter Type Description
from Type 変換元の型
value any 変換元の値 (from 型)

Returns

any

変換された値 (this 型)

See

mapray.animation.Type.isConvertible


find()

static find(name): Type

型を検索

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

Parameters

Parameter Type Description
name string 型の名前

Returns

Type

検索結果

Throws

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

See

mapray.animation.Type.register


getCloneValue()

abstract getCloneValue(value): any

値の複製を取得

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

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

Parameters

Parameter Type Description
value any 複製元の値 (this 型)

Returns

any

複製された値 (this 型)


getDefaultValue()

abstract getDefaultValue(): any

既定値を取得

this 型の既定値を返す。

Returns

any

既定値 (this 型)


isConvertible()

abstract isConvertible(from): boolean

変換可能か?

from 型の値を this 型の値への変換が可能かどうかを返す。 this と from が同一なら、必ず true を返す。 このメソッドが true を返した場合は convertValue() により from 型の値を this 型の値に変換することが可能である。

Parameters

Parameter Type Description
from Type 変換元の型

Returns

boolean

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

See

mapray.animation.Type.convertValue


register()

static register(name, type): Type

型を登録

名前を name として type 型を登録する。 登録された type は name により検索することができる。

Parameters

Parameter Type Description
name string 型の名前
type Type Type インスタンス

Returns

Type

Throws

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

See

mapray.animation.Type.find