Source: util/b4w.js

  1. /**
  2.  * Object in 3D space.
  3.  * You should always use the engine's API in order to manipulate your 3D object.
  4.  * Never access it directly by it's properties.
  5.  * @typedef {Object} Object3D
  6.  */
  8. /**
  9.  * Sensor object.
  10.  * @typedef {Object} Sensor
  11.  * @see {@link module:controls}
  12.  */
  14. /**
  15.  * Typed two-dimensional vector.
  16.  * @typedef {Float32Array} Vec2
  17.  */
  19. /**
  20.  * Typed three-dimensional vector. Can be created with {@link module:vec3.create}.
  21.  * @typedef {Float32Array} Vec3
  22.  */
  24. /**
  25.  * Constant value matching character state (flying, walking etc).
  26.  * @typedef {number} CharacterState
  27.  */
  29. /**
  30.  * Line set in parametric form
  31.  * @typedef {Float32Array(6)} ParametricLine
  32.  */
  34. /**
  35.  * Typed four-dimensional vector. Can be created with {@link module:vec4.create}.
  36.  * @typedef {Float32Array} Vec4
  37.  */
  39. /**
  40.  * Quaternion vector representing rotation.
  41.  * Quaternion is a four-dimensional vector which has the following format:
  42.  * [X, Y, Z, W]. Can be created with {@link module:quat.create}.
  43.  * @typedef {Float32Array} Quat
  44.  */
  46. /**
  47.  * Euler vector representing rotation (in radians).
  48.  * <!--
  49.  * <p>The euler angles specified in intrinsic form (rotating space) and have the following meaning:
  50.  * <ul>
  51.  * TODO: check it!!!
  52.  * <li>euler[0]: heading, around Y
  53.  * <li>euler[1]: attitude, around new Z
  54.  * <li>euler[2]: bank, around new X
  55.  * </ul>
  56.  * -->
  57.  * <p>Using euler angles is discouraged, use quaternions instead.
  58.  * @typedef {Float32Array} Euler
  59.  */
  61. /**
  62.  * TSR vector representing 3D object's transformations (Translation, Scale, Rotation).
  63.  * TSR is an eight-dimensional vector which has the following format:
  64.  * [X, Y, Z, SCALE, QUAT_X, QUAT_Y, QUAT_Z, QUAT_W].
  65.  * Can be created with {@link module:tsr.create}.
  66.  * @typedef {Float32Array} TSR
  67.  */
  69. /**
  70.  * 3x3 matrix.
  71.  * The elements of matrix are placed in typed array in column-major order.
  72.  * Can be created with {@link module:mat3.create}.
  73.  * @typedef {Float32Array} Mat3
  74.  */
  76. /**
  77.  * 4x4 matrix.
  78.  * The elements of matrix are placed in typed array in column-major order.
  79.  * Can be created with {@link module:mat4.create}.
  80.  * @typedef {Float32Array} Mat4
  81.  */
  83. /**
  84.  * Typed three-dimensional vector representing color.
  85.  * Each component must be in range 0-1.
  86.  * Can be created with {@link module:rgb.create}.
  87.  * @typedef {Float32Array} RGB
  88.  */
  90. /**
  91.  * Typed four-dimensional vector representing color and alpha.
  92.  * Each component must be in range 0-1.
  93.  * Can be created with {@link module:rgba.create}.
  94.  * @typedef {Float32Array} RGBA
  95.  */
  97. /**
  98.  * The JavaScript Date object.
  99.  * @typedef {Object} Date
  100.  */
  102. /**
  103.  * Camera movement style enum. One of MS_*.
  104.  * @typedef {number} CameraMoveStyle
  105.  * @see {@link module:camera}
  106.  */
  108. /**
  109.  * Generic callback function with no parameters.
  110.  * @callback GenericCallback
  111.  */
  113. /**
  114.  * Blend4Web global object.
  115.  * @namespace
  116.  * @suppress {duplicate}
  117.  */
  119. // HACK: get b4w from global object
  120. var b4w;
  121. var is_worker = false;
  122. try {
  123.     b4w = window.b4w;
  124. } catch (e) {
  125.     b4w = self.b4w;
  126.     is_worker = true
  127. }
  129. if (!b4w) {
  131.     var b4w = {};
  132.     // TODO elaborate b4w access from the console
  133.     var DEBUG = true;
  134.     if (DEBUG) {
  135.         if (is_worker) {
  136.             self.b4w = b4w;
  137.         } else {
  138.             window.b4w = b4w;
  139.         }
  140.     }
  142.     var _module = {};
  143.     var _n_module = {};
  145.     b4w.module = _module;
  146.     b4w._n_module = _n_module;
  148.     // require functions per namespace
  149.     var _ns_requires = {};
  151.     b4w.cleanup = function (module_id, ns) {
  152.         ns = ns || "__b4w_default";
  153.         var mod = _module[module_id];
  154.         if (mod)
  155.             mod._compiled = null;
  156.         _ns_requires[ns] = null;
  157.     }
  158.     /**
  159.      * Local (module internal) require function.
  160.      * This function is passed to the module implementation function and can be used
  161.      * to import additional modules from the same namespace. If you need to import
  162.      * a module from the different namespace use {@link b4w.require}.
  163.      * @typedef {Function} b4w~RequireFunction
  164.      * @param {string} module_id Module ID
  165.      */
  167.     /**
  168.      * Module implementation function.
  169.      * @callback b4w~ModuleFunction
  170.      * @param {Object} exports Object with exported symbols
  171.      * @param {b4w~RequireFunction} require Local (module internal) require function
  172.      */
  174.     /**
  175.      * Register the module.
  176.      * @method b4w.register
  177.      * @param {string} module_id Module ID
  178.      * @param {b4w~ModuleFunction} fun Function implementing the module
  179.      */
  180.     b4w.register = function (module_id, fun) {
  181.         if (_module[module_id])
  182.             return;
  183.         //throw new Error("Module \"" + module_id + "\" already registered");
  185.         _module[module_id] = fun;
  186.     }
  188.     /**
  189.      * Prepare and return the registered module.
  190.      * @method b4w.require
  191.      * @param {string} module_id Module ID
  192.      * @param {string} [ns="__b4w_default"] Namespace for processed modules
  193.      * @returns {Object3D} Module object
  194.      */
  195.     b4w.require = function (module_id, ns) {
  196.         if (!_module[module_id] && !_n_module[module_id])
  197.             throw new Error("Module \"" + module_id + "\" not found");
  199.         ns = ns || "__b4w_default";
  200.         if (_n_module[module_id] !== undefined) {
  201.             return _n_module[module_id](ns);
  202.         } else if (!_ns_requires[ns]) {
  203.             _ns_requires[ns] = (function (ns) {
  204.                 return function (module_id) {
  205.                     if (!_module[module_id] && !_n_module[module_id]) {
  206.                         throw new Error("Module \"" + module_id + "\" not found");
  207.                     }
  209.                     if (_n_module[module_id] !== undefined) {
  210.                         return _n_module[module_id](ns);
  211.                     }
  213.                     var mod = _module[module_id];
  215.                     if (!mod._compiled)
  216.                         mod._compiled = {};
  218.                     if (!mod._compiled[ns]) {
  219.                         mod._compiled[ns] = {};
  220.                         mod(mod._compiled[ns], _ns_requires[ns]);
  221.                     }
  222.                     return mod._compiled[ns];
  223.                 }
  224.             })(ns);
  225.         }
  227.         return _ns_requires[ns](module_id);
  228.     }
  230.     /**
  231.      * Check if the module was registered.
  232.      * @method b4w.module_check
  233.      * @param {string} module_id Module ID
  234.      * @returns {boolean} Check result
  235.      */
  236.     b4w.module_check = function (module_id) {
  237.         return _module[module_id] !== undefined ||
  238.             _n_module[module_id] !== undefined;
  239.     }
  241.     /**
  242.      * Get a namespace of the current module by it's require function.
  243.      * @method b4w.get_namespace
  244.      * @param {b4w~RequireFunction} mod_ns_require Local require function
  245.      * @returns {string} Namespace.
  246.      */
  247.     b4w.get_namespace = function (mod_ns_require) {
  248.         // TODO: fix for ES6 modules
  249.         for (var ns in _ns_requires)
  250.             if (_ns_requires[ns] == mod_ns_require)
  251.                 return ns;
  252.         return "";
  253.     }
  255.     /**
  256.      * Global vars for proper worker fallback operations.
  257.      * @ignore
  258.      */
  259.     b4w.worker_listeners = [];
  260.     b4w.worker_namespaces = [];
  261. }
  263. export default b4w;