zepumph
commented
1 year ago There are 23 spots (as well as all future spots) where we would have to handle this in sim-specific usages instead of generally. I would say this is not correct or a step in the right direction.
@samreid please continue if you would like, but most likely this should have a conversation with CM before committing. Feel free to close.
```diff
Subject: [PATCH] support not just if I am featured, but if any element descendant is featured, thus reflecting if I am in the "featured display tree", https://github.com/phetsims/studio/issues/305
---
Index: tandem/js/PhetioObject.ts
IDEA additional info:
Subsystem: com.intellij.openapi.diff.impl.patch.CharsetEP
<+>UTF-8
===================================================================
diff --git a/tandem/js/PhetioObject.ts b/tandem/js/PhetioObject.ts
--- a/tandem/js/PhetioObject.ts (revision b6b351e668dbe368ce2c82e7d1729f0bc2cdec36)
+++ b/tandem/js/PhetioObject.ts (date 1686602803377)
@@ -582,7 +582,7 @@
* @param element - the target element. Must be instrumented for a LinkedElement to be created-- otherwise gracefully opts out
* @param [providedOptions]
*/
- public addLinkedElement( element: LinkableElement, providedOptions?: LinkedElementOptions ): void {
+ public addLinkedElement( element: PhetioObject, providedOptions?: LinkedElementOptions ): void {
if ( !this.isPhetioInstrumented() ) {
// set this to null so that you can't addLinkedElement on an uninitialized PhetioObject and then instrument
@@ -851,9 +851,9 @@
* Internal class to avoid cyclic dependencies.
*/
class LinkedElement extends PhetioObject {
- public readonly element: LinkableElement;
+ public readonly element: PhetioObject;
- public constructor( coreElement: LinkableElement, providedOptions?: LinkedElementOptions ) {
+ public constructor( coreElement: PhetioObject, providedOptions?: LinkedElementOptions ) {
assert && assert( !!coreElement, 'coreElement should be defined' );
const options = optionize()( {
Index: sun/js/ComboBox.ts
IDEA additional info:
Subsystem: com.intellij.openapi.diff.impl.patch.CharsetEP
<+>UTF-8
===================================================================
diff --git a/sun/js/ComboBox.ts b/sun/js/ComboBox.ts
--- a/sun/js/ComboBox.ts (revision 03f17578e663f394d5fc943550b5b2c06d0bd3b7)
+++ b/sun/js/ComboBox.ts (date 1686602887161)
@@ -42,6 +42,7 @@
import GroupItemOptions, { getGroupItemNodes } from './GroupItemOptions.js';
import Multilink from '../../axon/js/Multilink.js';
import StrictOmit from '../../phet-core/js/types/StrictOmit.js';
+import PhetioObject from '../../tandem/js/PhetioObject.js';
// const
const LIST_POSITION_VALUES = [ 'above', 'below' ] as const; // where the list pops up relative to the button
@@ -417,7 +418,7 @@
this.pickable = !displayOnly;
} );
- this.addLinkedElement( property, {
+ property instanceof PhetioObject && this.addLinkedElement( property, {
tandem: options.tandem.createTandem( 'property' )
} );
Index: sun/js/Slider.ts
IDEA additional info:
Subsystem: com.intellij.openapi.diff.impl.patch.CharsetEP
<+>UTF-8
===================================================================
diff --git a/sun/js/Slider.ts b/sun/js/Slider.ts
--- a/sun/js/Slider.ts (revision 03f17578e663f394d5fc943550b5b2c06d0bd3b7)
+++ b/sun/js/Slider.ts (date 1686602860736)
@@ -42,6 +42,7 @@
import LinkableElement from '../../tandem/js/LinkableElement.js';
import PickRequired from '../../phet-core/js/types/PickRequired.js';
import isSettingPhetioStateProperty from '../../tandem/js/isSettingPhetioStateProperty.js';
+import PhetioObject from '../../tandem/js/PhetioObject.js';
// constants
const DEFAULT_HORIZONTAL_TRACK_SIZE = new Dimension2( 100, 5 );
@@ -499,7 +500,7 @@
// Must happen after instrumentation (in super call)
const linkedProperty = options.phetioLinkedProperty || ( valueProperty instanceof ReadOnlyProperty ? valueProperty : null );
- if ( linkedProperty ) {
+ if ( linkedProperty && linkedProperty instanceof PhetioObject ) {
this.addLinkedElement( linkedProperty, {
tandem: options.tandem.createTandem( 'valueProperty' )
} );
Index: sun/js/Checkbox.ts
IDEA additional info:
Subsystem: com.intellij.openapi.diff.impl.patch.CharsetEP
<+>UTF-8
===================================================================
diff --git a/sun/js/Checkbox.ts b/sun/js/Checkbox.ts
--- a/sun/js/Checkbox.ts (revision 03f17578e663f394d5fc943550b5b2c06d0bd3b7)
+++ b/sun/js/Checkbox.ts (date 1686602832862)
@@ -225,7 +225,7 @@
this.setExcludeLabelSiblingFromInput();
// must be after the Checkbox is instrumented
- options.phetioLinkProperty && this.addLinkedElement( property, {
+ options.phetioLinkProperty && property instanceof PhetioObject && this.addLinkedElement( property, {
tandem: options.tandem.createTandem( 'property' )
} );
Index: scenery-phet/js/ZoomButtonGroup.ts
IDEA additional info:
Subsystem: com.intellij.openapi.diff.impl.patch.CharsetEP
<+>UTF-8
===================================================================
diff --git a/scenery-phet/js/ZoomButtonGroup.ts b/scenery-phet/js/ZoomButtonGroup.ts
--- a/scenery-phet/js/ZoomButtonGroup.ts (revision 7c1f820ca11b669541b65e044e58f19e70d74c67)
+++ b/scenery-phet/js/ZoomButtonGroup.ts (date 1686602913854)
@@ -14,6 +14,7 @@
import sceneryPhet from './sceneryPhet.js';
import TRangedProperty from '../../axon/js/TRangedProperty.js';
import SceneryPhetStrings from './SceneryPhetStrings.js';
+import PhetioObject from '../../tandem/js/PhetioObject.js';
type SelfOptions = {
@@ -129,7 +130,7 @@
};
zoomLevelProperty.link( zoomLevelListener );
- this.addLinkedElement( zoomLevelProperty, {
+ zoomLevelProperty instanceof PhetioObject && this.addLinkedElement( zoomLevelProperty, {
tandem: options.tandem.createTandem( 'zoomProperty' )
} );
samreid
pixelzoom
We support LinkableElement for our common UI code, but we should be type safe in calling addLinkedElement, and only do that for PhetioObjects. @samreid and I were working on a patch and made it work well in initial testing, we will take a look.