Source: extern/controls.js

  1. import register from "../util/register.js";
  3. import m_ctl_fact from "../intern/controls.js";
  4. import m_phy_fact from "../intern/physics.js";
  5. import m_print_fact from "../intern/print.js";
  7. /**
  8.  * Implements the event-driven model of Blend4Web.
  9.  *
  10.  * <dl>
  11.  * <dt>Sensor</dt>
  12.  *
  13.  * <dd>Sensor is a programming entity intended for detecting events occurred in
  14.  * the scene. Some sensors may carry a payload. For example the
  15.  * ray-tracing sensor (Ray Sensor)
  16.  * provides the relative length of the intersection ray.</dd>
  17.  *
  18.  * <dt>Sensor Manifold (or simply manifold)</dt>
  19.  *
  20.  * <dd>Sensors should be present in one or multiple collections - so called
  21.  * sensor manifolds. A manifold is a logic container associated with a scene
  22.  * object. It generates a response (pulse) to a defined set of sensor events by
  23.  * executing a callback function.</dd>
  24.  * </dl>
  25.  *
  26.  * <p>In order to use the input-output sensors, register the corresponding event
  27.  * listeners by using register_* methods.</p>
  28.  *
  29.  * @see https://www.blend4web.com/doc/en/developers.html#event-model
  30.  *
  31.  * @module controls
  32.  * @local ManifoldCallback
  33.  * @local ManifoldLogicFunction
  34.  * @local CollisionPayload
  35.  * @local RayPayload
  36.  * @local SensorCallback
  37.  */
  38. function Controls(ns, exports) {
  40. var m_ctl   = m_ctl_fact(ns);
  41. var m_phy   = m_phy_fact(ns);
  42. var m_print = m_print_fact(ns);
  44. /**
  45.  * Manifold's callback. It is executed when the manifold generates a pulse.
  46.  * @callback ManifoldCallback
  47.  * @param {?Object3D} obj Object 3D, or null to denote the global object
  48.  * @param {string} id Manifold ID
  49.  * @param {number} pulse Additional callback condition for CT_TRIGGER or
  50.  * CT_CONTINUOUS manifolds: +1 or -1
  51.  * @param {*} [param] Callback parameter. The user-defined parameter which is
  52.  * passed to create_sensor_manifold(). Can be used, for example, as a storage
  53.  * object to communicate between different manifolds.
  54.  */
  55. /**
  56.  * Manifold's logic function. Specifies a logic expression which consists of
  57.  * sensor values. This logic expression will be evaluated every frame. As a
  58.  * result, the manifold changes its internal state and fires the callback.
  59.  * @callback ManifoldLogicFunction
  60.  * @param {Array} s Numeric array with sensor values.
  61.  * @returns {number} Result of evaluation of the logic expression
  62.  */
  63. /**
  64.  * Collision sensor payload.
  65.  * @callback CollisionPayload
  66.  * @param {?Object3D} coll_obj The target collision object, i.e the object
  67.  * the source object collides with (null for no collision or when this object
  68.  * is represented by collision material).
  69.  * @param {?Vec3} coll_pos Position of collision point.
  70.  * @param {?Vec3} coll_norm Normal of collision point.
  71.  * @param {?number} coll_dist Distance between collision points of colliding
  72.  * objects.
  73.  * @cc_externs coll_obj coll_pos coll_norm coll_dist
  74.  */
  75. /**
  76.  * Ray sensor payload.
  77.  * @callback RayPayload
  78.  * @param {number} hit_fract Fraction of ray length where hit has occurred (0-1)
  79.  * or -1 if there is no hit anymore.
  80.  * @param {?Object3D} obj_hit The hit object.
  81.  * @param {number} hit_time Time the hit happened.
  82.  * @param {Vec3} hit_pos Hit position in world space.
  83.  * @param {Vec3} hit_norm Hit normal in world space.
  84.  * @cc_externs hit_fract obj_hit hit_time hit_pos hit_norm
  85.  */
  86. /**
  87.  * Special callback for callback-sensor. It's executed every frame and
  88.  * its return value is copied into the sensor value. Should return a numeric value.
  89.  * @callback SensorCallback
  90.  */
  92. /**
  93.  * Manifold control type: positive.
  94.  * Such manifold executes the callback each frame when the result of
  95.  * evaluation of its logic function is positive.
  96.  * @const module:controls.CT_POSITIVE
  97.  */
  98. exports.CT_POSITIVE = m_ctl.CT_POSITIVE;
  100. /**
  101.  * Manifold control type: continuous.
  102.  * Such manifold executes the callback with a positive pulse (+1) each frame
  103.  * when the result of evaluation of its logic function is non-zero.
  104.  * It executes a callback with a negative pulse (-1) once the logic function
  105.  * evaluates to zero.
  106.  * @const module:controls.CT_CONTINUOUS
  107.  */
  108. exports.CT_CONTINUOUS = m_ctl.CT_CONTINUOUS;
  110. /**
  111.  * Manifold control type: trigger.
  112.  * Such manifold executes the callback with a single positive pulse (+1) once the result of
  113.  * evaluation of its logic function is non-zero.
  114.  * It executes a callback with a single negative pulse (-1) once the logic function
  115.  * evaluates to zero.
  116.  * @const module:controls.CT_TRIGGER
  117.  */
  118. exports.CT_TRIGGER = m_ctl.CT_TRIGGER;
  120. /**
  121.  * Manifold control type: shot.
  122.  * Such manifold executes the callback once the result of evaluation of its
  123.  * logic function becomes a non-zero value.
  124.  * @const module:controls.CT_SHOT
  125.  */
  126. exports.CT_SHOT = m_ctl.CT_SHOT;
  128. /**
  129.  * Manifold control type: level.
  130.  * Such manifold executes the callback each time the result of
  131.  * evaluation of its logic function is changed.
  132.  * @const module:controls.CT_LEVEL
  133.  */
  134. exports.CT_LEVEL = m_ctl.CT_LEVEL;
  136. /**
  137.  * Manifold control type: change.
  138.  * Such manifold executes the callback each time the value
  139.  * of any sensor is changed. The logic function is ignored.
  140.  * @const module:controls.CT_CHANGE
  141.  */
  142. exports.CT_CHANGE = m_ctl.CT_CHANGE;
  144. /**
  145.  * Keyboard sensor parameter. Corresponds to keyCode property of KeyboardEvent.
  146.  * @const module:controls.KEY_BACKSPACE
  147.  */
  148. exports.KEY_BACKSPACE   = 8;
  150. /**
  151.  * Keyboard sensor parameter. Corresponds to keyCode property of KeyboardEvent.
  152.  * @const module:controls.KEY_TAB
  153.  */
  154. exports.KEY_TAB         = 9;
  156. /**
  157.  * Keyboard sensor parameter. Corresponds to keyCode property of KeyboardEvent.
  158.  * @const module:controls.KEY_ENTER
  159.  */
  160. exports.KEY_ENTER       = 13;
  162. /**
  163.  * Keyboard sensor parameter. Corresponds to keyCode property of KeyboardEvent.
  164.  * @const module:controls.KEY_SHIFT
  165.  */
  166. exports.KEY_SHIFT       = 16;
  168. /**
  169.  * Keyboard sensor parameter. Corresponds to keyCode property of KeyboardEvent.
  170.  * @const module:controls.KEY_CTRL
  171.  */
  172. exports.KEY_CTRL        = 17;
  174. /**
  175.  * Keyboard sensor parameter. Corresponds to keyCode property of KeyboardEvent.
  176.  * @const module:controls.KEY_ALT
  177.  */
  178. exports.KEY_ALT         = 18;
  180. /**
  181.  * Keyboard sensor parameter. Corresponds to keyCode property of KeyboardEvent.
  182.  * @const module:controls.KEY_PAUSE
  183.  */
  184. exports.KEY_PAUSE       = 19;
  186. /**
  187.  * Keyboard sensor parameter. Corresponds to keyCode property of KeyboardEvent.
  188.  * @const module:controls.KEY_CAPSLOCK
  189.  */
  190. exports.KEY_CAPSLOCK    = 20;
  192. /**
  193.  * Keyboard sensor parameter. Corresponds to keyCode property of KeyboardEvent.
  194.  * @const module:controls.KEY_ESC
  195.  */
  196. exports.KEY_ESC         = 27;
  198. /**
  199.  * Keyboard sensor parameter. Corresponds to keyCode property of KeyboardEvent.
  200.  * @const module:controls.KEY_SPACE
  201.  */
  202. exports.KEY_SPACE       = 32;
  204. /**
  205.  * Keyboard sensor parameter. Corresponds to keyCode property of KeyboardEvent.
  206.  * @const module:controls.KEY_LEFT
  207.  */
  208. exports.KEY_LEFT        = 37;
  210. /**
  211.  * Keyboard sensor parameter. Corresponds to keyCode property of KeyboardEvent.
  212.  * @const module:controls.KEY_UP
  213.  */
  214. exports.KEY_UP          = 38;
  216. /**
  217.  * Keyboard sensor parameter. Corresponds to keyCode property of KeyboardEvent.
  218.  * @const module:controls.KEY_RIGHT
  219.  */
  220. exports.KEY_RIGHT       = 39;
  222. /**
  223.  * Keyboard sensor parameter. Corresponds to keyCode property of KeyboardEvent.
  224.  * @const module:controls.KEY_DOWN
  225.  */
  226. exports.KEY_DOWN        = 40;
  228. /**
  229.  * Keyboard sensor parameter. Corresponds to keyCode property of KeyboardEvent.
  230.  * @const module:controls.KEY_1
  231.  */
  232. exports.KEY_1 = 49;
  234. /**
  235.  * Keyboard sensor parameter. Corresponds to keyCode property of KeyboardEvent.
  236.  * @const module:controls.KEY_2
  237.  */
  238. exports.KEY_2 = 50;
  240. /**
  241.  * Keyboard sensor parameter. Corresponds to keyCode property of KeyboardEvent.
  242.  * @const module:controls.KEY_3
  243.  */
  244. exports.KEY_3 = 51;
  246. /**
  247.  * Keyboard sensor parameter. Corresponds to keyCode property of KeyboardEvent.
  248.  * @const module:controls.KEY_4
  249.  */
  250. exports.KEY_4 = 52;
  252. /**
  253.  * Keyboard sensor parameter. Corresponds to keyCode property of KeyboardEvent.
  254.  * @const module:controls.KEY_5
  255.  */
  256. exports.KEY_5 = 53;
  258. /**
  259.  * Keyboard sensor parameter. Corresponds to keyCode property of KeyboardEvent.
  260.  * @const module:controls.KEY_6
  261.  */
  262. exports.KEY_6 = 54;
  264. /**
  265.  * Keyboard sensor parameter. Corresponds to keyCode property of KeyboardEvent.
  266.  * @const module:controls.KEY_7
  267.  */
  268. exports.KEY_7 = 55;
  270. /**
  271.  * Keyboard sensor parameter. Corresponds to keyCode property of KeyboardEvent.
  272.  * @const module:controls.KEY_8
  273.  */
  274. exports.KEY_8 = 56;
  276. /**
  277.  * Keyboard sensor parameter. Corresponds to keyCode property of KeyboardEvent.
  278.  * @const module:controls.KEY_9
  279.  */
  280. exports.KEY_9 = 57;
  282. /**
  283.  * Keyboard sensor parameter. Corresponds to keyCode property of KeyboardEvent.
  284.  * @const module:controls.KEY_A
  285.  */
  286. exports.KEY_A = 65;
  288. /**
  289.  * Keyboard sensor parameter. Corresponds to keyCode property of KeyboardEvent.
  290.  * @const module:controls.KEY_B
  291.  */
  292. exports.KEY_B = 66;
  294. /**
  295.  * Keyboard sensor parameter. Corresponds to keyCode property of KeyboardEvent.
  296.  * @const module:controls.KEY_C
  297.  */
  298. exports.KEY_C = 67;
  300. /**
  301.  * Keyboard sensor parameter. Corresponds to keyCode property of KeyboardEvent.
  302.  * @const module:controls.KEY_D
  303.  */
  304. exports.KEY_D = 68;
  306. /**
  307.  * Keyboard sensor parameter. Corresponds to keyCode property of KeyboardEvent.
  308.  * @const module:controls.KEY_E
  309.  */
  310. exports.KEY_E = 69;
  312. /**
  313.  * Keyboard sensor parameter. Corresponds to keyCode property of KeyboardEvent.
  314.  * @const module:controls.KEY_F
  315.  */
  316. exports.KEY_F = 70;
  318. /**
  319.  * Keyboard sensor parameter. Corresponds to keyCode property of KeyboardEvent.
  320.  * @const module:controls.KEY_G
  321.  */
  322. exports.KEY_G = 71;
  324. /**
  325.  * Keyboard sensor parameter. Corresponds to keyCode property of KeyboardEvent.
  326.  * @const module:controls.KEY_H
  327.  */
  328. exports.KEY_H = 72;
  330. /**
  331.  * Keyboard sensor parameter. Corresponds to keyCode property of KeyboardEvent.
  332.  * @const module:controls.KEY_I
  333.  */
  334. exports.KEY_I = 73;
  336. /**
  337.  * Keyboard sensor parameter. Corresponds to keyCode property of KeyboardEvent.
  338.  * @const module:controls.KEY_J
  339.  */
  340. exports.KEY_J = 74;
  342. /**
  343.  * Keyboard sensor parameter. Corresponds to keyCode property of KeyboardEvent.
  344.  * @const module:controls.KEY_K
  345.  */
  346. exports.KEY_K = 75;
  348. /**
  349.  * Keyboard sensor parameter. Corresponds to keyCode property of KeyboardEvent.
  350.  * @const module:controls.KEY_L
  351.  */
  352. exports.KEY_L = 76;
  354. /**
  355.  * Keyboard sensor parameter. Corresponds to keyCode property of KeyboardEvent.
  356.  * @const module:controls.KEY_M
  357.  */
  358. exports.KEY_M = 77;
  360. /**
  361.  * Keyboard sensor parameter. Corresponds to keyCode property of KeyboardEvent.
  362.  * @const module:controls.KEY_N
  363.  */
  364. exports.KEY_N = 78;
  366. /**
  367.  * Keyboard sensor parameter. Corresponds to keyCode property of KeyboardEvent.
  368.  * @const module:controls.KEY_O
  369.  */
  370. exports.KEY_O = 79;
  372. /**
  373.  * Keyboard sensor parameter. Corresponds to keyCode property of KeyboardEvent.
  374.  * @const module:controls.KEY_P
  375.  */
  376. exports.KEY_P = 80;
  378. /**
  379.  * Keyboard sensor parameter. Corresponds to keyCode property of KeyboardEvent.
  380.  * @const module:controls.KEY_Q
  381.  */
  382. exports.KEY_Q = 81;
  384. /**
  385.  * Keyboard sensor parameter. Corresponds to keyCode property of KeyboardEvent.
  386.  * @const module:controls.KEY_R
  387.  */
  388. exports.KEY_R = 82;
  390. /**
  391.  * Keyboard sensor parameter. Corresponds to keyCode property of KeyboardEvent.
  392.  * @const module:controls.KEY_S
  393.  */
  394. exports.KEY_S = 83;
  396. /**
  397.  * Keyboard sensor parameter. Corresponds to keyCode property of KeyboardEvent.
  398.  * @const module:controls.KEY_T
  399.  */
  400. exports.KEY_T = 84;
  402. /**
  403.  * Keyboard sensor parameter. Corresponds to keyCode property of KeyboardEvent.
  404.  * @const module:controls.KEY_U
  405.  */
  406. exports.KEY_U = 85;
  408. /**
  409.  * Keyboard sensor parameter. Corresponds to keyCode property of KeyboardEvent.
  410.  * @const module:controls.KEY_V
  411.  */
  412. exports.KEY_V = 86;
  414. /**
  415.  * Keyboard sensor parameter. Corresponds to keyCode property of KeyboardEvent.
  416.  * @const module:controls.KEY_W
  417.  */
  418. exports.KEY_W = 87;
  420. /**
  421.  * Keyboard sensor parameter. Corresponds to keyCode property of KeyboardEvent.
  422.  * @const module:controls.KEY_X
  423.  */
  424. exports.KEY_X = 88;
  426. /**
  427.  * Keyboard sensor parameter. Corresponds to keyCode property of KeyboardEvent.
  428.  * @const module:controls.KEY_Y
  429.  */
  430. exports.KEY_Y = 89;
  432. /**
  433.  * Keyboard sensor parameter. Corresponds to keyCode property of KeyboardEvent.
  434.  * @const module:controls.KEY_Z
  435.  */
  436. exports.KEY_Z = 90;
  438. /**
  439.  * Keyboard sensor parameter. Corresponds to keyCode property of KeyboardEvent.
  440.  * @const module:controls.KEY_NUM0
  441.  */
  442. exports.KEY_NUM0 = 96;
  444. /**
  445.  * Keyboard sensor parameter. Corresponds to keyCode property of KeyboardEvent.
  446.  * @const module:controls.KEY_NUM1
  447.  */
  448. exports.KEY_NUM1 = 97;
  450. /**
  451.  * Keyboard sensor parameter. Corresponds to keyCode property of KeyboardEvent.
  452.  * @const module:controls.KEY_NUM2
  453.  */
  454. exports.KEY_NUM2 = 98;
  456. /**
  457.  * Keyboard sensor parameter. Corresponds to keyCode property of KeyboardEvent.
  458.  * @const module:controls.KEY_NUM3
  459.  */
  460. exports.KEY_NUM3 = 99;
  462. /**
  463.  * Keyboard sensor parameter. Corresponds to keyCode property of KeyboardEvent.
  464.  * @const module:controls.KEY_NUM4
  465.  */
  466. exports.KEY_NUM4 = 100;
  468. /**
  469.  * Keyboard sensor parameter. Corresponds to keyCode property of KeyboardEvent.
  470.  * @const module:controls.KEY_NUM5
  471.  */
  472. exports.KEY_NUM5 = 101;
  474. /**
  475.  * Keyboard sensor parameter. Corresponds to keyCode property of KeyboardEvent.
  476.  * @const module:controls.KEY_NUM6
  477.  */
  478. exports.KEY_NUM6 = 102;
  480. /**
  481.  * Keyboard sensor parameter. Corresponds to keyCode property of KeyboardEvent.
  482.  * @const module:controls.KEY_NUM7
  483.  */
  484. exports.KEY_NUM7 = 103;
  486. /**
  487.  * Keyboard sensor parameter. Corresponds to keyCode property of KeyboardEvent.
  488.  * @const module:controls.KEY_NUM8
  489.  */
  490. exports.KEY_NUM8 = 104;
  492. /**
  493.  * Keyboard sensor parameter. Corresponds to keyCode property of KeyboardEvent.
  494.  * @const module:controls.KEY_NUM9
  495.  */
  496. exports.KEY_NUM9 = 105;
  498. /**
  499.  * Keyboard sensor parameter. Corresponds to keyCode property of KeyboardEvent.
  500.  * @const module:controls.KEY_NUM9
  501.  */
  502. exports.KEY_MULT = 106;
  504. /**
  505.  * Keyboard sensor parameter. Corresponds to keyCode property of KeyboardEvent.
  506.  * @const module:controls.KEY_NUM9
  507.  */
  508. exports.KEY_ADD = 107;
  510. /**
  511.  * Keyboard sensor parameter. Corresponds to keyCode property of KeyboardEvent.
  512.  * @const module:controls.KEY_NUM9
  513.  */
  514. exports.KEY_SUB = 109;
  516. /**
  517.  * Keyboard sensor parameter. Corresponds to keyCode property of KeyboardEvent.
  518.  * Can only be used when NUM LOCK is turned on.
  519.  * @const module:controls.KEY_DEC_POINT
  520.  */
  521. exports.KEY_DEC_POINT = 110;
  523. /**
  524.  * Keyboard sensor parameter. Corresponds to keyCode property of KeyboardEvent.
  525.  * @const module:controls.KEY_NUM9
  526.  */
  527. exports.KEY_DIV = 111;
  529. /**
  530.  * Keyboard sensor parameter. Corresponds to keyCode property of KeyboardEvent.
  531.  * @const module:controls.KEY_SEMI_COLON
  532.  */
  533. exports.KEY_SEMI_COLON    = 186;
  535. /**
  536.  * Keyboard sensor parameter. Corresponds to keyCode property of KeyboardEvent.
  537.  * @const module:controls.KEY_EQUAL_SIGN
  538.  */
  539. exports.KEY_EQUAL_SIGN    = 187;
  541. /**
  542.  * Keyboard sensor parameter. Corresponds to keyCode property of KeyboardEvent.
  543.  * @const module:controls.KEY_COMMA
  544.  */
  545. exports.KEY_COMMA         = 188;
  547. /**
  548.  * Keyboard sensor parameter. Corresponds to keyCode property of KeyboardEvent.
  549.  * @const module:controls.KEY_DASH
  550.  */
  551. exports.KEY_DASH          = 189;
  553. /**
  554.  * Keyboard sensor parameter. Corresponds to keyCode property of KeyboardEvent.
  555.  * @const module:controls.KEY_PERIOD
  556.  */
  557. exports.KEY_PERIOD        = 190;
  559. /**
  560.  * Keyboard sensor parameter. Corresponds to keyCode property of KeyboardEvent.
  561.  * @const module:controls.KEY_FORWARD_SLASH
  562.  */
  563. exports.KEY_FORWARD_SLASH = 191;
  565. /**
  566.  * Keyboard sensor parameter. Corresponds to keyCode property of KeyboardEvent.
  567.  * @const module:controls.KEY_GRAVE_ACCENT
  568.  */
  569. exports.KEY_GRAVE_ACCENT  = 192;
  571. /**
  572.  * Keyboard sensor parameter. Corresponds to keyCode property of KeyboardEvent.
  573.  * @const module:controls.KEY_LEFT_SQ_BRACKET
  574.  */
  575. exports.KEY_LEFT_SQ_BRACKET  = 219;
  577. /**
  578.  * Keyboard sensor parameter. Corresponds to keyCode property of KeyboardEvent.
  579.  * @const module:controls.KEY_BACK_SLASH
  580.  */
  581. exports.KEY_BACK_SLASH       = 220;
  583. /**
  584.  * Keyboard sensor parameter. Corresponds to keyCode property of KeyboardEvent.
  585.  * @const module:controls.KEY_RIGHT_SQ_BRACKET
  586.  */
  587. exports.KEY_RIGHT_SQ_BRACKET = 221;
  589. /**
  590.  * Keyboard sensor parameter. Corresponds to keyCode property of KeyboardEvent.
  591.  * @const module:controls.KEY_SINGLE_QUOTE
  592.  */
  593. exports.KEY_SINGLE_QUOTE     = 222;
  595. /**
  596.  * Payload value of a touch movement sensor. Returned by get_sensor_payload()
  597.  * for single-finger pan gestures.
  598.  * @const module:controls.PL_SINGLE_TOUCH_MOVE
  599.  */
  600. exports.PL_SINGLE_TOUCH_MOVE    = m_ctl.PL_SINGLE_TOUCH_MOVE;
  602. /**
  603.  * Payload value of a touch movement sensor. Returned by get_sensor_payload()
  604.  * for multi-finger zoom gestures.
  605.  * @const module:controls.PL_MULTITOUCH_MOVE_ZOOM
  606.  */
  607. exports.PL_MULTITOUCH_MOVE_ZOOM = m_ctl.PL_MULTITOUCH_MOVE_ZOOM;
  609. /**
  610.  * Payload value of a touch movement sensor. Returned by get_sensor_payload()
  611.  * for multi-finger pan gestures.
  612.  * @const module:controls.PL_MULTITOUCH_MOVE_PAN
  613.  */
  614. exports.PL_MULTITOUCH_MOVE_PAN  = m_ctl.PL_MULTITOUCH_MOVE_PAN;
  616. /**
  617.  * Payload value of a touch movement sensor. Returned by get_sensor_payload()
  618.  * for multi-finger rotate gestures.
  619.  * @const module:controls.PL_MULTITOUCH_MOVE_ROTATE
  620.  */
  621. exports.PL_MULTITOUCH_MOVE_ROTATE  = m_ctl.PL_MULTITOUCH_MOVE_ROTATE;
  623. /**
  624.  * Default logic AND function for sensor manifold
  625.  * @const module:controls.default_AND_logic_fun
  626.  */
  627. exports.default_AND_logic_fun = m_ctl.default_AND_logic_fun;
  629. /**
  630.  * Default logic OR function for sensor manifold
  631.  * @const module:controls.default_OR_logic_fun
  632.  */
  633. exports.default_OR_logic_fun = m_ctl.default_OR_logic_fun;
  635. /**
  636.  * Create a gamepad button sensor.
  637.  * @method module:controls.create_gamepad_btn_sensor
  638.  * @param {number} ind Button number
  639.  * @param {number} [number] Connected gamepad number
  640.  * @returns {Sensor} Sensor object
  641.  */
  642. exports.create_gamepad_btn_sensor = m_ctl.create_gamepad_btn_sensor;
  643. /**
  644.  * Create a gamepad an axis sensor.
  645.  * @method module:controls.create_gamepad_axis_sensor
  646.  * @param {number} axis Axis number
  647.  * @param {number} [number] Connected gamepad number
  648.  * @returns {Sensor} Sensor object
  649.  */
  650. exports.create_gamepad_axis_sensor = m_ctl.create_gamepad_axis_sensor;
  652. /**
  653.  * Create a gamepad position sensor.
  654.  * @method module:controls.create_gamepad_position_sensor
  655.  * @param {number} [number] Connected gamepad number
  656.  * @returns {Sensor} Sensor object
  657.  */
  658. exports.create_gamepad_position_sensor = m_ctl.create_gamepad_position_sensor;
  659. /**
  660.  * Create a gamepad orientation sensor.
  661.  * @method module:controls.create_gamepad_orientation_sensor
  662.  * @param {number} [number] Connected gamepad number
  663.  * @returns {Sensor} Sensor object
  664.  */
  665. exports.create_gamepad_orientation_sensor = m_ctl.create_gamepad_orientation_sensor;
  667. /**
  668.  * Create a custom sensor.
  669.  * A custom sensor can be controlled manually by using the get_custom_sensor()
  670.  * and set_custom_sensor() methods.
  671.  * @method module:controls.create_custom_sensor
  672.  * @param {number} value Initial custom sensor value
  673.  * @returns {Sensor} Sensor object
  674.  */
  675. exports.create_custom_sensor = m_ctl.create_custom_sensor;
  677. /**
  678.  * Create a keyboard sensor.
  679.  * This sensor carries the following payload values:
  680.  * 0 --- button wasn't pressed at the last frame, and it wasn't pressed at the current frame,
  681.  * 1 --- button wasn't pressed at the last frame, but it was pressed at the current frame,
  682.  * 2 --- button was pressed at the last frame, and it was pressed at the current frame,
  683.  * 3 --- button was pressed at the last frame, and it wasn't pressed at the current frame.
  684.  * @method module:controls.create_keyboard_sensor
  685.  * @param {number} key Sensor key KEY_*
  686.  * @param {HTMLElement} [element=Canvas container element] HTML element
  687.  * @returns {Sensor} Sensor object
  688.  */
  689. exports.create_keyboard_sensor = m_ctl.create_keyboard_sensor;
  691. /**
  692.  * Create a collision sensor.
  693.  * Detects collisions between the object and the entities (objects or physics
  694.  * materials) with the specified collision ID. If the collision ID is not
  695.  * specified, the sensor will detect collisions with any entities.
  696.  * This sensor carries the following {@link CollisionPayload|payload}.
  697.  * @method module:controls.create_collision_sensor
  698.  * @param {Object3D} obj_src Collision object.
  699.  * @param {?string} [collision_id="ANY"] Collision ID, "ANY" for any collision ID
  700.  * @param {boolean} [calc_pos_norm=false] Should the sensor return the
  701.  * collision position/normal/distance or not.
  702.  * @returns {Sensor} Sensor object
  703.  */
  704. exports.create_collision_sensor = function(obj_src, collision_id, calc_pos_norm) {
  705.     collision_id = collision_id || "ANY";
  706.     calc_pos_norm = calc_pos_norm || false;
  708.     return m_ctl.create_collision_sensor(obj_src, collision_id, calc_pos_norm);
  709. }
  711. /**
  712.  * Create a collision impulse sensor.
  713.  * It is intended to obtain the value of the impulse (that is, mass multiplied
  714.  * by velocity) applied to the object at the collision point.
  715.  * @method module:controls.create_collision_impulse_sensor
  716.  * @param {Object3D} obj Collision object.
  717.  * @returns {Sensor} Sensor object
  718.  */
  719. exports.create_collision_impulse_sensor = m_ctl.create_collision_impulse_sensor;
  721. /**
  722.  * Create a ray sensor.
  723.  * The sensor casts a ray between the from and to positions.
  724.  * These positions are specified relatively to the object's origin
  725.  * (ign_src_rot = true), in the world space (obj_src = null) or in the local
  726.  * space (ign_src_rot = false).
  727.  * Checks intersection of this ray with the specified collision ID. If the
  728.  * collision ID is not specified, the sensor will detect collisions with any
  729.  * entities.
  730.  * This sensor carries the following {@link RayPayload|payload}.
  731.  * @method module:controls.create_ray_sensor
  732.  * @param {?Object3D} obj_src Source object, pass a non-null value to perform 
  733.  * ray casting in object space, e.g. from/to vectors specified in object space.
  734.  * @param {Vec3} from From vector.
  735.  * @param {Vec3} to To vector.
  736.  * @param {?string} [collision_id="ANY"] Collision ID, "ANY" for any collision ID
  737.  * @param {boolean} [is_binary_value=false] Calculate the value of the sensor as
  738.  * a binary (hit/non-hit) instead of hit fraction.
  739.  * @param {boolean} [calc_pos_norm=false] Calculate hit position/normal
  740.  * (accessed from payload object).
  741.  * @param {boolean} [ign_src_rot=false] Ignore any rotation of the source object
  742.  * during ray casting.
  743.  * @returns {Sensor} Sensor object.
  744.  */
  745. exports.create_ray_sensor = function(obj_src, from, to, collision_id,
  746.         is_binary_value, calc_pos_norm, ign_src_rot) {
  748.     if (obj_src && !m_phy.obj_has_physics(obj_src)) {
  749.         m_print.error_once("No physics for object " + obj_src.name);
  750.         return;
  751.     }
  753.     collision_id = collision_id || "ANY";
  754.     is_binary_value = is_binary_value || false;
  755.     calc_pos_norm = calc_pos_norm || false;
  756.     ign_src_rot = ign_src_rot || false;
  758.     return m_ctl.create_ray_sensor(obj_src, from, to, collision_id, is_binary_value,
  759.             calc_pos_norm, ign_src_rot);
  760. }
  762. /**
  763.  * Create a mouse click sensor.
  764.  * The sensor's payload is an object
  765.  * with useful properties like coordinates, and index of button
  766.  * @method module:controls.create_mouse_click_sensor
  767.  * @param {HTMLElement} [element=Canvas container element] HTML element
  768.  * @returns {Sensor} Sensor object
  769.  * @cc_externs coords which
  770.  */
  771. exports.create_mouse_click_sensor = m_ctl.create_mouse_click_sensor;
  773. /**
  774.  * Create a mouse wheel sensor.
  775.  * The sensor's value is 1 for a single wheel notch scrolled away from the user.
  776.  * @method module:controls.create_mouse_wheel_sensor
  777.  * @param {HTMLElement} [element=Canvas container element] HTML element
  778.  * @returns {Sensor} Sensor object
  779.  */
  780. exports.create_mouse_wheel_sensor = m_ctl.create_mouse_wheel_sensor;
  782. /**
  783.  * Create a mouse movement sensor.
  784.  * The sensor's value is a number of pixels, the sensor's payload is an object
  785.  * with useful properties like coordinates
  786.  * @method module:controls.create_mouse_move_sensor
  787.  * @param {string} [axis="XY"] Coordinate(s) to track: "X", "Y", "XY"
  788.  * @param {HTMLElement} [element] HTML element. The canvas container will be use by default.
  789.  * @returns {Sensor} Sensor object
  790.  * @cc_externs coords
  791.  */
  792. exports.create_mouse_move_sensor = m_ctl.create_mouse_move_sensor;
  793. /**
  794.  * Create a mouse move pointerlock sensor.
  795.  * The sensor's value is a number of pixels, the sensor's payload is an object
  796.  * with useful properties like coordinates
  797.  * @method module:controls.create_plock_mouse_sensor
  798.  * @param {HTMLElement} [element=Canvas container element] HTML element
  799.  * @returns {Sensor} Sensor object
  800.  * @cc_externs coords
  801.  */
  802. exports.create_plock_mouse_sensor = m_ctl.create_plock_mouse_sensor;
  803. /**
  804.  * Create a mouse pointerlock sensor.
  805.  * The sensor's value is a pointerlock state
  806.  * @method module:controls.create_plock_sensor
  807.  * @param {HTMLElement} [element=Canvas container element] HTML element
  808.  * @returns {Sensor} Sensor object
  809.  */
  810. exports.create_plock_sensor = m_ctl.create_plock_sensor;
  811. /**
  812.  * Create a touch movement sensor.
  813.  * The sensor's value is a number of pixels, the sensor's payload is an object
  814.  * with useful properties like coordinates
  815.  * @method module:controls.create_touch_move_sensor
  816.  * @param {string} [axis="XY"] Coordinate(s) to track: "X", "Y" or "XY"
  817.  * @param {HTMLElement} [element] HTML element. The canvas container will be use by default.
  818.  * @returns {Sensor} Sensor object
  819.  * @cc_externs coords gesture
  820.  */
  821. exports.create_touch_move_sensor = m_ctl.create_touch_move_sensor;
  823. /**
  824.  * Create a touch zoom sensor.
  825.  * The sensor's value is the distance difference in pixels.
  826.  * @method module:controls.create_touch_zoom_sensor
  827.  * @param {HTMLElement} [element=Canvas container element] HTML element
  828.  * @returns {Sensor} Sensor object
  829.  */
  830. exports.create_touch_zoom_sensor = m_ctl.create_touch_zoom_sensor;
  832. /**
  833.  * Create a touch rotate sensor.
  834.  * The sensor's value is the angle (in radians) from -PI to PI.
  835.  * @method module:controls.create_touch_rotate_sensor
  836.  * @param {HTMLElement} [element=Canvas container element] HTML element
  837.  * @returns {Sensor} Sensor object
  838.  */
  839. exports.create_touch_rotate_sensor = m_ctl.create_touch_rotate_sensor;
  841. /**
  842.  * Create a touch click sensor.
  843.  * The sensor's value is 1 for a touched touchscreen. The sensor's payload is an object
  844.  * with useful properties like coordinates
  845.  * @method module:controls.create_touch_click_sensor
  846.  * @param {HTMLElement} [element=Canvas container element] HTML element
  847.  * @returns {Sensor} Sensor object
  848.  * @cc_externs coords
  849.  */
  850. exports.create_touch_click_sensor = m_ctl.create_touch_click_sensor;
  852. /**
  853.  * Create a motion sensor.
  854.  * The sensor's value is 1 if the object is in motion.
  855.  * @method module:controls.create_motion_sensor
  856.  * @param {Object3D} obj Object 3D
  857.  * @param {number} [threshold=0.1] Translation velocity threshold,
  858.  * units (meters) per second
  859.  * @param {number} [rotation_threshold=0.1] Rotation velocity threshold,
  860.  * radians per second
  861.  * @returns {Sensor} Sensor object
  862.  */
  863. exports.create_motion_sensor = m_ctl.create_motion_sensor;
  865. /**
  866.  * Create a velocity sensor.
  867.  * The sensor's value is 1 if abs() of the object's vertical velocity exceeds
  868.  * the threshold.
  869.  * @method module:controls.create_vertical_velocity_sensor
  870.  * @param {Object3D} obj Object 3D
  871.  * @param {number} [threshold=1.0] Vertical velocity threshold,
  872.  * units (meters) per second
  873.  * @returns {Sensor} Sensor object
  874.  */
  875. exports.create_vertical_velocity_sensor = m_ctl.create_vertical_velocity_sensor;
  877. /**
  878.  * Create a gyroscope angle sensor.
  879.  * The sensor's payload stores the Euler angles of orientation (in radians)
  880.  * of a mobile device.
  881.  * @method module:controls.create_gyro_angles_sensor
  882.  * @returns {Sensor} Sensor object
  883.  */
  884. exports.create_gyro_angles_sensor = m_ctl.create_gyro_angles_sensor;
  886. /**
  887.  * Create a gyroscope quaternion sensor.
  888.  * The sensor's payload stores the quaternion of orientation
  889.  * of a mobile device.
  890.  * @method module:controls.create_gyro_quat_sensor
  891.  * @returns {Sensor} Sensor object
  892.  */
  893. exports.create_gyro_quat_sensor = m_ctl.create_gyro_quat_sensor;
  895. /**
  896.  * Create a gyroscope delta sensor.
  897.  * The sensor's payload stores the differences (in radians) between Euler angles
  898.  * of the current orientation and the previous orientation of a mobile device.
  899.  * @method module:controls.create_gyro_delta_sensor
  900.  * @returns {Sensor} Sensor object
  901.  */
  902. exports.create_gyro_delta_sensor = m_ctl.create_gyro_delta_sensor;
  904. /**
  905.  * Create a HMD quaternion sensor.
  906.  * The sensor's payload stores the quaternion of orientation of a HMD.
  907.  * @method module:controls.create_hmd_quat_sensor
  908.  * @returns {Sensor} Sensor object
  909.  */
  910. exports.create_hmd_quat_sensor = m_ctl.create_hmd_quat_sensor;
  912. /**
  913.  * Create a HMD position sensor.
  914.  * The sensor's payload stores the vector of HMD position.
  915.  * @method module:controls.create_hmd_position_sensor
  916.  * @returns {Sensor} Sensor object
  917.  */
  918. exports.create_hmd_position_sensor = m_ctl.create_hmd_position_sensor;
  920. /**
  921.  * Create a timer sensor.
  922.  * The sensor's value becomes 1 for the frame which comes next after the
  923.  * period of time has elapsed. After that, its value becomes 0 again.
  924.  * The timer's precision depends on FPS, so it is not effective for measuring
  925.  * short intervals.
  926.  * @method module:controls.create_timer_sensor
  927.  * @param {number} period Timer period, in seconds
  928.  * @param {boolean} [do_repeat=false] Re-start the timer upon expiration
  929.  * @returns {Sensor} Sensor object
  930.  */
  931. exports.create_timer_sensor = function(period, do_repeat) {
  932.     return m_ctl.create_timer_sensor(period, do_repeat || false);
  933. }
  935. /**
  936.  * Reset the timer sensor and set a new period value.
  937.  * @method module:controls.reset_timer_sensor
  938.  * @param {Object3D} obj Object 3D
  939.  * @param {string} manifold_id Object's manifold ID
  940.  * @param {number} num Sensor's number in the manifold
  941.  * @param {number} period A new period value for the sensor
  942.  */
  943. exports.reset_timer_sensor = m_ctl.reset_timer_sensor;
  945. /**
  946.  * Create an elapsed sensor.
  947.  * The sensor's value is the time elapsed from the previous frame.
  948.  * @method module:controls.create_elapsed_sensor
  949.  * @returns {Sensor} Sensor object
  950.  */
  951. exports.create_elapsed_sensor = m_ctl.create_elapsed_sensor;
  953. /**
  954.  * Create a timeline sensor.
  955.  * The sensor's value is the value of the global engine timeline.
  956.  * @method module:controls.create_timeline_sensor
  957.  * @returns {Sensor} Sensor object
  958.  */
  959. exports.create_timeline_sensor = m_ctl.create_timeline_sensor;
  961. /**
  962.  * Create a selection sensor for the object.
  963.  * The sensor's value becomes 1 when the object is selected by the user.
  964.  * @param {Object3D} obj Object 3D
  965.  * @param {boolean} [enable_toggle_switch=false] If true, reset the sensor
  966.  * (set it to 0) only when another object is selected. If false, reset the
  967.  * sensor when the mouse button/touch is released.
  968.  * @method module:controls.create_selection_sensor
  969.  * @returns {Sensor} Sensor object
  970.  */
  971. exports.create_selection_sensor = function(obj, enable_toggle_switch) {
  972.     return m_ctl.create_selection_sensor(obj, enable_toggle_switch || false);
  973. }
  975. /**
  976.  * Create a callback sensor.
  977.  * The given callback is executed every frame and its return value is copied into the sensor value.
  978.  * @param {SensorCallback} callback A callback which modifies sensor value.
  979.  * @param {number} [value=0] Initial sensor value.
  980.  * @method module:controls.create_callback_sensor
  981.  * @returns {Sensor} Sensor object
  982.  */
  983. exports.create_callback_sensor = function(callback, value) {
  984.     return m_ctl.create_callback_sensor(callback, value || 0);
  985. }
  987. /**
  988.  * Set the value of the custom sensor.
  989.  * @method module:controls.set_custom_sensor
  990.  * @param {Sensor} sensor Sensor object
  991.  * @param {number} value New sensor value
  992.  */
  993. exports.set_custom_sensor = function(sensor, value) {
  994.     m_ctl.sensor_set_value(sensor, value);
  995. }
  997. /**
  998.  * Get the value of the custom sensor.
  999.  * @method module:controls.get_custom_sensor
  1000.  * @param {Sensor} sensor Sensor object
  1001.  * @returns {number} Sensor value
  1002.  */
  1003. exports.get_custom_sensor = function(sensor) {
  1004.     return sensor.value;
  1005. }
  1007. /**
  1008.  * Return the value of the sensor from the object's manifold. The sensor is
  1009.  * identified by its index in the manifold's array of sensors.
  1010.  * @method module:controls.get_sensor_value
  1011.  * @param {?Object3D} obj Object 3D, or null to denote the global object
  1012.  * @param {string} manifold_id Object's manifold ID
  1013.  * @param {number} num Sensor index in manifold's array
  1014.  * @returns {number} Sensor value
  1015.  */
  1016. exports.get_sensor_value = m_ctl.get_sensor_value;
  1018. /**
  1019.  * Return the payload data of the sensor from the object's manifold. The sensor
  1020.  * is identified by its index in the manifold's array of sensors.
  1021.  * @method module:controls.get_sensor_payload
  1022.  * @param {?Object3D} obj Object 3D, or null to denote the global object
  1023.  * @param {string} manifold_id Object's manifold ID
  1024.  * @param {number} num Sensor index in manifold's array
  1025.  * @returns {*} Sensor payload
  1026.  */
  1027. exports.get_sensor_payload = m_ctl.get_sensor_payload;
  1029. /**
  1030.  * Create a sensor manifold.
  1031.  * @method module:controls.create_sensor_manifold
  1032.  * @param {?Object3D} obj Object 3D to attach the manifold to, or null to denote
  1033.  * the global object.
  1034.  * @param {string} id New manifold ID.
  1035.  * @param {number} type Manifold control type (CT_SHOT, CT_TRIGGER etc).
  1036.  * @param {Sensor[]} sensors Array of sensors.
  1037.  * @param {?ManifoldLogicFunction} logic_fun Manifold's logic function, if null
  1038.  * use default_AND_logic_fun function.
  1039.  * @param {ManifoldCallback} callback Manifold's callback.
  1040.  * @param {*} [callback_param] Parameter to pass to the manifold's callback
  1041.  * (e.g. some state).
  1042.  */
  1043. exports.create_sensor_manifold = function(obj, id, type, sensors,
  1044.                                           logic_fun, callback, callback_param) {
  1046.     callback_param = callback_param === undefined? null: callback_param;
  1047.     logic_fun = logic_fun || m_ctl.default_AND_logic_fun;
  1049.     m_ctl.create_sensor_manifold(obj, id, type, sensors, logic_fun, callback,
  1050.                                  callback_param);
  1051. }
  1053. /**
  1054.  * Convenience function: creates a manifold coupled with a single keyboard
  1055.  * sensor. Can be used to quickly create a single-key functionality.
  1056.  * @method module:controls.create_kb_sensor_manifold
  1057.  * @param {?Object3D} obj Object 3D to attach the manifold to, or null to denote
  1058.  * the global object
  1059.  * @param {string} id New manifold ID
  1060.  * @param {number} type Manifold control type (CT_SHOT, CT_TRIGGER etc)
  1061.  * @param {number} key Sensor key KEY_*
  1062.  * @param {ManifoldCallback} callback Manifold's callback
  1063.  * @param {*} [callback_param] Parameter to pass to the manifold's callback
  1064.  * (e.g. some state)
  1065.  */
  1066. exports.create_kb_sensor_manifold = function(obj, id, type, key,
  1067.         callback, callback_param) {
  1068.     var kb_sensor = m_ctl.create_keyboard_sensor(key);
  1070.     callback_param = callback_param === undefined? null: callback_param;
  1071.     var logic_fun = m_ctl.default_AND_logic_fun;
  1073.     m_ctl.create_sensor_manifold(obj, id, type, [kb_sensor], logic_fun,
  1074.                                  callback, callback_param);
  1075. }
  1077. /**
  1078.  * Check whether the object has any manifolds attached.
  1079.  * @method module:controls.check_sensor_manifolds
  1080.  * @param {?Object3D} obj Object 3D, or null to denote the global object
  1081.  * @returns {boolean} Result of the check
  1082.  */
  1083. exports.check_sensor_manifolds = function(obj) {
  1084.     return m_ctl.check_sensor_manifold(obj, null);
  1085. }
  1087. /**
  1088.  * Check whether the object has the manifold attached.
  1089.  * @method module:controls.check_sensor_manifold
  1090.  * @param {?Object3D} obj Object 3D, or null to denote the global object
  1091.  * @param {string} id Manifold ID
  1092.  * @returns {boolean} Result of the check
  1093.  */
  1094. exports.check_sensor_manifold = m_ctl.check_sensor_manifold;
  1096. /**
  1097.  * Remove the sensor manifold registered for the object.
  1098.  * @method module:controls.remove_sensor_manifold
  1099.  * @param {?Object3D} obj Object 3D to delete the manifold from, or null to denote
  1100.  * the global object
  1101.  * @param {string} [id=null] ID of the sensor manifold, or null to delete all
  1102.  * manifolds
  1103.  */
  1104. exports.remove_sensor_manifold = m_ctl.remove_sensor_manifold;
  1106. /**
  1107.  * Reset controls for all the objects.
  1108.  * Calling this method is discouraged, use remove_sensor_manifold() instead.
  1109.  * @method module:controls.reset
  1110.  */
  1111. exports.reset = m_ctl.reset;
  1113. /**
  1114.  * Set smooth factor for mouse pointerlock sensor.
  1115.  * @method module:controls.set_plock_smooth_factor
  1116.  * @param {number} value Set 
  1117.  */
  1118. exports.set_plock_smooth_factor = m_ctl.set_plock_smooth_factor;
  1120. }
  1122. var controls_factory = register("controls", Controls);
  1124. export default controls_factory;