Source: Core/ClockRange.js

  1. /*global define*/
  2. define([
  3.         './freezeObject'
  4.     ], function(
  5.         freezeObject) {
  6.     'use strict';
  8.     /**
  9.      * Constants used by {@link Clock#tick} to determine behavior
  10.      * when {@link Clock#startTime} or {@link Clock#stopTime} is reached.
  11.      *
  12.      * @exports ClockRange
  13.      *
  14.      * @see Clock
  15.      * @see ClockStep
  16.      */
  17.     var ClockRange = {
  18.         /**
  19.          * {@link Clock#tick} will always advances the clock in its current direction.
  20.          *
  21.          * @type {Number}
  22.          * @constant
  23.          */
  24.         UNBOUNDED : 0,
  26.         /**
  27.          * When {@link Clock#startTime} or {@link Clock#stopTime} is reached,
  28.          * {@link Clock#tick} will not advance {@link Clock#currentTime} any further.
  29.          *
  30.          * @type {Number}
  31.          * @constant
  32.          */
  33.         CLAMPED : 1,
  35.         /**
  36.          * When {@link Clock#stopTime} is reached, {@link Clock#tick} will advance
  37.          * {@link Clock#currentTime} to the opposite end of the interval.  When
  38.          * time is moving backwards, {@link Clock#tick} will not advance past
  39.          * {@link Clock#startTime}
  40.          *
  41.          * @type {Number}
  42.          * @constant
  43.          */
  44.         LOOP_STOP : 2
  45.     };
  47.     return freezeObject(ClockRange);
  48. });