Class KFLinearCurve

キーフレームによる線形関数

キーフレーム間を数値またはベクトルを線形に補間する関数である。

関数値の型は構築子のパラメータにより number, vector2, vector3 または vector4 を指定する。

Hierarchy

Curve
- KFLinearCurve

Index

Constructors

constructor

new KFLinearCurve(type: mapray.animation.Type, keyframes?: (number | Float32Array | Float64Array | [x: number, y: number, z: number, w: number] | [x: number, y: number, z: number] | [x: number, y: number] | Time)[]): KFLinearCurve
type 型の関数を keyframes により生成する。

type は number, vector2, vector3 または vector4 を指定することができる。

keyframes を省略したときは type 型の既定値を返す定数関数と同等になる。keyframes の形式に関しては setKeyFrames() を参照のこと。
Parameters
- type: mapray.animation.Type
  
  関数値の型
- Optional keyframes: (number | Float32Array | Float64Array | [x: number, y: number, z: number, w: number] | [x: number, y: number, z: number] | [x: number, y: number] | Time)[]
  
  初期キーフレーム
Returns KFLinearCurve
Overrides Curve.constructor
- Defined in packages/mapray/src/animation/KFLinearCurve.ts:46

Properties

`Private` _dimension

_dimension: number

1〜4

`Private` _key_times

_key_times: Time[]

`Private` _key_values

_key_values: Float64Array

`Private` _num_keyframes

_num_keyframes: number

= 2

`Private` _value_type

_value_type: mapray.animation.Type

number | vector2 | vector3 | vector4

Methods

`Private` _createKeyFrameValue

_createKeyFrameValue(index: number): number | Float64Array
キーフレーム値を生成

Returns
キーフレーム値 (this._value_type に適応した型)
Parameters
- index: number
  
  キーフレームのインデックス
Returns number | Float64Array
- Defined in packages/mapray/src/animation/KFLinearCurve.ts:184

`Private` _createValueBy2Keys

_createValueBy2Keys(i0: number, i1: number, time: Time): any
キーフレーム間の補間値を生成

Returns
補間値 (this._value_type に適応した型)
Parameters
- i0: number
  
  先キーフレームのインデックス
- i1: number
  
  後キーフレームのインデックス
- time: Time
Returns any
- Defined in packages/mapray/src/animation/KFLinearCurve.ts:214

`Private` _getInterpolatedValue

_getInterpolatedValue(time: Time): any
time での補間値を取得

Returns
補間値 (this._value_type に適応した型)
Parameters
- time: Time
Returns any
- Defined in packages/mapray/src/animation/KFLinearCurve.ts:156

addValueChangeListener

addValueChangeListener(vcl: ValueChangeListener): void
関数値変化リスナーの登録

See
- Curve.notifyValueChange
- Curve.removeValueChangeListener
Parameters
- vcl: ValueChangeListener
  
  関数値変化リスナー
Returns void
Inherited from Curve.addValueChangeListener
- Defined in packages/mapray/src/animation/Curve.ts:114

getInvariance

getInvariance(interval: Interval): Invariance
不変性情報を取得

interval で指定される範囲の不変性情報を返す。

不変性情報は interval に内包されるまたは交差する時刻区間を持っている。

一部が interval と交差する時刻区間はクリップしない。

事前条件: interval.isEmpty() == false

Returns
不変性情報
Parameters
- interval: Interval
  
  対象とする時刻区間
Returns Invariance
Overrides Curve.getInvariance
- Defined in packages/mapray/src/animation/KFLinearCurve.ts:133

getValue

getValue(time: Time, type: mapray.animation.Type): any
指定時刻の値を取得

時刻 time のアニメーション関数値を type 型として取得する。

事前条件: this.isTypeSupported( type ) == true

Returns
時刻 time に対する type 型の値

See
mapray.animation.Curve.isTypeSupported
Parameters
- time: Time
  
  時刻パラメータ
- type: mapray.animation.Type
  
  返却値の型
