Source: extern/anchors.js

  1. import register from "../util/register.js";
  3. import m_anchors_fact from "../intern/anchors.js";
  5. /**
  6.  * Anchors are Empty objects assigned in Blender.
  7.  * They are used to project 3D points or HTML elements to the 2D screen.
  8.  * <p>For more info about anchor configuration check out the {@link https://www.blend4web.com/doc/en/objects.html#anchor-settings|user manual}.
  9.  * @module anchors
  10.  * @local AnchorMoveCallback
  11.  */
  12. function Anchors(ns, exports) {
  14. var m_anchors = m_anchors_fact(ns);
  16. /**
  17.  * The callback for the movement of the anchor.
  18.  * @callback AnchorMoveCallback
  19.  * @param {number} x X (left) canvas coordinate.
  20.  * @param {number} y Y (top) canvas coordinate.
  21.  * @param {string} appearance Anchor appearance, one of "visible", "out",
  22.  * "covered"
  23.  * @param {Object3D} obj Anchor object.
  24.  * @param {?HTMLElement} anchor Anchor HTML element
  25.  */
  27. /**
  28.  * Attach the movement callback to the anchor object.
  29.  * @method module:anchors.attach_move_cb
  30.  * @param {Object3D} obj Anchor object.
  31.  * @param {AnchorMoveCallback} anchor_move_cb Anchor movement callback
  32.  */
  33. exports.attach_move_cb = m_anchors.attach_move_cb;
  35. /**
  36.  * Detach the movement callback from the anchor object.
  37.  * @method module:anchors.detach_move_cb
  38.  * @param {Object3D} obj Anchor object.
  39.  */
  40. exports.detach_move_cb = m_anchors.detach_move_cb;
  42. /**
  43.  * Check if the given object is an anchor.
  44.  * @method module:anchors.is_anchor
  45.  * @param {Object3D} obj Anchor object.
  46.  * @returns {boolean} Check result.
  47.  */
  48. exports.is_anchor = m_anchors.is_anchor;
  50. /**
  51.  * Get anchor element ID.
  52.  * @method module:anchors.get_element_id
  53.  * @param {Object3D} obj Anchor object.
  54.  * @returns {string|boolean} Element ID or FALSE if the given object is not a 
  55.  * valid anchor.
  56.  */
  57. exports.get_element_id = m_anchors.get_element_id;
  59. /**
  60.  * Force update positions of anchors.
  61.  * @method module:anchors.update
  62.  */
  63. exports.update = function() {
  64.     m_anchors.update(true);
  65. }
  67. }
  69. var anchors_factory = register("anchors", Anchors);
  71. export default anchors_factory;