Zum Hauptinhalt springen

Kamera

Beschreibung

Diese Komponente ermöglicht es dem Benutzer, die Welt durch die Entität zu betrachten.

Eigenschaften

Weltweite Auswirkungen

EigenschaftTypStandardBeschreibung
scaleString'responsive'Entweder 'responsiv' oder 'absolut'. responsive gibt Werte zurück, so dass sich die Kamera auf Bild 1 am Ursprung befindet, der über XR8.XrController.updateCameraProjectionMatrix() definiert wurde. absolute gibt die Kamera, die Bildziele usw. in Metern zurück. Bei der Verwendung von absolut werden die x-Position, die z-Position und die Drehung der Ausgangspose die in XR8.XrController.updateCameraProjectionMatrix() festgelegten Parameter berücksichtigen, sobald der Maßstab geschätzt wurde. Die y-Position hängt von der physischen Höhe der Kamera über dem Boden ab.

Gesichtseffekte

EigenschaftTypStandardBeschreibung
nearClipNummer0.1Die Entfernung der nahen Clipebene von der Kamera, d.h. die kürzeste Entfernung zur Kamera, in der Szenenobjekte sichtbar sind.
farClipNummer1000Die Entfernung der fernen Clipebene von der Kamera, d.h. die weiteste Entfernung zur Kamera, in der Szenenobjekte sichtbar sind.
GesichtbooleantrueOb die Geometrie des Gesichtsnetzes angezeigt werden soll.
AugenbooleanfalseOb die Geometrie des Augennetzes angezeigt werden soll.
IrisbooleanfalseOb die Geometrie des Blendennetzes angezeigt werden soll.
MundbooleanfalseOb die Geometrie des Mundnetzes angezeigt werden soll.
maxDetectionsNummer1Die maximale Anzahl der zu erkennenden Gesichter. Sie haben die Wahl zwischen 1, 2 und 3.
enableEarsbooleanfalseWenn "true", wird die Ohrenerkennung gleichzeitig mit den Gesichtseffekten ausgeführt und die Ohranlegepunkte werden zurückgegeben.

Funktionen

Get

Returns a read-only reference.

Example

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

Set

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

Example

ecs.Kamera.set(world, component.eid, {
scale: 'responsive',
nearClip: 0.1,
farClip: 1000,
Face: true,
Eyes: false,
Iris: false,
Mouth: false,
maxDetections: 1,
enableEars: false
})

Mutate

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

Example

ecs.Kamera.mutate(world, component.eid, (cursor) => {
cursor.scale = 'absolute';
cursor.nearClip = 0.5;
return false;
})

Remove

Removes the component from the entity.

Example

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

Has

Returns true if the component is present on the entity.

Example

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

Reset

Adds, or resets the component to its default state.

Example

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

Acquire

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

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

Commit

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

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