Source: extern/objects.js

  1. import register from "../util/register.js";
  3. import m_geom_fact from "../intern/geometry.js";
  4. import m_obj_fact from "../intern/objects.js";
  5. import m_batch_fact from "../intern/batch.js";
  6. import m_obj_util_fact from "../intern/obj_util.js";
  7. import m_print_fact from "../intern/print.js";
  8. import m_scenes_fact from "../intern/scenes.js";
  9. import * as m_util from "../intern/util.js";
  11. /**
  12.  * Objects API.
  13.  * <p>Additional topics in the User Manual: {@link
  14.  * https://www.blend4web.com/doc/en/objects.html#object-transform-api|Object Transform API}, 
  15.  * {@link https://www.blend4web.com/doc/en/objects.html#get-object-api|Get
  16.  * Object API}, {@link
  17.  * https://www.blend4web.com/doc/en/objects.html#object-selection|Object
  18.  * Selection}, {@link
  19.  * https://www.blend4web.com/doc/en/objects.html#copying-objects-instancing|Copying
  20.  * Objects (Instancing)}
  21.  * @module objects
  22.  * @local ObjectMetaTags
  23.  * @local WindBendingParams
  24.  */
  25. function Objects(ns, exports) {
  27. var m_geom     = m_geom_fact(ns);
  28. var m_obj      = m_obj_fact(ns);
  29. var m_batch    = m_batch_fact(ns);
  30. var m_obj_util = m_obj_util_fact(ns);
  31. var m_print    = m_print_fact(ns);
  32. var m_scenes   = m_scenes_fact(ns);
  34. /**
  35.  * @typedef {Object} ObjectMetaTags
  36.  * @property {string} title The title meta tag.
  37.  * @property {string} description The description meta tag.
  38.  * @property {string} category The category meta tag.
  39.  */
  41. /**
  42.  * Wind bending params.
  43.  * @typedef {Object} WindBendingParams
  44.  * @property {number} angle Angle of main wind bending in degrees
  45.  * @property {number} main_frequency Frequency of main wind bending
  46.  * @property {number} detail_frequency Frequency of detail wind bending
  47.  * @property {number} detail_amplitude Amplitude of detail wind bending
  48.  * @property {number} branch_amplitude Amplitude of branches wind bending
  49.  * @cc_externs angle main_frequency detail_frequency
  50.  * @cc_externs detail_amplitude branch_amplitude
  51.  */
  53. /**
  54.  * Get the Blender-assigned meta tags from the object.
  55.  * @method module:objects.get_meta_tags
  56.  * @param {Object3D} obj Object 3D
  57.  * @returns {ObjectMetaTags} Object meta tags
  58.  * @cc_externs title description category
  59.  */
  60. exports.get_meta_tags = function(obj) {
  61.     if (obj)
  62.         return m_obj.get_meta_tags(obj);
  63. }
  65. /**
  66.  * Get the Blender-assigned custom property field from the object.
  67.  * @method module:objects.get_custom_prop
  68.  * @param {Object3D} obj Object 3D
  69.  * @returns {*} Object custom property field
  70.  */
  71. exports.get_custom_prop = function(obj) {
  72.     if (obj)
  73.         return m_obj.get_custom_prop(obj);
  74. }
  75. /**
  76.  * Copy MESH object.
  77.  * @method module:objects.copy
  78.  * @param {Object3D} obj Object 3D
  79.  * @param {string} name New unique object name
  80.  * @param {boolean} [deep_copy=false] Copy WebGL buffers
  81.  * @returns {Object3D} New object.
  82.  */
  83. exports.copy = function(obj, name, deep_copy) {
  85.     if (!m_obj_util.is_mesh(obj)) {
  86.         m_print.error("object \"" + obj.name + "\" is not of type \"MESH\".");
  87.         return false;
  88.     }
  90.     if (!m_obj_util.is_dynamic(obj)) {
  91.         m_print.error("object \"" + obj.name + "\" is not dynamic.");
  92.         return false;
  93.     }
  94.     if (!(m_geom.has_dyn_geom(obj) || m_geom.check_shape_keys(obj)) && deep_copy) {
  95.         m_print.error("object \"" + obj.name + "\" has not dynamic " 
  96.                 + "geometry for deep copying.");
  97.         return false;
  98.     }
  99.     // HACK: a temporary (provisional) solution
  100.     var objs = m_obj.get_scene_objs(m_scenes.get_active(), "MESH", m_obj.DATA_ID_ALL);
  101.     if (objs.indexOf(obj) == - 1) {
  102.         m_print.error("object \"" + obj.name + "\" does not belong to the " 
  103.                 + "active scene.");
  104.         return false;
  105.     }
  106.     name = name || "";
  107.     return m_obj.copy(obj, name, deep_copy);
  108. }
  110. /**
  111.  * Update object's boundings (box, cone, cylinder, ellipsoid, sphere, capsule).
  112.  * @method module:objects.update_boundings
  113.  * @param {Object3D} obj Object 3D
  114.  */
  115. exports.update_boundings = function(obj) {
  117.     if (!m_obj_util.is_mesh(obj)) {
  118.         m_print.error("The type of the object \"" + obj.name +
  119.             "\" is not \"MESH\".");
  120.         return;
  121.     }
  123.     if (!(m_geom.has_dyn_geom(obj) || m_geom.check_shape_keys(obj))) {
  124.         m_print.error("object \"" + obj.name + "\" has not dynamic " 
  125.                 + "geometry.");
  126.         return;
  127.     }
  128.     m_obj.update_boundings(obj);
  129. }
  131. /**
  132.  * Get parent object.
  133.  * @method module:objects.get_parent
  134.  * @param {Object3D} obj Child object
  135.  * @returns {?Object3D} Parent object
  136.  */
  137. exports.get_parent = m_obj_util.get_parent;
  139. /**
  140.  * Get DupliGroup parent object.
  141.  * @method module:objects.get_dg_parent
  142.  * @param {Object3D} obj Child object
  143.  * @returns {?Object3D} Parent object
  144.  */
  145. exports.get_dg_parent = m_obj_util.get_dg_parent;
  147. /**
  148.  * Check if the object is a MESH.
  149.  * @method module:objects.is_mesh
  150.  * @param {Object3D} obj Object 3D
  151.  * @returns {boolean} Checking result.
  152.  */
  153. exports.is_mesh = m_obj_util.is_mesh;
  155. /**
  156.  * Check if the object is an ARMATURE.
  157.  * @method module:objects.is_armature
  158.  * @param {Object3D} obj Object 3D
  159.  * @returns {boolean} Checking result.
  160.  */
  161. exports.is_armature = m_obj_util.is_armature;
  163. /**
  164.  * Check if the object is a SPEAKER.
  165.  * @method module:objects.is_speaker
  166.  * @param {Object3D} obj Object 3D
  167.  * @returns {boolean} Checking result.
  168.  */
  169. exports.is_speaker = m_obj_util.is_speaker;
  171. /**
  172.  * Check if the object is a CAMERA.
  173.  * @method module:objects.is_camera
  174.  * @param {Object3D} obj Object 3D
  175.  * @returns {boolean} Checking result.
  176.  */
  177. exports.is_camera = m_obj_util.is_camera;
  179. /**
  180.  * Check if the object is a LAMP.
  181.  * @method module:objects.is_lamp
  182.  * @param {Object3D} obj Object 3D
  183.  * @returns {boolean} Checking result.
  184.  */
  185. exports.is_lamp = m_obj_util.is_lamp;
  187. /**
  188.  * Check if the object is an EMPTY.
  189.  * @method module:objects.is_empty
  190.  * @param {Object3D} obj Object 3D
  191.  * @returns {boolean} Checking result.
  192.  */
  193. exports.is_empty = m_obj_util.is_empty;
  195. /**
  196.  * Check if the object is a LINE.
  197.  * @method module:objects.is_line
  198.  * @param {Object3D} obj Object 3D
  199.  * @returns {boolean} Checking result.
  200.  */
  201. exports.is_line = m_obj_util.is_line;
  203. /**
  204.  * Check if the object is a WORLD.
  205.  * @method module:objects.is_world
  206.  * @param {Object3D} obj Object 3D
  207.  * @returns {boolean} Checking result.
  208.  */
  209. exports.is_world = m_obj_util.is_world;
  211. /**
  212.  * Get all scene selectable objects.
  213.  * @method module:objects.get_selectable_objects
  214.  * @returns {Object3D[]} Array with selectable objects.
  215.  */
  216. exports.get_selectable_objects = function() {
  218.     return m_obj.get_selectable_objects();
  219. }
  220. /**
  221.  * Get all scene outlining objects.
  222.  * @method module:objects.get_outlining_objects
  223.  * @returns {Object3D[]} Array with outlining objects.
  224.  */
  225. exports.get_outlining_objects = function() {
  227.     return m_obj.get_outlining_objects();
  228. }
  229. /**
  230.  * Check if object is dynamic.
  231.  * @method module:objects.is_dynamic
  232.  * @param {Object3D} obj Object 3D
  233.  * @returns {boolean} Checking result.
  234.  */
  235. exports.is_dynamic = m_obj_util.is_dynamic;
  237. /**
  238.  * Set object's wind bending parameters. Object must be dynamic.
  239.  * @param {Object3D} obj Object 3D
  240.  * @param {WindBendingParams} wb_params Wind Bending parameters
  241.  * @example
  242.  * var m_obj = require("objects");
  243.  * var wb_params =
  244.  * {
  245.  *     angle: 45,
  246.  *     main_frequency: 0.25,
  247.  *     detail_frequency: 1,
  248.  *     detail_amplitude: 0.1,
  249.  *     branch_amplitude: 0.3
  250.  * };
  251.  * m_obj.set_wind_bending_params(obj, wb_params);
  252.  */
  253. exports.set_wind_bending_params = function(obj, wb_params) {
  255.     if (!m_obj_util.is_dynamic_mesh(obj)) {
  256.         m_print.error("The type of the object \"" + obj.name +
  257.             "\" is not \"MESH\" or it is not dynamic.");
  258.         return;
  259.     }
  261.     var render = obj.render;
  262.     if (!render.wind_bending) {
  263.         m_print.error("The \"" + obj.name + "\" object " +
  264.             "doesn't have wind bending parameters.");
  265.         return;
  266.     }
  268.     if (typeof wb_params.angle == "number") {
  269.         var amp = m_batch.wb_angle_to_amp(m_util.deg_to_rad(wb_params.angle), 
  270.                 render.bb_original, render.world_tsr[3]);
  271.         render.wind_bending_amp = amp;
  272.     }
  274.     if (typeof wb_params.main_frequency == "number")
  275.         render.wind_bending_freq = wb_params.main_frequency;
  277.     if (typeof wb_params.detail_frequency == "number")
  278.         render.detail_bending_freq = wb_params.detail_frequency;
  280.     if (typeof wb_params.detail_amplitude == "number")
  281.         render.detail_bending_amp = wb_params.detail_amplitude;
  283.     if (typeof wb_params.branch_amplitude == "number")
  284.         render.branch_bending_amp = wb_params.branch_amplitude;
  286.     m_obj.set_hair_particles_wind_bend_params(obj);
  287. }
  289. /**
  290.  * Get object's wind bending parameters. Object must be dynamic.
  291.  * @param {Object3D} obj Object 3D
  292.  * @returns {WindBendingParams} Wind Bending parameters
  293.  */
  294. exports.get_wind_bending_params = function(obj) {
  296.     var render = obj.render;
  298.     if (!render.wind_bending)
  299.         return null;
  301.     var wb_params = {};
  303.     var angle = m_util.rad_to_deg(m_batch.wb_amp_to_angle(render.wind_bending_amp,
  304.             render.bb_original, render.world_tsr[3]));
  306.     wb_params.angle = angle;
  307.     wb_params.main_frequency = render.wind_bending_freq;
  308.     wb_params.detail_frequency = render.detail_bending_freq;
  309.     wb_params.detail_amplitude = render.detail_bending_amp;
  310.     wb_params.branch_amplitude = render.branch_bending_amp;
  312.     return wb_params;
  313. }
  315. /**
  316.  * Create line object
  317.  * @param {string} name Line object name
  318.  */
  319. exports.create_line = function(name) {
  320.     return m_obj.create_line(name);
  321. }
  323. /**
  324.  * Hide objects that have the given data_id.
  325.  * @param {number} data_id ID of loaded data.
  326.  * @example
  327.  * var m_obj = require("objects");
  328.  * m_obj.hide_all_by_data_id(0);
  329.  */
  330. exports.hide_all_by_data_id = function(data_id) {
  331.     var objs = m_obj.get_all_objects("ALL", data_id);
  332.     for (var i = 0; i < objs.length; i++)
  333.         m_scenes.change_visibility(objs[i], true);
  334. }
  336. /**
  337.  * Show objects that have the given data_id.
  338.  * @param {number} data_id ID of loaded data.
  339.  * @example
  340.  * var m_obj = require("objects");
  341.  * m_obj.show_all_by_data_id(1);
  342.  */
  343. exports.show_all_by_data_id = function(data_id) {
  344.     var objs = m_obj.get_all_objects("ALL", data_id);
  345.     for (var i = 0; i < objs.length; i++)
  346.         m_scenes.change_visibility(objs[i], false);
  347. }
  349. }
  351. var objects_factory = register("objects", Objects);
  353. export default objects_factory;