CustomVec3Animation

Descripción

Este componente crea una animación sobre una entidad.

Propiedades

Propiedad	Tipo	Por defecto	Descripción
atributo	cadena	''	Atributo seleccionado para animar (por ejemplo, posición, escala, material)
objetivo	eid	indefinido	El objeto objetivo a animar. Si no se especifica, la animación se ejecuta en el objeto al que está unido el componente.
de	objeto	indefinido	Estado inicial de la animación
a	objeto	indefinido	El estado final de la animación
autoFrom	booleano	falso	Si está activada, ignora la propiedad 'from' y anima a partir del estado del objeto al inicio de la animación.
duración	número	0	Duración de la animación en milisegundos.
bucle	booleano	falso	Si está activada, repite la animación.
invertir	booleano	falso	Si se reproduce en sentido inverso, si se establece el bucle.
easeIn	booleano	falso	Si está activada, la función de atenuación se aplicará a lo largo del tiempo en lugar de la interpolación directa.
easeOut	booleano	falso	Si está activada, la función de atenuación se aplicará a lo largo del tiempo en lugar de la interpolación directa.
easingFunction	cadena	''	Elija entre Cuadrático (por defecto), Cúbico, Cuártico, Quíntico, Sinusoidal, Exponencial, Circular, Elástico, Retroceso y Rebote.

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)