Source: extern/time.js

  1. import register from "../util/register.js";
  3. import m_time_fact from "../intern/time.js";
  5. /**
  6.  * Time API.
  7.  * @module time
  8.  */
  9. function Time(ns, exports) {
  11. var m_time = m_time_fact(ns);
  13. /**
  14.  * Set a new timeout.
  15.  * this method has the same behavior as window.setTimeout(), except it uses
  16.  * engine's timeline.
  17.  * @method module:time.set_timeout
  18.  * @param {timeout_callback} callback Timeout callback
  19.  * @param {number} time Timeout
  20.  * @returns {number} Timeout ID
  21.  */
  22. exports.set_timeout = m_time.set_timeout;
  24. /**
  25.  * Clear the timeout.
  26.  * @method module:time.clear_timeout
  27.  * @param {number} id Timeout ID
  28.  */
  29. exports.clear_timeout = m_time.clear_timeout;
  31. /**
  32.  * Get the engine's timeline (number of seconds after engine's initialization).
  33.  * @method module:time.get_timeline
  34.  * @returns {number} Timeline
  35.  */
  36. exports.get_timeline = m_time.get_timeline;
  38. /**
  39.  * Animate value.
  40.  * @method module:time.animate
  41.  * @param {number} from Value to animate from 
  42.  * @param {number} to Value to animate to
  43.  * @param {number} timeout Period of time to animate the value
  44.  * @param {anim_callback} anim_cb Animation callback
  45.  * @returns {number} Animator ID
  46.  */
  47. exports.animate = m_time.animate;
  49. /**
  50.  * Clear the animation.
  51.  * @method module:time.clear_animation
  52.  * @param {number} id Animator ID
  53.  */
  54. exports.clear_animation = m_time.clear_animation;
  57. }
  59. var time_factory = register("time", Time);
  61. export default time_factory;