Source: extern/assets.js

  1. import register from "../util/register.js";
  3. import m_assets_fact from "../intern/assets.js";
  5. /** 
  6.  * Low-level resource loader. In order to load exported scenes, use the {@link module:data|data} module instead.
  7.  * @module assets
  8.  * @local AssetRequest
  9.  * @local AssetType
  10.  * @local AssetCallback
  11.  * @local ProgressCallback
  12.  * @local PackCallback
  13.  */
  14. function Assets(ns, exports) {
  16. var m_assets = m_assets_fact(ns);
  18. /**
  19.  * An object that defines how the asset resource should be loaded.
  20.  * @typedef {Object} AssetRequest
  21.  * @property {*} id Asset identifier. Passed to the 
  22.  * {@link AssetCallback|AssetCallback} as a parameter. Can be unique to  
  23.  * distinguish asset requests if needed.
  24.  * @property {AssetType} type Asset type.
  25.  * @property {string} url URL of a resource.
  26.  * @property {string} [request_method="GET"] Request method. Supported are "GET" and "POST".
  27.  * @property {Object} [overwrite_header] An object containing fields for 
  28.  * overwriting request headers. For example: { "Content-Type": "image/png" }.
  29.  * @property {*} [post_data] The request body that will be sent in a "POST" request. 
  30.  * @property {*} [param] An optional parameter that will be passed to the 
  31.  * {@link AssetCallback|AssetCallback}.
  32.  * @cc_externs id type url request_method overwrite_header post_data param
  33.  */
  35. /**
  36.  * Asset type. Defines which type of data will be loaded, e.g: json, plain text,
  37.  * binary buffer, ...
  38.  * @typedef {number} AssetType
  39.  * @see {@link module:assets.AT_ARRAYBUFFER|AT_ARRAYBUFFER},
  40.  * {@link module:assets.AT_ARRAYBUFFER_ZIP|AT_ARRAYBUFFER_ZIP},
  41.  * {@link module:assets.AT_JSON|AT_JSON},
  42.  * {@link module:assets.AT_JSON_ZIP|AT_JSON_ZIP},
  43.  * {@link module:assets.AT_TEXT|AT_TEXT},
  44.  * {@link module:assets.AT_AUDIOBUFFER|AT_AUDIOBUFFER},
  45.  * {@link module:assets.AT_IMAGE_ELEMENT|AT_IMAGE_ELEMENT},
  46.  * {@link module:assets.AT_AUDIO_ELEMENT|AT_AUDIO_ELEMENT},
  47.  * {@link module:assets.AT_VIDEO_ELEMENT|AT_VIDEO_ELEMENT},
  48.  * {@link module:assets.AT_SEQ_VIDEO_ELEMENT|AT_SEQ_VIDEO_ELEMENT},
  49.  */
  51. /**
  52.  * Callback executed after a single asset is loaded.
  53.  * @callback AssetCallback
  54.  * @param {Data} data Loaded data.
  55.  * @param {*} id Data asset ID.
  56.  * @param {AssetType} type Data type.
  57.  * @param {string} url URL of a resource.
  58.  * @param {*} [opt_param] Optional parameter
  59.  */
  61. /**
  62.  * Callback executed after the whole pack of assets is loaded.
  63.  * @callback PackCallback
  64.  */
  66. /**
  67.  * Callback for the progress of loading.
  68.  * @callback ProgressCallback
  69.  * @param {number} rate Amount of loaded data: 0 to 1.
  70.  */
  72. /**
  73.  * Asset type intended for loading various binary data. The loaded data will be 
  74.  * available as an ArrayBuffer object. Supported request methods: "GET".
  75.  * @const {AssetType} module:assets.AT_ARRAYBUFFER
  76.  */
  77. exports.AT_ARRAYBUFFER = m_assets.AT_ARRAYBUFFER;
  79. /**
  80.  * Asset type intended for loading compressed binary data of a GZIP format. The 
  81.  * loaded data will be available as an ArrayBuffer object. Supported request 
  82.  * methods: "GET".
  83.  * @const {AssetType} module:assets.AT_ARRAYBUFFER_ZIP
  84.  */
  85. exports.AT_ARRAYBUFFER_ZIP = m_assets.AT_ARRAYBUFFER_ZIP;
  87. /**
  88.  * Asset type intended for loading JSON files. The loaded data will be available 
  89.  * as a JSON object. Supported request methods: "GET", "POST".
  90.  * @const {AssetType} module:assets.AT_JSON
  91.  */
  92. exports.AT_JSON = m_assets.AT_JSON;
  94. /**
  95.  * Asset type intended for loading JSON files compressed in a GZIP format. The 
  96.  * loaded data will be available as a JSON object. Supported request methods: 
  97.  * "GET".
  98.  * @const {AssetType} module:assets.AT_JSON_ZIP
  99.  */
  100. exports.AT_JSON_ZIP = m_assets.AT_JSON_ZIP;
  102. /**
  103.  * Asset type intended for loading files with a plain text. The loaded data will
  104.  * be available as a String object. Supported request methods: "GET", "POST".
  105.  * @const {AssetType} module:assets.AT_TEXT
  106.  */
  107. exports.AT_TEXT = m_assets.AT_TEXT;
  109. /**
  110.  * Asset type intended for loading audio files (preferably short audio assets). 
  111.  * The loaded data will be available as an AudioBuffer object. Supported request 
  112.  * methods: "GET".
  113.  * @const {AssetType} module:assets.AT_AUDIOBUFFER
  114.  */
  115. exports.AT_AUDIOBUFFER = m_assets.AT_AUDIOBUFFER;
  117. /**
  118.  * Asset type intended for loading common image files (JPEG, PNG, GIF). The 
  119.  * loaded data will be available as an HTMLImageElement object. Supported 
  120.  * request methods: "GET".
  121.  * @const {AssetType} module:assets.AT_IMAGE_ELEMENT
  122.  */
  123. exports.AT_IMAGE_ELEMENT = m_assets.AT_IMAGE_ELEMENT;
  125. /**
  126.  * Asset type intended for loading common audio files. The loaded data will be 
  127.  * available as an HTMLAudioElement object. Supported request methods: "GET".
  128.  * @const {AssetType} module:assets.AT_AUDIO_ELEMENT
  129.  */
  130. exports.AT_AUDIO_ELEMENT = m_assets.AT_AUDIO_ELEMENT;
  132. /**
  133.  * Asset type intended for loading common video files. The loaded data will be 
  134.  * available as an HTMLVideoElement object. Supported request methods: "GET".
  135.  * @const {AssetType} module:assets.AT_VIDEO_ELEMENT
  136.  */
  137. exports.AT_VIDEO_ELEMENT = m_assets.AT_VIDEO_ELEMENT;
  139. /**
  140.  * Asset type intended for loading video files of a special ".seq" format. The 
  141.  * loaded data will be available as an object of the following structure:
  142.  * { images: [HTMLImageElement, ...], fps: number }. Supported request methods: 
  143.  * "GET".
  144.  * @see https://www.blend4web.com/doc/en/developers.html#seq-video-format
  145.  * @const {AssetType} module:assets.AT_SEQ_VIDEO_ELEMENT
  146.  */
  147. exports.AT_SEQ_VIDEO_ELEMENT = m_assets.AT_SEQ_VIDEO_ELEMENT;
  150. /**
  151.  * Add the assets to the loading queue.
  152.  * @method module:assets.enqueue
  153.  * @param {AssetRequest[]} assets_pack Array of the asset requests.
  154.  * @param {AssetCallback} [asset_cb] Callback executed after a single asset is loaded
  155.  * @param {PackCallback} [pack_cb] Callback executed after the whole pack of assets is loaded
  156.  * @param {ProgressCallback} [progress_cb] Callback for the progress of loading.
  157.  * @example var m_assets = require("assets");
  158.  *
  159.  * var asset_cb = function(data, id, type, url) {
  160.  *      console.log("LOADED:", url);
  161.  * }
  162.  * 
  163.  * var pack_cb() {
  164.  *      console.log("ALL DATA LOADED!");
  165.  * }
  166.  *
  167.  * var progress_cb = function(rate) {
  168.  *      console.log(rate * 100 + "% LOADED");
  169.  * }
  170.  *
  171.  * m_assets.enqueue([
  172.  *      {id: "my_json001", type: m_assets.AT_JSON, url: "./my_json.json"}, 
  173.  *      {id: "my_img001", type: m_assets.AT_IMAGE_ELEMENT, url: "./my_image.jpg"}
  174.  *      ], asset_cb, pack_cb, progress_cb);
  175.  */
  176. exports.enqueue = function(assets_pack, asset_cb, pack_cb, progress_cb) {
  177.     if (assets_pack.length)
  178.         m_assets.enqueue(assets_pack, asset_cb, pack_cb, progress_cb);
  179. }
  181. }
  183. var assets_factory = register("assets", Assets);
  185. export default assets_factory;