Source: extern/nla.js

  1. import register from "../util/register.js";
  3. import m_nla_fact from "../intern/nla.js";
  4. import m_time_fact from "../intern/time.js";
  5. import m_print_fact from "../intern/print.js";
  6. import * as m_util from "../intern/util.js";
  8. /**
  9.  * API methods to control {@link https://www.blend4web.com/doc/en/animation.html#non-linear-animation|non linear animation}.
  10.  * @module nla
  11.  * @local NlaFinishCallback
  12.  */
  13. function NLA(ns, exports) {
  15. var m_nla    = m_nla_fact(ns);
  16. var m_time   = m_time_fact(ns);
  17. var m_print  = m_print_fact(ns);
  19. /**
  20.  * Callback executed after the NLA animation has finished.
  21.  * @callback NlaFinishCallback
  22.  */
  24. /**
  25.  * Set NLA animation frame for the active scene.
  26.  * @method module:nla.set_frame
  27.  * @param {number} frame NLA animation frame
  28.  */
  29. exports.set_frame = function(frame) {
  30.     
  31.     frame = m_util.clamp(frame, m_nla.get_frame_start(), 
  32.             m_nla.get_frame_end());
  34.     if (m_nla.check_logic_nodes()) {
  35.         m_print.error("The active scene is using the Logic Editor.");
  36.         return;
  37.     }
  38.     m_nla.set_frame(frame, m_time.get_timeline());
  39. }
  40. /**
  41.  * Get NLA animation frame from the active scene
  42.  * @method module:nla.get_frame
  43.  * @returns {number} NLA animation current frame.
  44.  */
  45. exports.get_frame = function() {
  46.     return m_nla.get_frame(m_time.get_timeline());
  47. }
  49. /**
  50.  * Stop NLA animation for the active scene.
  51.  * @method module:nla.stop
  52.  */
  53. exports.stop = function() {
  54.     if (m_nla.check_logic_nodes())
  55.         m_print.warn("The active scene is using the Logic Editor. It may conflicts with your JS-code.");
  57.     m_nla.stop_nla();
  58. }
  60. /**
  61.  * Play NLA animation for the active scene
  62.  * @method module:nla.play
  63.  * @param {?NlaFinishCallback} [callback=null] Nla finish callback.
  64.  */
  65. exports.play = function(callback) {
  66.     if (m_nla.check_logic_nodes())
  67.         m_print.warn("The active scene is using the Logic Editor. It may conflicts with your JS-code.");
  69.     m_nla.play_nla(callback);
  70. }
  72. /**
  73.  * Check if NLA animation is being run for the active scene
  74.  * @method module:nla.is_play
  75.  * @returns {boolean} Check result.
  76.  */
  77. exports.is_play = function() {
  78.     return m_nla.is_play();
  79. }
  80. /**
  81.  * Get NLA animation starting frame for the active scene
  82.  * @method module:nla.get_frame_start
  83.  * @returns {number} Start frame.
  84.  */
  85. exports.get_frame_start = function() {
  86.     return m_nla.get_frame_start();
  87. }
  88. /**
  89.  * Get NLA animation ending frame for the active scene
  90.  * @method module:nla.get_frame_end
  91.  * @returns {number} End frame.
  92.  */
  93. exports.get_frame_end = function() {
  94.     return m_nla.get_frame_end();
  95. }
  96. /**
  97.  * Check if the current scene is currently NLA animated.
  98.  * @method module:nla.check_nla
  99.  * @returns {boolean} Check result.
  100.  */
  101. exports.check_nla = function() {
  102.     return m_nla.check_nla();
  103. }
  105. /**
  106.  * Check if the current scene has logic nodes
  107.  * @method module:nla.check_logic_nodes
  108.  * @returns {boolean} Check result.
  109.  */
  110. exports.check_logic_nodes = function() {
  111.     return m_nla.check_logic_nodes();
  112. }
  114. /**
  115.  * Play NLA animation for the active scene from start frame to end frame.
  116.  * @method module:nla.set_range
  117.  * @param {number} start_frame Start NLA animation frame
  118.  * @param {number} end_frame End NLA animation frame
  119.  */
  120. exports.set_range = function(start_frame, end_frame) {
  122.     if (m_nla.check_logic_nodes()) {
  123.         m_print.error("The active scene is using the Logic Editor.");
  124.         return;
  125.     }
  127.     end_frame = parseFloat(end_frame) || m_nla.get_frame_end();
  128.     start_frame = parseFloat(start_frame) || m_nla.get_frame_end();
  130.     end_frame = m_util.clamp(end_frame, m_nla.get_frame_start(), 
  131.             m_nla.get_frame_end());
  133.     start_frame = m_util.clamp(start_frame, m_nla.get_frame_start(), 
  134.             end_frame);
  136.     m_nla.set_range(start_frame, end_frame);
  137. }
  138. /**
  139.  * Reset NLA animation playing range
  140.  * @method module:nla.reset_range
  141.  */
  142. exports.reset_range = function() {
  143.     if (m_nla.check_logic_nodes()) {
  144.         m_print.error("The active scene is using the Logic Editor.");
  145.         return;
  146.     }
  147.     m_nla.reset_range();
  148. }
  149. /**
  150.  * Set cyclic behaviour for the active scene
  151.  * @method module:nla.set_cyclic
  152.  * @param {boolean} is_cyclic Cyclic behavior.
  153.  */
  154. exports.set_cyclic = function(is_cyclic) {
  155.     if (m_nla.check_logic_nodes()) {
  156.         m_print.error("The active scene is using the Logic Editor.");
  157.         return;
  158.     }
  159.     m_nla.set_cyclic(is_cyclic);
  160. }
  161. /**
  162.  * Clear callback executed after the NLA animation finished
  163.  * @method module:nla.clear_callback
  164.  */
  165. exports.clear_callback = function() {
  166.     if (m_nla.check_logic_nodes()) {
  167.         m_print.error("The active scene is using the Logic Editor.");
  168.         return;
  169.     }
  170.     m_nla.clear_callback();
  171. }
  172. }
  174. var nla_factory = register("nla", NLA);
  176. export default nla_factory;