Returns any
Overrides Curve.getValue
- Defined in packages/mapray/src/animation/KFLinearCurve.ts:125

isTypeSupported

isTypeSupported(type: mapray.animation.Type): boolean
型はサポートされるか？

type 型がアニメーション関数の返却値の型として使用できるかどうかを返す。

this の生存中、このメソッドの type に対する結果は一定である。

このメソッドが true を返した場合、getValue() によりアニメーション関数値を type 型で取得することが可能である。

Returns
type がサポートされるとき true, それ以外は false

See
Curve.getValue
Parameters
- type: mapray.animation.Type
  
  確認する型
Returns boolean
Overrides Curve.isTypeSupported
- Defined in packages/mapray/src/animation/KFLinearCurve.ts:118

`Protected` notifyValueChange

notifyValueChange(interval: Interval): void
関数値が変化したことを通知

時刻区間 interval の範囲の関数値が変化したことをフレームワークに通知する。

このメソッドは関数値が変化したときにサブクラスの実装者が呼び出す。

See
- Curve.addValueChangeListener
- Curve.removeValueChangeListener
Parameters
- interval: Interval
  
  関数値が変化した時刻区間
Returns void
Inherited from Curve.notifyValueChange
- Defined in packages/mapray/src/animation/Curve.ts:91

removeValueChangeListener

removeValueChangeListener(vcl: ValueChangeListener): void
関数値変化リスナーの登録解除

See
- Curve.notifyValueChange
- Curve.addValueChangeListener
Parameters
- vcl: ValueChangeListener
Returns void
Inherited from Curve.removeValueChangeListener
- Defined in packages/mapray/src/animation/Curve.ts:128

setKeyFrames

setKeyFrames(keyframes: any): void
キーフレーム設定

keyframes により、すべてのキーフレームを指定する。

条件
- keyframes.length >= 4 (キーフレーム数 >= 2) -: すべての i, j において、i < j ⇔ 時刻i < 時刻j -: すべての i において、値i は構築子の type 引数で指定した型のインスタンス
Parameters
- keyframes: any
  
  [時刻0, 値0, 時刻1, 値1, ...]
Returns void
- Defined in packages/mapray/src/animation/KFLinearCurve.ts:84

Class KFLinearCurve

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

type: mapray.animation.Type

Optional keyframes: (number | Float32Array | Float64Array | [x: number, y: number, z: number, w: number] | [x: number, y: number, z: number] | [x: number, y: number] | Time)[]

Returns KFLinearCurve

Properties

Private _dimension

Private _key_times

Private _key_values

Private _num_keyframes

Private _value_type

Methods

Private _createKeyFrameValue

Returns

Parameters

index: number

Returns number | Float64Array

Private _createValueBy2Keys

Returns

Parameters

i0: number

i1: number

time: Time

Returns any

Private _getInterpolatedValue

Returns

Parameters

time: Time

Returns any

addValueChangeListener

See

Parameters

vcl: ValueChangeListener

Returns void

getInvariance

Returns

Parameters

interval: Interval

Returns Invariance

getValue

Returns

See

Parameters

time: Time

type: mapray.animation.Type

Returns any

isTypeSupported

Returns

See

Parameters

type: mapray.animation.Type

Returns boolean

Protected notifyValueChange

See

Parameters

interval: Interval

Returns void

removeValueChangeListener

See

Parameters

vcl: ValueChangeListener

Returns void

setKeyFrames

Parameters

keyframes: any

Returns void

Settings

Member Visibility

Theme

`Optional` keyframes: (number | Float32Array | Float64Array | [x: number, y: number, z: number, w: number] | [x: number, y: number, z: number] | [x: number, y: number] | Time)[]

`Private` _dimension

`Private` _key_times

`Private` _key_values

`Private` _num_keyframes

`Private` _value_type

`Private` _createKeyFrameValue

`Private` _createValueBy2Keys

`Private` _getInterpolatedValue

`Protected` notifyValueChange