本文へスキップ

顔

説明​

このコンポーネントは、エンティティのトランスフォームをXRで追跡された顔に追従させる。 顔を見つけたり失ったりすると、その実体を表示したり隠したりする。

プロパティ​

テストしたいサンプルシーンを Scenes in Build にドラッグします。 Home シーンがリストの一番上にあることを確認します。

プロパティタイプデフォルト説明
idnumber1The id of the face that is currently being tracked out of the number of faces tracked, specified by the active camera

機能​

テストしたいサンプルシーンを Scenes in Build にドラッグします。 Home シーンがリストの一番上にあることを確認します。

Get​

Returns a read-only reference.

Example

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

Set​

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

Example

ecs.Face.set(world, component.eid, {
  id: 1,
  addAttachmentState: false
})

Mutate​

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

Example

ecs.Face.mutate(world, component.eid, (cursor) => {
  cursor.id = 1;
  cursor.addAttachmentState = true;
  return false;
})

Remove​

Removes the component from the entity.

Example

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

Has​

Returns true if the component is present on the entity.

Example

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

Reset​

Adds, or resets the component to its default state.

Example

ecs.Face.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.Face.cursor(world, component.eid)

Acquire​

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

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

Commit​

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

Example
ecs.Face.commit(world, component.eid)
ecs.Face.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.Face.dirty(world, component.eid)