GlobalClock¶

Scene ファイル v2 のシーン時刻を管理する時計。

scene.global_clock から取得する。Viewer が毎フレーム進めるため、アプリが更新する必要はない。 "playback" は開始時刻から経過時間 × 倍率で進む。epoch が無ければ日時を持たない。 "realtime" はシステムの現在日時に従い、システムの時計が戻ったときは追い付くまで止まる。 realtime の再生操作は警告して無視する。不正な操作の入力も警告して無視する。

Accessors¶

date¶

get date(): undefined | Date

現在の日時。epoch の無い playback では undefined。

Returns¶

undefined | Date

end¶

get end(): undefined | number

終了時刻 [秒] (既定値 Infinity)。realtime では undefined。

Returns¶

undefined | number

epoch¶

get epoch(): undefined | string

シーン時刻 0 秒に当たる RFC 3339 日時。省略時および realtime では undefined。

Returns¶

undefined | string

mode¶

get mode(): Mode

時計の進め方 (既定値 playback)。

Returns¶

Mode

multiplier¶

get multiplier(): number

速度の倍率 (既定値 1)。変更には setMultiplier を使う。

Returns¶

number

playing¶

get playing(): boolean

進めているか。初期値は autoplay (省略時 true)。realtime では常に true。

Returns¶

boolean

range¶

get range(): undefined | Range

終端の動作 (既定値 clamp)。realtime では undefined。

Returns¶

undefined | Range

start¶

get start(): undefined | number

開始時刻 [秒] (既定値 0)。realtime では undefined。

Returns¶

undefined | number

time¶

get time(): undefined | number

シーン時刻 [秒]。開始時刻以上、終了時刻以下。realtime では undefined。

Returns¶

undefined | number

Methods¶

pause()¶

pause(): void

時計を止める。

Returns¶

void

play()¶

play(): void

進め始める。clamp の終端からは進まないので、再生し直すには seek で戻す。

Returns¶

void

seek()¶

seek(time): void

時刻を移し、値をすぐに反映する。loop でも開始・終了時刻に収め、一周しない。無限大も端に収める。収めた先が有限でない場合や日時を表せない場合は警告して無視する。再生中のアニメーションも移動した秒数だけ動く。停止中と ignore_global_clock のものは動かない。

Parameters¶

Parameter	Type	Description
`time`	`number`	シーン時刻 [秒]

Returns¶

void

setMultiplier()¶

setMultiplier(value): void

速度の倍率を設定する。0 は playing を変えずに進まなくする。上限は無い。

Parameters¶

Parameter	Type	Description
`value`	`number`	0 以上の有限の数 (1 が等速)

Returns¶

void