CCK: Basic PhET-iO instrumentation

[samreid]

We would like to add basic PhET-iO instrumentation for a client.

Remove elements from the carousel (primarily resistor)

Use circuitConstructionKitDc.introScreen.view.circuitElementToolbox.carousel.tools.resistorToolNode.visibleProperty. Note, it does not reflow the layout.

Hide the voltmeter/ammeter tool icons

Use circuitConstructionKitDc.introScreen.view.sensorToolbox.visibleProperty to hide both.
Use circuitConstructionKitDc.introScreen.view.sensorToolbox.ammeterToolIconWithLabel.visibleProperty to hide the ammeter(s)
Use circuitConstructionKitDc.introScreen.view.sensorToolbox.voltmeterToolIconWithLabel.visibleProperty to hide the voltmeter.
NOTE: If you use both of the latter 2, it will throw an assertion error related to bounds in the debug version, but not in the built version.

Start with the ammeter in the play area

Use circuitConstructionKitDc.introScreen.model.ammeter1.visibleProperty.

API for show/hide electrons Property in the model

Use circuitConstructionKitDc.introScreen.model.circuit.showCurrentProperty

Show/hide "Show Electrons" checkbox

Use circuitConstructionKitDc.introScreen.view.displayOptionsPanel.showCurrentCheckbox.visibleProperty but note the radio buttons below remain visible.

Hide the reset button and/or make sure it resets to correct customized initial state.

The reset button can be hidden with circuitConstructionKitDc.introScreen.view.resetAllButton.visibleProperty.

Make the PhET-iO logo unclickable (and remove hamburger)

Use circuitConstructionKitDc.general.view.navigationBar.phetButton.enabledProperty

I'll work on this for the DC simulation.

[samreid]

I published a version here but noticed not all of the requests are "featured".

https://phet-dev.colorado.edu/html/circuit-construction-kit-dc/1.2.0-dev.3/phet-io/

I think I should make those requests featured and post a new version.

[samreid]

Here's a dev version that features the items above:
https://phet-dev.colorado.edu/html/circuit-construction-kit-dc/1.2.0-dev.4/phet-io/

I did some basic testing on save/loading circuits and didn't see any obvious problems.

[samreid]

I'll work on turning off the common code sound effects in #562. @kathy-phet what level of testing or QA do you want to complete before delivering this to the client?

[samreid]

I disabled the common code sound effects and published a new dev version here:
https://phet-dev.colorado.edu/html/circuit-construction-kit-dc/1.2.0-dev.5/phet-io/

[samreid]

@kathy-phet and @arouinfar reported they will be reviewing this today. I ran through the phetioIDs in the issue description #589 (comment) and confirmed they are all working as expected. I'll publish a dev version at https://phet-dev.colorado.edu/html/circuit-construction-kit-dc/1.2.0-dev.6/phet-io/

UPDATE: I noticed that if you hide the resistor from the carousel, then drag something else, the resistor reappears in the toolbox. I'll investigate.

UPDATE: I posted a version here which is a little better:
https://phet-dev.colorado.edu/html/circuit-construction-kit-dc/1.2.0-dev.7/phet-io/wrappers/studio/

In this version, dragging out other components or resetting doesn't restore the resistor tool. But dragging the resistor tool to to the toolbox restores it. I'll wait for guidance on how to proceed here, but here are some options:

• instrument the "max number" of resistors. Setting the max to 1 and starting with a resistor in the play area would mean that you can put it back in the toolbox and get it back out.
• Making it impossible to drop in a circuit element that has been disabled. But we would need another "channel" or phetioID for this.

[samreid]

@kathy-phet indicated her and @arouinfar work will resume on this early December.

[samreid]

This has been prioritized for the upcoming quarter. We may work on some design work, but implementation work will wait until after AC 1.0 is published. I'd also like to move to TypeScript before doing the phet-io instrumentation.

[samreid]

UPDATE: I moved this comment to #513 (comment)

[samreid]

Since we are moving forward with the full phet-io instrumentation (instead of this "basic" version), I opened side issues for the remaining work and will close this one.