phet-io for rulers, #263

phetsims · Dec 7, 2021 · c03f178 · c03f178
1 parent 9cfaa0a
commit c03f178
Show file tree

Hide file tree

Showing 4 changed files with 34 additions and 15 deletions.
diff --git a/js/common/model/GeometricOpticsModel.ts b/js/common/model/GeometricOpticsModel.ts
@@ -128,12 +128,14 @@ class GeometricOpticsModel {
 
     this.horizontalRuler = new GeometricOpticsRuler( {
       orientation: 'horizontal',
-      length: GeometricOpticsConstants.HORIZONTAL_RULER_LENGTH
+      length: GeometricOpticsConstants.HORIZONTAL_RULER_LENGTH,
+      tandem: options.tandem.createTandem( 'horizontalRuler' )
     } );
 
     this.verticalRuler = new GeometricOpticsRuler( {
       orientation: 'vertical',
-      length: GeometricOpticsConstants.VERTICAL_RULER_LENGTH
+      length: GeometricOpticsConstants.VERTICAL_RULER_LENGTH,
+      tandem: options.tandem.createTandem( 'verticalRuler' )
     } );
   }
 

diff --git a/js/common/model/GeometricOpticsRuler.ts b/js/common/model/GeometricOpticsRuler.ts
@@ -12,6 +12,7 @@ import Property from '../../../../axon/js/Property.js';
 import Vector2 from '../../../../dot/js/Vector2.js';
 import Vector2Property from '../../../../dot/js/Vector2Property.js';
 import merge from '../../../../phet-core/js/merge.js';
+import Tandem from '../../../../tandem/js/Tandem.js';
 import geometricOptics from '../../geometricOptics.js';
 
 type RulerOrientation = 'horizontal' | 'vertical';
@@ -40,7 +41,10 @@ class GeometricOpticsRuler {
 
     options = merge( {
       orientation: 'horizontal',
-      length: 100
+      length: 100,
+
+      // phet-io options
+      tandem: Tandem.REQUIRED
     }, options );
 
     assert && assert( isFinite( options.length ) && options.length > 0 );
@@ -50,12 +54,16 @@ class GeometricOpticsRuler {
 
     // The initial value of position really does not matter, because position will be set when the ruler is
     // removed from the toolbox.
-    this.positionProperty = new Vector2Property( Vector2.ZERO );
+    this.positionProperty = new Vector2Property( Vector2.ZERO, {
+      tandem: options.tandem.createTandem( 'positionProperty' )
+    } );
 
     this.length = options.length;
     this.nominalLength = options.length;
 
-    this.visibleProperty = new BooleanProperty( false );
+    this.visibleProperty = new BooleanProperty( false, {
+      tandem: options.tandem.createTandem( 'visibleProperty' )
+    } );
   }
 
   public reset(): void {

diff --git a/js/common/view/GeometricOpticsRulerNode.ts b/js/common/view/GeometricOpticsRulerNode.ts
@@ -25,6 +25,7 @@ import geometricOpticsStrings from '../../geometricOpticsStrings.js';
 import GeometricOpticsConstants from '../GeometricOpticsConstants.js';
 import GeometricOpticsRuler from '../model/GeometricOpticsRuler.js';
 import Vector2 from '../../../../dot/js/Vector2.js';
+import Tandem from '../../../../tandem/js/Tandem.js';
 
 // constants
 const MINIMUM_VISIBLE_LENGTH = GeometricOpticsConstants.RULER_MINIMUM_VISIBLE_LENGTH;
@@ -58,7 +59,10 @@ class GeometricOpticsRulerNode extends Node {
 
       // Node options
       rotation: ruler.isVertical ? -Math.PI / 2 : 0,
-      visibleProperty: ruler.visibleProperty
+      visibleProperty: ruler.visibleProperty,
+
+      // phet-io options
+      tandem: Tandem.REQUIRED
 
     }, options );
     assert && assert( !options.children, 'this Node calls removeAllChildren' );
@@ -129,7 +133,8 @@ class GeometricOpticsRulerNode extends Node {
         if ( this.toolboxBounds.containsPoint( this.globalToParentPoint( event.pointer.point as Vector2 ) ) ) {
           ruler.visibleProperty.value = false;
         }
-      }
+      },
+      tandem: options.tandem.createTandem( 'dragListener' )
     } );
     this.addInputListener( this.dragListener );
   }

diff --git a/js/common/view/GeometricOpticsScreenView.ts b/js/common/view/GeometricOpticsScreenView.ts
@@ -127,9 +127,13 @@ class GeometricOpticsScreenView extends ScreenView {
 
     // create Rulers
     const horizontalRulerNode = new GeometricOpticsRulerNode( model.horizontalRuler,
-      zoomTransformProperty, zoomScaleProperty, this.visibleBoundsProperty );
+      zoomTransformProperty, zoomScaleProperty, this.visibleBoundsProperty, {
+      tandem: config.tandem.createTandem( 'horizontalRulerNode' )
+      } );
     const verticalRulerNode = new GeometricOpticsRulerNode( model.verticalRuler,
-      zoomTransformProperty, zoomScaleProperty, this.visibleBoundsProperty );
+      zoomTransformProperty, zoomScaleProperty, this.visibleBoundsProperty, {
+        tandem: config.tandem.createTandem( 'verticalRulerNode' )
+      } );
 
     // create control panel at the bottom of the screen
     const controlPanel = new GeometricOpticsControlPanel( model.representationProperty, model.optic,
@@ -141,14 +145,14 @@ class GeometricOpticsScreenView extends ScreenView {
     } );
 
     // create toolbox at the top right corner of the screen
-    const toolbox = new RulersToolbox( [ verticalRulerNode, horizontalRulerNode ], {
+    const rulersToolbox = new RulersToolbox( [ verticalRulerNode, horizontalRulerNode ], {
       rightTop: erodedLayoutBounds.rightTop,
-      tandem: config.tandem.createTandem( 'toolbox' )
+      tandem: config.tandem.createTandem( 'rulersToolbox' )
     } );
 
     // Tell the rulers where the toolbox is.
-    horizontalRulerNode.setToolboxBounds( toolbox.bounds );
-    verticalRulerNode.setToolboxBounds( toolbox.bounds );
+    horizontalRulerNode.setToolboxBounds( rulersToolbox.bounds );
+    verticalRulerNode.setToolboxBounds( rulersToolbox.bounds );
 
     // radio buttons for the shape of the optic
     const opticShapeRadioButtonGroup = new OpticShapeRadioButtonGroup( model.optic, {
@@ -358,7 +362,7 @@ class GeometricOpticsScreenView extends ScreenView {
         controlPanel,
         showHideToggleButton,
         resetAllButton,
-        toolbox,
+        rulersToolbox,
         zoomButtonGroup,
         representationComboBox,
         rulersLayer,
@@ -375,7 +379,7 @@ class GeometricOpticsScreenView extends ScreenView {
     };
 
     // pdom -traversal order
-    //TODO https://github.com/phetsims/geometric-optics/issues/235 add Object, second point, light sources, toolbox, rulers
+    //TODO https://github.com/phetsims/geometric-optics/issues/235 add Object, second point, light sources, rulersToolbox, rulers
     // @ts-ignore TYPESCRIPT Property 'pdomOrder' does not exist on type 'Node'.
     screenViewRootNode.pdomOrder = [
       representationComboBox,