本文へスキップ

ポジションアニメーション

説明​

このコンポーネントは、エンティティにアニメーションを作成します。

プロパティ​

プロパティタイプデフォルト説明
ターゲットイード未定義アニメートする対象のオブジェクト。 指定されていない場合、アニメーションはコンポーネントがアタッチされているオブジェクト上で実行されます。
フロムエックス番号0アニメーションの開始X座標。
フロムワイ番号0アニメーションの開始Y座標。
フロムゼット番号0アニメーションの開始Z座標。
トゥエックス番号0アニメーションのターゲットX座標。
トゥワイ番号0アニメーションのターゲットY座標。
toZ番号0アニメーションのターゲットZ座標。
オートフロムブーリアン擬似有効にすると、'fromX/Y/Z' プロパティを無視し、アニメーション開始時のオブジェクトの状態からアニメーションを行う。
存続期間番号1000アニメーションの実行時間（ミリ秒）。
ループブーリアン真の有効にすると、アニメーションを繰り返す。
リバースブーリアン擬似ループが設定されている場合、逆再生を行うかどうか。
イージーインブーリアン擬似有効にすると、直線補間の代わりにイージング機能が適用される。
イーズアウトブーリアン擬似有効にすると、直線補間の代わりにイージング機能が適用される。
イージング機能ストリングクアドラティック二次、三次、四次、五次、正弦波、指数、円形、弾性、バック、バウンスから選択
最短パスブーリアン擬似有効な場合、アニメーションは最短経路で完了する。

機能​

Get​

Returns a read-only reference.

Example

ecs.PositionAnimation.get(world, component.eid)

Set​

Ensures the component exists on the entity, then assigns the (optional) data to the component.

Example

ecs.PositionAnimation.set(world, component.eid, {
  fromX: 0,
  fromY: 0,
  fromZ: 0,
  toX: 0,
  toY: 0,
  toZ: 0,
  autoFrom: false,
  duration: 1000,
  loop: true,
  reverse: false,
  easeIn: false,
  easeOut: false,
  easingFunction: 'Quadratic'
})

Mutate​

Perform an update to the component within a callback function. Return true to indicate no changes made.

Example

ecs.PositionAnimation.mutate(world, component.eid, (cursor) => {
  cursor.toX = 10;
  cursor.toY = 5;
  cursor.duration = 2000;
  return false;
})

Remove​

Removes the component from the entity.

Example

ecs.PositionAnimation.remove(world, component.eid)

Has​

Returns true if the component is present on the entity.

Example

ecs.PositionAnimation.has(world, component.eid)

Reset​

Adds, or resets the component to its default state.

Example

ecs.PositionAnimation.reset(world, component.eid)

Advanced Functions​

Cursor​

Returns a mutable reference. Cursors are reused so only one cursor for each component can exist at a time.

Example
ecs.PositionAnimation.cursor(world, component.eid)

Acquire​

Same behavior as cursor, but commit must be called after the cursor is done being used.

Example
ecs.PositionAnimation.acquire(world, component.eid)

Commit​

Called after acquire. An optional third argument determines whether the cursor was mutated or not.

Example
ecs.PositionAnimation.commit(world, component.eid)
ecs.PositionAnimation.commit(world, component.eid, false)

Dirty​

Mark the entity as having been mutated. Only needed in a specific case where systems are mutating data.

Example
ecs.PositionAnimation.dirty(world, component.eid)