Constructor
new Animator(optionsopt)
- Source:
- See:
Name | Type | Description |
---|---|---|
options ? |
Partial<T & AnimatorOptions> | animator's options |
Example
const animator = new Animator({
delay: 2,
diretion: "alternate",
duration: 2,
fillMode: "forwards",
iterationCount: 3,
easing: Scene.easing.EASE,
});
Extends
Methods
end() → {Animator}
- Source:
end animator
Returns:
An instance itself.
- Type
- Animator
finish() → {Animator}
- Source:
end animator
Returns:
An instance itself.
- Type
- Animator
getActiveDuration(delayopt) → {number}
- Source:
Get the animator's total duration excluding delay
Name | Type | Description |
---|---|---|
delay ? |
boolean |
Example
animator.getActiveDuration();
Returns:
Total duration excluding delay
- Type
- number
getDelay() → {number}
- Source:
Get a delay for the start of an animation.
Returns:
delay
- Type
- number
getDirection() → {DirectionType}
- Source:
Get whether an animation should be played forwards, backwards or in alternate cycles.
Returns:
direction
- Type
- DirectionType
getDuration() → {number}
- Source:
Get how long an animation should take to complete one cycle.
Returns:
duration
- Type
- number
getEasing() → {EasingType}
- Source:
Get the speed curve of an animation.
Returns:
easing
- Type
- EasingType
getEasingName() → {string}
- Source:
Get the speed curve's name
Returns:
the curve's name.
- Type
- string
getFillMode() → {FillModeType}
- Source:
Get fill mode for the item when the animation is not playing (before it starts, after it ends, or both)
Returns:
fillMode
- Type
- FillModeType
getId() → {number|string}
- Source:
Specifies the unique indicator of the animator
Returns:
the indicator of the item.
- Type
- number | string
getIterationCount() → {IterationCountType}
- Source:
Get the number of times an animation should be played.
Returns:
iterationCount
- Type
- IterationCountType
getIterationTime() → {number}
- Source:
Get the animator's current iteration time
Example
animator.getIterationTime();
Returns:
current iteration time
- Type
- number
getPlaySpeed() → {number}
- Source:
Get the animator's play speed
Returns:
playSpeed
- Type
- number
getPlayState() → {PlayStateType}
- Source:
Get whether the animation is running or paused.
Returns:
playState
- Type
- PlayStateType
getTime() → {number}
- Source:
Get the animator's current time
Example
animator.getTime();
Returns:
current time
- Type
- number
getTotalDuration() → {number}
- Source:
Get the animator's total duration including delay
Example
animator.getTotalDuration();
Returns:
Total duration
- Type
- number
isDelay() → {boolean}
- Source:
Check if the current state of animator is delayed.
Returns:
check delay state
- Type
- boolean
isEnded() → {boolean}
- Source:
Check if the animator has reached the end.
Example
animator.isEnded(); // true or false
Returns:
ended
- Type
- boolean
isPaused() → {boolean}
- Source:
Check if the animator is paused:
Example
animator.isPaused(); // true or false
Returns:
paused
- Type
- boolean
off(nameopt, callbackopt) → {EventTrigger}
- Source:
- Overrides:
Dettach an event handler function for one or more events to target
Name | Type | Description |
---|---|---|
name ? |
string | event's name |
callback ? |
CallbackType | function to execute when the event is triggered. |
Example
const callback = function() {
console.log("animate");
};
target.on("animate", callback);
target.off("animate", callback);
target.off("animate");
Returns:
An Instance itself.
- Type
- EventTrigger
on(name, callbackopt) → {EventTrigger}
- Source:
- Overrides:
Attach an event handler function for one or more events to target
Name | Type | Description |
---|---|---|
name |
string | EventParameter | event's name |
callback ? |
CallbackType | CallbackType[] | function to execute when the event is triggered. |
Example
target.on("animate", function() {
console.log("animate");
});
target.trigger("animate");
Returns:
An Instance itself.
- Type
- EventTrigger
pause() → {Animator}
- Source:
pause animator
Returns:
An instance itself.
- Type
- Animator
play(toTimeopt) → {Animator}
- Source:
play animator
Name | Type | Description |
---|---|---|
toTime ? |
number |
Returns:
An instance itself.
- Type
- Animator
setDelay(delay) → {Animator}
- Source:
Set a delay for the start of an animation.
Name | Type | Description |
---|---|---|
delay |
number | delay |
Returns:
An instance itself.
- Type
- Animator
setDirection(direction) → {Animator}
- Source:
Set whether an animation should be played forwards, backwards or in alternate cycles.
Name | Type | Description |
---|---|---|
direction |
DirectionType | direction |
Returns:
An instance itself.
- Type
- Animator
setDuration(duration) → {Animator}
- Source:
Set how long an animation should take to complete one cycle.
Name | Type | Description |
---|---|---|
duration |
number | duration |
Returns:
An instance itself.
- Type
- Animator
setEasing(curverArray) → {Animator}
- Source:
set animator's easing.
Name | Type | Description |
---|---|---|
curverArray |
string | number[] | EasingFunction | The speed curve of an animation. |
Example
animator.({
delay: 2,
diretion: "alternate",
duration: 2,
fillMode: "forwards",
iterationCount: 3,
easing: Scene.easing.EASE,
});
Returns:
An instance itself.
- Type
- Animator
setFillMode(fillMode) → {Animator}
- Source:
Set fill mode for the item when the animation is not playing (before it starts, after it ends, or both)
Name | Type | Description |
---|---|---|
fillMode |
FillModeType | fillMode |
Returns:
An instance itself.
- Type
- Animator
setId() → {Animator}
- Source:
Specifies the unique indicator of the animator
Type | Description |
---|---|
number | string | String or number of id to be set in the animator |
Returns:
An instance itself.
- Type
- Animator
setIterationCount(iterationCount) → {Animator}
- Source:
Set the number of times an animation should be played.
Name | Type | Description |
---|---|---|
iterationCount |
IterationCountType | iterationCount |
Returns:
An instance itself.
- Type
- Animator
setOptions(optionsopt) → {Animator}
- Source:
- See:
set animator's options.
Name | Type | Default | Description |
---|---|---|---|
options ? |
Partial<AnimatorOptions> |
{}
|
animator's options |
Example
animator.({
delay: 2,
diretion: "alternate",
duration: 2,
fillMode: "forwards",
iterationCount: 3,
easing: Scene.eaasing.EASE,
});
Returns:
An instance itself.
- Type
- Animator
setPlaySpeed(playSpeed) → {Animator}
- Source:
Set the animator's play speed
Name | Type | Description |
---|---|---|
playSpeed |
number | playSpeed |
Returns:
An instance itself.
- Type
- Animator
setPlayState(playState) → {Animator}
- Source:
Set whether the animation is running or paused.
Name | Type | Description |
---|---|---|
playState |
PlayStateType | playState |
Returns:
An instance itself.
- Type
- Animator
setTime(time, isTickopt, isParentopt) → {Animator}
- Source:
set currentTime
Name | Type | Description |
---|---|---|
time |
Number | String | currentTime |
isTick ? |
boolean | |
isParent ? |
boolean |
Example
animator.setTime("from"); // 0
animator.setTime("to"); // 100%
animator.setTime("50%");
animator.setTime(10);
animator.getTime() // 10
Returns:
An instance itself.
- Type
- Animator
trigger(name, ...data) → {EventTrigger}
- Source:
- Overrides:
execute event handler
Name | Type | Description |
---|---|---|
name |
string | event's name |
...data |
any[] | event handler's additional parameter |
Example
target.on("animate", function(a1, a2) {
console.log("animate", a1, a2);
});
target.trigger("animate", [1, 2]); // log => "animate", 1, 2
Returns:
An Instance itself.
- Type
- EventTrigger
Events
ended
- Source:
This event is fired when animator is ended.
iteration
- Source:
The event is fired when an iteration of an animation ends.
Name | Type | Description | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
param |
Object | The object of data to be sent to an event.
Properties
|
paused
- Source:
This event is fired when animator is paused.
play
- Source:
This event is fired when play animator.
timeupdate
- Source:
This event is fired when the animator updates the time.
Name | Type | Description | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
param |
Object | The object of data to be sent to an event.
Properties
|