use isDisposable:false where appropriate, phetsims/axon#436

phetsims · Jul 5, 2023 · b5c901e · b5c901e
1 parent 6d53bc2
commit b5c901e
Show file tree

Hide file tree

Showing 36 changed files with 50 additions and 266 deletions.
diff --git a/js/common/FMWConstants.ts b/js/common/FMWConstants.ts
@@ -49,6 +49,7 @@ const PANEL_OPTIONS: PanelOptions = {
 const WAVE_PACKET_NUMBER_CONTROL_OPTIONS: NumberControlOptions = {
 
   // NumberControl options
+  isDisposable: false,
   includeArrowButtons: false,
   layoutFunction: ( titleNode: Node, numberDisplay: NumberDisplay, slider: Slider, leftArrowButton: ArrowButton | null, rightArrowButton: ArrowButton | null ): Node => new VBox( {
     spacing: 5,

diff --git a/js/common/model/FourierSeries.ts b/js/common/model/FourierSeries.ts
@@ -8,7 +8,6 @@
  * @author Chris Malley (PixelZoom, Inc.)
  */
 
-import Disposable from '../../../../axon/js/Disposable.js';
 import BooleanProperty from '../../../../axon/js/BooleanProperty.js';
 import DerivedProperty, { UnknownDerivedProperty } from '../../../../axon/js/DerivedProperty.js';
 import NumberProperty from '../../../../axon/js/NumberProperty.js';
@@ -77,6 +76,7 @@ export default class FourierSeries extends PhetioObject {
       amplitudes: DEFAULT_AMPLITUDES, // {number[]} initial amplitudes for the harmonics
 
       // PhetioObjectOptions
+      isDisposable: false,
       phetioState: false
     }, providedOptions );
 
@@ -131,11 +131,6 @@ export default class FourierSeries extends PhetioObject {
     } );
   }
 
-  public override dispose(): void {
-    Disposable.assertNotDisposable();
-    super.dispose();
-  }
-
   /**
    * Resets the Fourier series.
    */

diff --git a/js/common/model/Harmonic.ts b/js/common/model/Harmonic.ts
@@ -8,7 +8,6 @@
  * @author Chris Malley (PixelZoom, Inc.)
  */
 
-import Disposable from '../../../../axon/js/Disposable.js';
 import NumberProperty from '../../../../axon/js/NumberProperty.js';
 import TReadOnlyProperty from '../../../../axon/js/TReadOnlyProperty.js';
 import Range from '../../../../dot/js/Range.js';
@@ -61,6 +60,7 @@ export default class Harmonic extends PhetioObject {
       amplitude: 0,
 
       // PhetioObjectOptions
+      isDisposable: false,
       phetioState: false
     }, providedOptions );
 
@@ -84,11 +84,6 @@ export default class Harmonic extends PhetioObject {
     } );
   }
 
-  public override dispose(): void {
-    Disposable.assertNotDisposable();
-    super.dispose();
-  }
-
   public reset(): void {
     this.amplitudeProperty.reset();
   }

diff --git a/js/common/view/AmplitudeKeypadDialog.ts b/js/common/view/AmplitudeKeypadDialog.ts
@@ -7,7 +7,6 @@
  * @author Chris Malley (PixelZoom, Inc.)
  */
 
-import Disposable from '../../../../axon/js/Disposable.js';
 import NumberProperty from '../../../../axon/js/NumberProperty.js';
 import PatternStringProperty from '../../../../axon/js/PatternStringProperty.js';
 import Range from '../../../../dot/js/Range.js';
@@ -67,6 +66,7 @@ export default class AmplitudeKeypadDialog extends Dialog {
       decimalPlaces: FMWConstants.DISCRETE_AMPLITUDE_DECIMAL_PLACES,
 
       // DialogOptions
+      isDisposable: false,
       closeButtonLength: 12,
       cornerRadius: FMWConstants.PANEL_CORNER_RADIUS,
       layoutStrategy: ( dialog: Dialog, simBounds: Bounds2, screenBounds: Bounds2, scale: number ) => {
@@ -223,11 +223,6 @@ export default class AmplitudeKeypadDialog extends Dialog {
     this.closeCallback = null;
     this.keypad.clear();
   }
-
-  public override dispose(): void {
-    Disposable.assertNotDisposable();
-    super.dispose();
-  }
 }
 
 /**

diff --git a/js/common/view/AmplitudeNumberDisplay.ts b/js/common/view/AmplitudeNumberDisplay.ts
@@ -7,7 +7,6 @@
  * @author Chris Malley (PixelZoom, Inc.)
  */
 
-import Disposable from '../../../../axon/js/Disposable.js';
 import DerivedProperty from '../../../../axon/js/DerivedProperty.js';
 import NumberDisplay, { NumberDisplayOptions } from '../../../../scenery-phet/js/NumberDisplay.js';
 import PhetColorScheme from '../../../../scenery-phet/js/PhetColorScheme.js';
@@ -54,6 +53,7 @@ export default class AmplitudeNumberDisplay extends InteractiveHighlighting( VBo
       },
 
       // VBoxOptions
+      isDisposable: false,
       cursor: 'pointer',
       spacing: 2,
       align: 'center',
@@ -127,11 +127,6 @@ export default class AmplitudeNumberDisplay extends InteractiveHighlighting( VBo
       }
     } );
   }
