PositionAnimation

Beschreibung

Diese Komponente erstellt eine Animation für ein Objekt.

Eigenschaften

Eigenschaft	Typ	Standard	Beschreibung
Ziel	eid	undefiniert	Das Zielobjekt, das animiert werden soll. Wenn nicht angegeben, wird die Animation auf dem Objekt ausgeführt, an das die Komponente angehängt ist.
vonX	Nummer	0	Die Start-X-Koordinate für die Animation.
vonY	Nummer	0	Die Start-Y-Koordinate für die Animation.
vonZ	Nummer	0	Die Start-Z-Koordinate für die Animation.
toX	Nummer	0	Die Ziel-X-Koordinate für die Animation.
toY	Nummer	0	Die Y-Zielkoordinate für die Animation.
toZ	Nummer	0	Die Ziel-Z-Koordinate für die Animation.
autoFrom	boolean	false	Wenn diese Option aktiviert ist, werden die 'fromX/Y/Z'-Eigenschaften ignoriert und die Animation beginnt mit dem Zustand des Objekts zu Beginn der Animation.
Dauer	Nummer	1000	Die Dauer der Animation in Millisekunden.
Schleife	boolean	true	Wenn aktiviert, wird die Animation wiederholt.
umkehren	boolean	false	Ob rückwärts abgespielt werden soll, wenn Schleife eingestellt ist.
easeIn	boolean	false	Wenn diese Funktion aktiviert ist, wird anstelle einer geraden Interpolation eine zeitliche Staffelung vorgenommen.
easeOut	boolean	false	Wenn diese Funktion aktiviert ist, wird anstelle einer geraden Interpolation eine zeitliche Staffelung vorgenommen.
easingFunction	String	Quadratisch	Wählen Sie zwischen quadratisch, kubisch, quartisch, quintisch, sinusförmig, exponentiell, kreisförmig, elastisch, zurück und prellend
kürzesterWeg	boolean	false	Wenn diese Option aktiviert ist, nimmt die Animation den kürzesten Weg zur Fertigstellung.

Funktionen

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, {
  from: {
    x: 0,
    y: 0,
    z: 0
 },
  to: {
    x: 0,
    y: 0,
    z: 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.to.x = 10;
  cursor.to.y = 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)