actions/TimingActions.js

  1. /**
  2.  *  TimingActions - Actions related to time
  3.  * 
  4.  *  This code is licensed under the MIT License (MIT).
  5.  *  
  6.  *  Copyright 2020, 2021, 2022 Rolf Bagge, Janus B. Kristensen, CAVI,
  7.  *  Center for Advanced Visualization and Interaction, Aarhus University
  8.  *  
  9.  *  Permission is hereby granted, free of charge, to any person obtaining a copy
  10.  *  of this software and associated documentation files (the “Software”), to deal
  11.  *  in the Software without restriction, including without limitation the rights 
  12.  *  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 
  13.  *  copies of the Software, and to permit persons to whom the Software is 
  14.  *  furnished to do so, subject to the following conditions:
  15.  *  
  16.  *  The above copyright notice and this permission notice shall be included in 
  17.  *  all copies or substantial portions of the Software.
  18.  *  
  19.  *  THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 
  20.  *  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 
  21.  *  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 
  22.  *  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 
  23.  *  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 
  24.  *  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN 
  25.  *  THE SOFTWARE.
  26.  *  
  27.  */
  29. /**
  30.  * Actions that deal with time
  31.  * @namespace TimingActions
  32.  */
  34. /**
  35.  * An action "wait" that waits for a given duration before continuing
  36.  * @memberOf TimingActions
  37.  * @example
  38.  * //Wait for 100ms
  39.  * {
  40.  *     "wait": {
  41.  *         "duration": 100
  42.  *     }
  43.  * }
  44.  *
  45.  * //Wait for 100ms (shorthand version)
  46.  * {
  47.  *     "wait": 100
  48.  * }
  49.  */
  50. class WaitAction extends Action {
  51.     static options() {
  52.         return {
  53.             "duration": "number"
  54.         }
  55.     }
  57.     constructor(name, options, concept) {
  58.         //shorthand
  59.         if(typeof options === "number") {
  60.             options = {
  61.                 "duration": options
  62.             }
  63.         }
  65.         super(name, options, concept);
  66.     }
  68.     async apply(contexts, actionArguments) {
  69.         if(this.options.duration == null) {
  70.             throw new Error("Option 'duration' must be present on 'wait' action");
  71.         }
  72.         return this.forEachContext(contexts, actionArguments, async (context, options)=>{
  73.             await new Promise((resolve)=>{
  74.                 setTimeout(()=>{
  75.                     resolve();
  76.                 }, options.duration);
  77.             })
  79.             return context;
  80.         });
  81.     }
  82. }
  83. Action.registerPrimitiveAction("wait", WaitAction);
  84. window.WaitAction = WaitAction;