-
-  public override dispose(): void {
-    Disposable.assertNotDisposable();
-    super.dispose();
-  }
 }
 
 fourierMakingWaves.register( 'AmplitudeNumberDisplay', AmplitudeNumberDisplay );
diff --git a/js/common/view/AmplitudeSlider.ts b/js/common/view/AmplitudeSlider.ts
@@ -7,7 +7,6 @@
  * @author Chris Malley (PixelZoom, Inc.)
  */
 
-import Disposable from '../../../../axon/js/Disposable.js';
 import BooleanProperty from '../../../../axon/js/BooleanProperty.js';
 import DerivedProperty from '../../../../axon/js/DerivedProperty.js';
 import Dimension2 from '../../../../dot/js/Dimension2.js';
@@ -59,6 +58,7 @@ export default class AmplitudeSlider extends Slider {
       mouseTouchStep: FMWConstants.DISCRETE_AMPLITUDE_STEP,
 
       // SliderOptions
+      isDisposable: false,
       startDrag: _.noop,
       endDrag: _.noop,
       orientation: Orientation.VERTICAL,
@@ -139,11 +139,6 @@ export default class AmplitudeSlider extends Slider {
     this.visibleProperty.link( () => this.interruptSubtreeInput() );
   }
 
-  public override dispose(): void {
-    Disposable.assertNotDisposable();
-    super.dispose();
-  }
-
   /**
    * Creates a non-interactive icon for an AmplitudeSlider.
    */
@@ -196,14 +191,10 @@ class GrippyThumb extends Node {
 
     super( {
       children: [ rectangle, dotsNode ],
+      isDisposable: false,
       tandem: tandem
     } );
   }
-
-  public override dispose(): void {
-    Disposable.assertNotDisposable();
-    super.dispose();
-  }
 }
 
 /**
@@ -231,6 +222,7 @@ class BarTrack extends SliderTrack {
     const options = optionize<BarTrackOptions, BarTrackSelfOptions, SliderTrackOptions>()( {
 
       // SliderTrackOptions
+      isDisposable: false,
       size: new Dimension2( 10, 10 )
     }, providedOptions );
 
@@ -285,11 +277,6 @@ class BarTrack extends SliderTrack {
       ( isPressed, isOverVisible ) => ( isPressed || isOverVisible )
     );
   }
-
-  public override dispose(): void {
-    Disposable.assertNotDisposable();
-    super.dispose();
-  }
 }
 
 fourierMakingWaves.register( 'AmplitudeSlider', AmplitudeSlider );
diff --git a/js/common/view/DomainChartNode.ts b/js/common/view/DomainChartNode.ts
@@ -12,7 +12,6 @@
  * @author Chris Malley (PixelZoom, Inc.)
  */
 
-import Disposable from '../../../../axon/js/Disposable.js';
 import Multilink from '../../../../axon/js/Multilink.js';
 import AxisLine, { AxisLineOptions } from '../../../../bamboo/js/AxisLine.js';
 import ChartRectangle, { ChartRectangleOptions } from '../../../../bamboo/js/ChartRectangle.js';
@@ -152,7 +151,10 @@ export default class DomainChartNode extends Node {
       },
       yTickLabelSetOptions: {
         edge: DEFAULT_EDGE
-      }
+      },
+
+      // NodeOptions
+      isDisposable: false
     }, providedOptions );
 
     // the transform between model and view coordinate frames
@@ -256,11 +258,6 @@ export default class DomainChartNode extends Node {
     this.chartRectangle = chartRectangle;
   }
 
-  public override dispose(): void {
-    Disposable.assertNotDisposable();
-    super.dispose();
-  }
-
   /**
    * Computes the clipArea that will trim any data that is outside of a given amplitude range.
    * This is used to trim anomalies that occur when the x-axis is zoomed way out.

diff --git a/js/common/view/DomainComboBox.ts b/js/common/view/DomainComboBox.ts
@@ -7,7 +7,6 @@
  * @author Chris Malley (PixelZoom, Inc.)
  */
 
-import Disposable from '../../../../axon/js/Disposable.js';
 import { Node } from '../../../../scenery/js/imports.js';
 import ComboBox from '../../../../sun/js/ComboBox.js';
 import fourierMakingWaves from '../../fourierMakingWaves.js';
