RotateAnimation
Description
Ce composant crée une animation sur une entité.
Propriétés
Propriété | Type | Défaut | Description |
---|---|---|---|
cible | eid | indéfini | L'objet cible à animer. Si elle n'est pas spécifiée, l'animation est exécutée sur l'objet auquel le composant est attaché. |
deX | nombre | 0 | La coordonnée X de départ de l'animation. |
deY | nombre | 0 | La coordonnée Y de départ de l'animation. |
deZ | nombre | 0 | La coordonnée Z de départ de l'animation. |
toX | nombre | 0 | Coordonnée X de la cible pour l'animation. |
àY | nombre | 0 | La coordonnée Y cible de l'animation. |
toZ | nombre | 0 | La coordonnée Z cible de l'animation. |
autoFrom | booléen | faux | Si cette option est activée, les propriétés 'fromX/Y/Z' sont ignorées et l'animation se fait à partir de l'état de l'objet au début de l'animation. |
durée | nombre | 1000 | Durée de l'animation en millisecondes. |
boucle | booléen | vrai | Si cette option est activée, l'animation est répétée. |
inverser | booléen | faux | Indique si la lecture doit se faire en sens inverse, si la boucle est réglée. |
easeIn | booléen | faux | Si cette option est activée, la fonction d'assouplissement sera appliquée dans le temps au lieu d'une interpolation directe. |
facilitéSortie | booléen | faux | Si cette option est activée, la fonction d'assouplissement sera appliquée dans le temps au lieu d'une interpolation directe. |
easingFunction | chaîne de caractères | Quadratique | Choisissez parmi les options suivantes : quadratique, cubique, quartique, quintique, sinusoïdale, exponentielle, circulaire, élastique, retour et rebond. |
chemin le plus court | booléen | faux | Si cette option est activée, l'animation empruntera le chemin le plus court jusqu'à son terme. |
Fonctions
Get
Returns a read-only reference.
Example
ecs.RotateAnimation.get(world, component.eid)
Set
Ensures the component exists on the entity, then assigns the (optional) data to the component.
Example
ecs.RotateAnimation.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.RotateAnimation.mutate(world, component.eid, (cursor) => {
cursor.to.z = 90 ;
cursor.duration = 1500 ;
return false;
})
Remove
Removes the component from the entity.
Example
ecs.RotateAnimation.remove(world, component.eid)
Has
Returns true
if the component is present on the entity.
Example
ecs.RotateAnimation.has(world, component.eid)
Reset
Adds, or resets the component to its default state.
Example
ecs.RotateAnimation.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.RotateAnimation.cursor(world, component.eid)
Acquire
Same behavior as cursor, but commit must be called after the cursor is done being used.
Example
ecs.RotateAnimation.acquire(world, component.eid)
Commit
Called after acquire. An optional third argument determines whether the cursor was mutated or not.
Example
ecs.RotateAnimation.commit(world, component.eid)
ecs.RotateAnimation.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.RotateAnimation.dirty(world, component.eid)