Source: extern/data.js

  1. import register from "../util/register.js";
  3. import m_data_fact from "../intern/data.js";
  4. import m_loader_fact from "../intern/loader.js";
  6. /**
  7.  * Data API. Used to load/unload exported JSON data files.
  8.  * @module data
  9.  * @local StageloadCallback
  10.  * @local LoadedCallback
  11.  */
  12. function Data(ns, exports) {
  14. /**
  15.  * Data loaded callback.
  16.  * Executed when the data loading process has been completed.
  17.  * @callback LoadedCallback
  18.  * @param {number} data_id Data ID
  19.  * @param {boolean} success Load success
  20.  */
  22. /**
  23.  * Loading stage callback.
  24.  * Used to implement loading progress indicators (preloaders).
  25.  * @callback StageloadCallback
  26.  * @param {number} percentage Loading progress (0-100).
  27.  * @param {number} load_time Loading time in ms.
  28.  * @param {number} data_id Data ID
  29.  */
  31. var m_data   = m_data_fact(ns);
  32. var m_loader = m_loader_fact(ns);
  34. /**
  35.  * Load data from the json file exported from Blender.
  36.  * @method module:data.load
  37.  * @param {string} path Path to JSON file
  38.  * @param {LoadedCallback} [loaded_cb=null] Callback to be executed right after load
  39.  * @param {StageloadCallback} [stageload_cb=null] Callback to report about the loading progress
  40.  * @param {boolean} [wait_complete_loading=false] Wait until all resources are loaded
  41.  * @param {boolean} [load_hidden=false] Hide loaded and disable physics objects
  42.  * @returns {number} ID of loaded data.
  43.  */
  44. exports.load = m_data.load;
  46. /**
  47.  * Unload the previously loaded data.
  48.  * @method module:data.unload
  49.  * @param {number} [data_id=0] ID of unloaded data. Unload all data if data_id is zero.
  50.  */
  51. exports.unload = function(data_id) {
  52.     data_id = data_id | 0;
  53.     m_data.unload(data_id);
  54. }
  57. /**
  58.  * Set the root which contains the resources, for debug purposes. 
  59.  * Enables the checking of loading paths, so if the resources are not loaded from 
  60.  * the app root, there will be a warning in m_print.
  61.  * @method module:data.set_debug_resources_root
  62.  * @param {string} debug_resources_root App root directory.
  63.  */
  64. exports.set_debug_resources_root = m_data.set_debug_resources_root;
  66. /**
  67.  * Check if the engine primary data (main scene) is loaded (detect the last loading stage).
  68.  * @method module:data.is_primary_loaded
  69.  * @returns {boolean} Check result
  70.  */
  71. exports.is_primary_loaded = m_data.is_primary_loaded;
  73. /**
  74.  * Check if the engine has finished all of the scheduled loading actions.
  75.  * @method module:data.is_idle
  76.  * @returns {boolean} Check result
  77.  */
  78. exports.is_idle = m_loader.is_finished;
  80. exports.load_and_add_new = m_data.load;
  82. exports.cleanup = exports.unload;
  83. /**
  84.  * Activate media data context.
  85.  * Activation of audio/video contexts is required for mobile platforms which
  86.  * disable media playback without explicit user interaction. This method
  87.  * should be executed inside some input event listener.
  88.  * @method module:data.activate_media
  89.  */
  90. exports.activate_media = m_data.activate_media;
  91. /**
  92.  * Preload scene's resources and put them into cache.
  93.  * @param {string} path Path to JSON file
  94.  * @param {LoadedCallback} [loaded_cb=null] Callback to be executed right after load
  95.  * @param {StageloadCallback} [stageload_cb=null] Callback to report about the loading progress
  96.  * @method module:data.prefetch
  97.  */
  98. exports.prefetch = m_data.prefetch;
  99. /**
  100.  * Clear loading cache.
  101.  * @method module:data.unfetch
  102.  */
  103. exports.unfetch = m_data.unfetch;
  105. }
  107. var data_factory = register("data", Data);
  109. export default data_factory;