@@ -49,14 +48,10 @@ export default class DomainComboBox extends FMWComboBox<Domain> {
       textOptions: {
         maxWidth: 100 // determined empirically
       },
+      isDisposable: false,
       tandem: tandem
     } );
   }
-
-  public override dispose(): void {
-    Disposable.assertNotDisposable();
-    super.dispose();
-  }
 }
 
 fourierMakingWaves.register( 'DomainComboBox', DomainComboBox );
diff --git a/js/common/view/InteractiveAmplitudesChartNode.ts b/js/common/view/InteractiveAmplitudesChartNode.ts
@@ -12,7 +12,6 @@
  * @author Chris Malley (PixelZoom, Inc.)
  */
 
-import Disposable from '../../../../axon/js/Disposable.js';
 import ChartRectangle from '../../../../bamboo/js/ChartRectangle.js';
 import ChartTransform, { ChartTransformOptions } from '../../../../bamboo/js/ChartTransform.js';
 import GridLineSet from '../../../../bamboo/js/GridLineSet.js';
@@ -73,7 +72,8 @@ export default class InteractiveAmplitudesChartNode extends Node {
       chartTransformOptions: {
         viewWidth: FMWConstants.CHART_RECTANGLE_SIZE.width,
         viewHeight: FMWConstants.CHART_RECTANGLE_SIZE.height
-      }
+      },
+      isDisposable: false
     }, providedOptions );
 
     assert && assert( !options.chartTransformOptions.modelXRange, 'InteractiveAmplitudesChartNode sets modelXRange' );
@@ -184,11 +184,6 @@ export default class InteractiveAmplitudesChartNode extends Node {
     this.slidersParent = slidersParent;
     this.numberDisplays = numberDisplays;
   }
-
-  public override dispose(): void {
-    Disposable.assertNotDisposable();
-    super.dispose();
-  }
 }
 
 fourierMakingWaves.register( 'InteractiveAmplitudesChartNode', InteractiveAmplitudesChartNode );
diff --git a/js/common/view/MeasurementToolsKeyboardHelpSection.ts b/js/common/view/MeasurementToolsKeyboardHelpSection.ts
@@ -9,7 +9,6 @@
  * @author Chris Malley (PixelZoom, Inc.)
  */
 
-import Disposable from '../../../../axon/js/Disposable.js';
 import KeyboardHelpIconFactory from '../../../../scenery-phet/js/keyboard/help/KeyboardHelpIconFactory.js';
 import KeyboardHelpSection from '../../../../scenery-phet/js/keyboard/help/KeyboardHelpSection.js';
 import KeyboardHelpSectionRow from '../../../../scenery-phet/js/keyboard/help/KeyboardHelpSectionRow.js';
@@ -41,13 +40,9 @@ export default class MeasurementToolsKeyboardHelpSection extends KeyboardHelpSec
         [ shiftPlusArrowsIcon, shiftPlusWASDsIcon ] )
     ];
 
-    super( FourierMakingWavesStrings.keyboardHelpDialog.measurementToolsStringProperty, rows );
-  }
-
-  // See https://github.com/phetsims/fourier-making-waves/issues/236
-  public override dispose(): void {
-    Disposable.assertNotDisposable();
-    super.dispose();
+    super( FourierMakingWavesStrings.keyboardHelpDialog.measurementToolsStringProperty, rows, {
+      isDisposable: false // see https://github.com/phetsims/fourier-making-waves/issues/236
+    } );
   }
 }
 

diff --git a/js/discrete/DiscreteScreen.ts b/js/discrete/DiscreteScreen.ts
@@ -6,7 +6,6 @@
  * @author Chris Malley (PixelZoom, Inc.
  */
 
-import Disposable from '../../../axon/js/Disposable.js';
 import Screen from '../../../joist/js/Screen.js';
 import Tandem from '../../../tandem/js/Tandem.js';
 import FMWColors from '../common/FMWColors.js';
@@ -26,6 +25,7 @@ export default class DiscreteScreen extends Screen<DiscreteModel, DiscreteScreen
       backgroundColorProperty: FMWColors.discreteScreenBackgroundColorProperty,
       homeScreenIcon: FMWIconFactory.createDiscreteHomeScreenIcon(),
       createKeyboardHelpNode: () => new DiscreteKeyboardHelpContent(),
+      isDisposable: false,
       tandem: tandem
     };
 
@@ -35,11 +35,6 @@ export default class DiscreteScreen extends Screen<DiscreteModel, DiscreteScreen
       options
     );
   }
-
-  public override dispose(): void {
-    Disposable.assertNotDisposable();
-    super.dispose();
-  }
 }
 
 fourierMakingWaves.register( 'DiscreteScreen', DiscreteScreen );