Rename DisturbanceTypeEnum => DisturbanceType and move to Scene, see phetsims/phet-core#53

samreid · samreid · commit d538c9d2b661 · 2019-01-08T12:47:49.000-07:00
diff --git a/js/common/model/DisturbanceTypeEnum.js b/js/common/model/DisturbanceTypeEnum.js
diff --git a/js/common/model/Scene.js b/js/common/model/Scene.js
@@ -15,7 +15,7 @@ define( require => {
   const BooleanProperty = require( 'AXON/BooleanProperty' );
   const Bounds2 = require( 'DOT/Bounds2' );
   const DerivedProperty = require( 'AXON/DerivedProperty' );
-  const DisturbanceTypeEnum = require( 'WAVE_INTERFERENCE/common/model/DisturbanceTypeEnum' );
+  const Enumeration = require( 'PHET_CORE/Enumeration' );
   const Lattice = require( 'WAVE_INTERFERENCE/common/model/Lattice' );
   const ModelViewTransform2 = require( 'PHETCOMMON/view/ModelViewTransform2' );
   const NumberProperty = require( 'AXON/NumberProperty' );
@@ -241,8 +241,8 @@ define( require => {
       );
 
       // @public - pulse or continuous
-      this.disturbanceTypeProperty = new Property( DisturbanceTypeEnum.CONTINUOUS, {
-        validValues: DisturbanceTypeEnum.VALUES
+      this.disturbanceTypeProperty = new Property( Scene.DisturbanceType.CONTINUOUS, {
+        validValues: Scene.DisturbanceType.VALUES
       } );
 
       // The first button can trigger a pulse, or continuous wave, depending on the disturbanceTypeProperty
@@ -393,7 +393,7 @@ define( require => {
       const period = 1 / frequency;
       const timeSincePulseStarted = time - this.pulseStartTime;
       const lattice = this.lattice;
-      const isContinuous = ( this.disturbanceTypeProperty.get() === DisturbanceTypeEnum.CONTINUOUS );
+      const isContinuous = ( this.disturbanceTypeProperty.get() === Scene.DisturbanceType.CONTINUOUS );
       const continuous1 = isContinuous && this.continuousWave1OscillatingProperty.get();
       const continuous2 = isContinuous && this.continuousWave2OscillatingProperty.get();
 
@@ -689,7 +689,7 @@ define( require => {
       if ( isPressed && !this.button2PressedProperty.value ) {
         this.resetPhase();
       }
-      if ( isPressed && this.disturbanceTypeProperty.value === DisturbanceTypeEnum.PULSE ) {
+      if ( isPressed && this.disturbanceTypeProperty.value === Scene.DisturbanceType.PULSE ) {
         this.startPulse();
       }
       else {
@@ -772,5 +772,11 @@ define( require => {
     }
   }
 
+  /**
+   * A wave can be ongoing (CONTINUOUS) or a single wavelength (PULSE)
+   * @public
+   */
+  Scene.DisturbanceType = new Enumeration( [ 'PULSE', 'CONTINUOUS' ] );
+
   return waveInterference.register( 'Scene', Scene );
 } );
diff --git a/js/common/model/WaterScene.js b/js/common/model/WaterScene.js
@@ -10,7 +10,6 @@ define( require => {
 
   // modules
   const arrayRemove = require( 'PHET_CORE/arrayRemove' );
-  const DisturbanceTypeEnum = require( 'WAVE_INTERFERENCE/common/model/DisturbanceTypeEnum' );
   const NumberProperty = require( 'AXON/NumberProperty' );
   const Scene = require( 'WAVE_INTERFERENCE/common/model/Scene' );
   const WaterDrop = require( 'WAVE_INTERFERENCE/common/model/WaterDrop' );
@@ -84,15 +83,15 @@ define( require => {
       // Send a water drop if the button is pressed but not if the button is still pressed from the last pulse.
       // model.button1PressedProperty.value not consulted because we send a shutoff water drop. so that the previous
       // drop gets a full cycle
-      const isPulseMode = this.disturbanceTypeProperty.value === DisturbanceTypeEnum.PULSE;
+      const isPulseMode = this.disturbanceTypeProperty.value === Scene.DisturbanceType.PULSE;
       const firePulseDrop = isPulseMode && !this.pulseFiringProperty.value && this.button1PressedProperty.value;
       if ( !isPulseMode || firePulseDrop ) {
 
         // capture closure vars for when the water drop is absorbed.
         const buttonPressed = buttonProperty.value;
         const frequency = this.desiredFrequencyProperty.value;
         const amplitude = this.desiredAmplitudeProperty.value;
-        const isPulse = this.disturbanceTypeProperty.value === DisturbanceTypeEnum.PULSE;
+        const isPulse = this.disturbanceTypeProperty.value === Scene.DisturbanceType.PULSE;
 
         // Distance between the sources, or 0 if there is only 1 source
         const sourceSeparation = this.numberOfSources === 2 ? this.desiredSourceSeparationProperty.value : 0;
diff --git a/js/common/view/DisturbanceTypeIconNode.js b/js/common/view/DisturbanceTypeIconNode.js
@@ -9,10 +9,10 @@ define( require => {
   'use strict';
 
   // modules
-  const DisturbanceTypeEnum = require( 'WAVE_INTERFERENCE/common/model/DisturbanceTypeEnum' );
   const LineStyles = require( 'KITE/util/LineStyles' );
   const Node = require( 'SCENERY/nodes/Node' );
   const Path = require( 'SCENERY/nodes/Path' );
+  const Scene = require( 'WAVE_INTERFERENCE/common/model/Scene' );
   const Shape = require( 'KITE/Shape' );
   const Util = require( 'DOT/Util' );
   const waveInterference = require( 'WAVE_INTERFERENCE/waveInterference' );
@@ -27,7 +27,7 @@ define( require => {
   class DisturbanceTypeIconNode extends Node {
 
     /**
-     * @param {DisturbanceTypeEnum} disturbanceType
+     * @param {Scene.DisturbanceType} disturbanceType
      * @param {Object} [options]
      */
     constructor( disturbanceType, options ) {
@@ -37,17 +37,17 @@ define( require => {
       }, options );
       super();
 
-      const minAngle = disturbanceType === DisturbanceTypeEnum.PULSE ? Math.PI : 0;
-      const minX = disturbanceType === DisturbanceTypeEnum.PULSE ? MARGIN : 0;
-      const maxX = disturbanceType === DisturbanceTypeEnum.PULSE ? ( WIDTH - MARGIN ) : WIDTH;
+      const minAngle = disturbanceType === Scene.DisturbanceType.PULSE ? Math.PI : 0;
+      const minX = disturbanceType === Scene.DisturbanceType.PULSE ? MARGIN : 0;
+      const maxX = disturbanceType === Scene.DisturbanceType.PULSE ? ( WIDTH - MARGIN ) : WIDTH;
 
       const shape = new Shape();
       for ( let i = 0; i < NUMBER_OF_SAMPLES; i++ ) {
         const angle = Util.linear( 0, NUMBER_OF_SAMPLES - 1, minAngle, MAX_ANGLE, i );
         const y = -Math.cos( angle ) * WAVE_HEIGHT;
         const x = Util.linear( minAngle, MAX_ANGLE, minX, maxX, angle );
         if ( i === 0 ) {
-          if ( disturbanceType === DisturbanceTypeEnum.PULSE ) {
+          if ( disturbanceType === Scene.DisturbanceType.PULSE ) {
             shape.moveTo( x - MARGIN, y );
             shape.lineTo( x, y );
           }
@@ -59,7 +59,7 @@ define( require => {
           shape.lineTo( x, y );
         }
       }
-      if ( disturbanceType === DisturbanceTypeEnum.PULSE ) {
+      if ( disturbanceType === Scene.DisturbanceType.PULSE ) {
         shape.lineToRelative( MARGIN, 0 );
       }
 
diff --git a/js/common/view/DisturbanceTypeRadioButtonGroup.js b/js/common/view/DisturbanceTypeRadioButtonGroup.js
@@ -9,24 +9,24 @@ define( require => {
   'use strict';
 
   // modules
-  const DisturbanceTypeEnum = require( 'WAVE_INTERFERENCE/common/model/DisturbanceTypeEnum' );
   const DisturbanceTypeIconNode = require( 'WAVE_INTERFERENCE/common/view/DisturbanceTypeIconNode' );
   const RadioButtonGroup = require( 'SUN/buttons/RadioButtonGroup' );
+  const Scene = require( 'WAVE_INTERFERENCE/common/model/Scene' );
   const waveInterference = require( 'WAVE_INTERFERENCE/waveInterference' );
 
   class DisturbanceTypeRadioButtonGroup extends RadioButtonGroup {
 
     /**
-     * @param {Property.<DisturbanceTypeEnum>} disturbanceTypeProperty
+     * @param {Property.<Scene.DisturbanceType>} disturbanceTypeProperty
      * @param {Object} [options]
      */
     constructor( disturbanceTypeProperty, options ) {
       super( disturbanceTypeProperty, [ {
-        value: DisturbanceTypeEnum.CONTINUOUS,
-        node: new DisturbanceTypeIconNode( DisturbanceTypeEnum.CONTINUOUS )
+        value: Scene.DisturbanceType.CONTINUOUS,
+        node: new DisturbanceTypeIconNode( Scene.DisturbanceType.CONTINUOUS )
       }, {
-        value: DisturbanceTypeEnum.PULSE,
-        node: new DisturbanceTypeIconNode( DisturbanceTypeEnum.PULSE )
+        value: Scene.DisturbanceType.PULSE,
+        node: new DisturbanceTypeIconNode( Scene.DisturbanceType.PULSE )
       } ], _.extend( {
         orientation: 'vertical',
         buttonContentXMargin: 1,
diff --git a/js/common/view/WaveGeneratorNode.js b/js/common/view/WaveGeneratorNode.js
@@ -9,10 +9,10 @@ define( require => {
   'use strict';
 
   // modules
-  const DisturbanceTypeEnum = require( 'WAVE_INTERFERENCE/common/model/DisturbanceTypeEnum' );
   const DisturbanceTypeIconNode = require( 'WAVE_INTERFERENCE/common/view/DisturbanceTypeIconNode' );
   const Node = require( 'SCENERY/nodes/Node' );
   const RoundStickyToggleButton = require( 'SUN/buttons/RoundStickyToggleButton' );
+  const Scene = require( 'WAVE_INTERFERENCE/common/model/Scene' );
   const ShadedSphereNode = require( 'SCENERY_PHET/ShadedSphereNode' );
   const waveInterference = require( 'WAVE_INTERFERENCE/waveInterference' );
   const WaveInterferenceConstants = require( 'WAVE_INTERFERENCE/common/WaveInterferenceConstants' );
@@ -33,7 +33,7 @@ define( require => {
                  verticalOffset = 0,
                  buttonOffset = 0,
                  showButtonBackground = false ) {
-      const pulseIcon = new DisturbanceTypeIconNode( DisturbanceTypeEnum.PULSE, {
+      const pulseIcon = new DisturbanceTypeIconNode( Scene.DisturbanceType.PULSE, {
         scale: 0.36,
         stroked: true
       } );
@@ -69,17 +69,17 @@ define( require => {
       const nodeWithButton = new Node( { children: children } );
 
       const updateEnabled = () => {
-        if ( scene.disturbanceTypeProperty.value === DisturbanceTypeEnum.PULSE ) {
+        if ( scene.disturbanceTypeProperty.value === Scene.DisturbanceType.PULSE ) {
           button.enabled = !scene.pulseFiringProperty.value && !scene.isAboutToFireProperty.value;
         }
-        else if ( scene.disturbanceTypeProperty.value === DisturbanceTypeEnum.CONTINUOUS ) {
+        else if ( scene.disturbanceTypeProperty.value === Scene.DisturbanceType.CONTINUOUS ) {
           button.enabled = true;
         }
       };
 
       // When changing between PULSE and CONTINUOUS, update the buttons.
       scene.disturbanceTypeProperty.link( disturbanceType => {
-        pulseIcon.visible = disturbanceType === DisturbanceTypeEnum.PULSE;
+        pulseIcon.visible = disturbanceType === Scene.DisturbanceType.PULSE;
           updateEnabled();
         }
       );
