カスタムVec3アニメーション
商品説明
このコンポーネントは、エンティティにアニメーションを作成します。
プロパティ一覧
Property | Type | 初期値 | 商品説明 |
---|---|---|---|
属性 | ストリング | '' | アニメートする属性を選択(位置、スケール、マテリアルなど) |
ターゲット | イード | 未定義 | アニメートする対象のオブジェクト。 指定されていない場合、アニメーションはコンポーネントがアタッチされているオブジェクト上で実行されます。 |
より | オブジェクト | 未定義 | アニメーションの開始状態 |
への | オブジェクト | 未定義 | アニメーションの終了状態 |
オートフロム | ブーリアン | false | 有効にした場合、'from' プロパティを無視し、アニメーション開始時のオブジェクトの状態からアニメーションを行う。 |
存続期間 | 番号 | 0 | アニメーションの実行時間(ミリ秒)。 |
ループ | ブーリアン | false | 有効にすると、アニメーションを繰り返す。 |
リバース | ブーリアン | false | ループが設定されている場合、逆再生を行うかどうか。 |
イージーイン | ブーリアン | false | 有効にすると、直線補間の代わりにイージング機能が適用される。 |
イーズアウト | ブーリアン | false | 有効にすると、直線補間の代わりにイージング機能が適用される。 |
イージング機能 | ストリング | '' | 二次(デフォルト)、三次、四次、五次、正弦波、指数、円形、弾性、バック、バウンスから選択 |
Get
Returns a read-only reference.
Example
ecs.CustomVec3Animation.get(world, component.eid)
Set
Ensures the component exists on the entity, then assigns the (optional) data to the component.
Example
ecs.CustomVec3Animation.set(world, component.eid, {
attribute: 'position',
from: {
x: 0,
y: 0,
z: 0
},
to: {
x: 10,
y: 10,
z: 10
},
autoFrom: false,
duration: 1000,
loop: false,
reverse: false,
easeIn: false,
easeOut: false,
easingFunction: 'Cubic'
})
Mutate
Perform an update to the component within a callback function. Return true
to indicate no changes made.
Example
ecs.CustomVec3Animation.mutate(world, component.eid, (cursor) => {
cursor.duration = 1000;
cursor.loop = true;
return false;
})
Remove
Removes the component from the entity.
Example
ecs.CustomVec3Animation.remove(world, component.eid)
Has
Returns true
if the component is present on the entity.
Example
ecs.CustomVec3Animation.has(world, component.eid)
Reset
Adds, or resets the component to its default state.
Example
ecs.CustomVec3Animation.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.CustomVec3Animation.cursor(world, component.eid)
Acquire
Same behavior as cursor, but commit must be called after the cursor is done being used.
Example
ecs.CustomVec3Animation.acquire(world, component.eid)
Commit
Called after acquire. An optional third argument determines whether the cursor was mutated or not.
Example
ecs.CustomVec3Animation.commit(world, component.eid)
ecs.CustomVec3Animation.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.CustomVec3Animation.dirty(world, component.eid)