itowns
Version:
A JS/WebGL framework for 3D geospatial data visualization
54 lines (53 loc) • 1.61 kB
TypeScript
export default AnimationPlayer;
/**
* It can play, pause or stop Animation or AnimationExpression (See below).
* AnimationPlayer is needed to use Animation or AnimationExpression
* AnimationPlayer emits events :
* - for each animation's frame;
* - when Animation is stopped
* - when Animation is ending
*/
declare class AnimationPlayer extends THREE.EventDispatcher<any> {
constructor();
id: NodeJS.Timer | null;
keyframe: number;
duration: number;
state: number;
waitTimer: number | null;
callback: () => void;
isPlaying(): boolean;
isStopped(): boolean;
isEnded(): boolean;
/**
* Set the Player `callback` property. This callback is executed at each animation frame.
*
* @param {function} callback - The callback to execute at each animation frame.
*/
setCallback(callback: Function): void;
/**
* Play one animation.
* If another animation is playing, it's stopped and the new animation is played.
*
* @param {number} duration - The duration to play
*/
play(duration: number): void;
/**
* Play an animation after a number of frames.
*
* @param {number} duration The duration to play
* @param {number} waitingFrame The waiting time before start animation (time in frame)
*/
playLater(duration: number, waitingFrame: number): void;
/**
* Stop the current animation.
*
*/
stop(): void;
/**
* Executed for each frame.
*
* @private
*/
private frame;
}
import * as THREE from 'three';