add hintArrowsNode and mark model hintProperty readOnly, #236

phetsims · Sep 21, 2021 · b603941 · b603941
1 parent 2c81d29
commit b603941
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 2 deletions.
diff --git a/js/friction/model/FrictionModel.js b/js/friction/model/FrictionModel.js
@@ -228,7 +228,10 @@ class FrictionModel extends PhetioObject {
 
     // @public {BooleanProperty} - Show hint icon. Only set by model and on a11y grab interaction.
     this.hintProperty = new BooleanProperty( true, {
-      tandem: tandem.createTandem( 'hintProperty' )
+      tandem: tandem.createTandem( 'hintProperty' ),
+      phetioReadOnly: true,
+      phetioDocumentation: 'whether or not the sim is conveying the hint arrows. This is not editable, but can be ' +
+                           'overridden by toggling the "hintArrowsNode.visibleProperty" in the view.'
     } );
 
     // @public {Number} (read-only) - drag and drop book coordinates conversion coefficient

diff --git a/js/friction/view/magnifier/MagnifierNode.js b/js/friction/view/magnifier/MagnifierNode.js
@@ -94,6 +94,13 @@ class MagnifierNode extends Node {
       top: ARROW_TOP
     } );
 
+    // Intermediate Node to support PhET-iO instrumentation that can control the visibility and bypass the sim reverting it (like via reset).
+    const hintArrowsNode = new Node( {
+      children: [ visualArrowIcon ],
+      tandem: options.tandem.createTandem( 'hintArrowsNode' ),
+      phetioDocumentation: 'the node that holds the visual hint, or "cue" arrows'
+    } );
+
     // create and register the sound generators that will be used when the top book is picked up and dropped
     const bookPickupSoundClip = new SoundClip( harpPickupSound, { initialOutputLevel: SOUND_LEVEL } );
     soundManager.addSoundGenerator( bookPickupSoundClip );
@@ -184,7 +191,7 @@ class MagnifierNode extends Node {
     this.topBookBackground.addChild( dragArea );
 
     // add arrows before the drag area, then the grab cue hides the arrows
-    this.topBookBackground.addChild( visualArrowIcon );
+    this.topBookBackground.addChild( hintArrowsNode );
 
     addRowCircles(
       FrictionModel.MAGNIFIED_ATOMS_INFO.radius,