samreid
commented
4 years ago Great idea! I mocked this up for the first screen and it read like so:
"data": {
"phetioID": "balancingAct.introScreen.model.smallTrashCan",
"mass": 10,
"distance": 0.5,
"fullState": [
{
"name": "balancingAct.introScreen.model.fireExtinguisher1",
"mass": 5,
"distance": 1.25
},
{
"name": "balancingAct.introScreen.model.smallTrashCan",
"mass": 10,
"distance": 0.5
}
]
}However, I realized to get this working for the creator pattern on the 2nd screen, we would likely need to introduce PhetioGroup for the elements to set their names. That will be a good long term plan but I don't know if I have enough time to implement that by tomorrow.
Here's the patch:
```diff
Index: js/common/model/Mass.js
IDEA additional info:
Subsystem: com.intellij.openapi.diff.impl.patch.CharsetEP
<+>UTF-8
===================================================================
--- js/common/model/Mass.js (revision bdb38565d338d01cc13b664945c92a2b62d6b7cd)
+++ js/common/model/Mass.js (date 1579544812001)
@@ -20,7 +20,7 @@
// TODO: JSDoc is missing in many places, see https://github.com/phetsims/balancing-act/issues/96
// TODO: Convert to ES6, see https://github.com/phetsims/balancing-act/issues/96
- function Mass( massValue, initialPosition, isMystery ) {
+ function Mass( massValue, initialPosition, isMystery, tandem ) {
const self = this;
// Property that indicates whether this mass is currently user controlled, i.e. being moved around by the user.
@@ -60,6 +60,10 @@
// that indicates where their center of mass is when placed on a balance.
// This is the horizontal offset from the center of the shape or image.
self.centerOfMassXOffset = 0;
+
+ // TODO: Should this be an instrumented PhetioObject, or an empty intermediate node? See https://github.com/phetsims/balancing-act/issues/99
+ // @public (read-only) {Tandem}
+ this.tandem = tandem;
}
balancingAct.register( 'Mass', Mass );
Index: js/intro/model/BAIntroModel.js
IDEA additional info:
Subsystem: com.intellij.openapi.diff.impl.patch.CharsetEP
<+>UTF-8
===================================================================
--- js/intro/model/BAIntroModel.js (revision bdb38565d338d01cc13b664945c92a2b62d6b7cd)
+++ js/intro/model/BAIntroModel.js (date 1579544422856)
@@ -26,9 +26,9 @@
BalanceModel.call( this, tandem );
// Add the initial masses and save their initial positions.
- this.addMass( new FireExtinguisher( new Vector2( 2.7, 0 ), false ) );
- this.addMass( new FireExtinguisher( new Vector2( 3.2, 0 ), false ) );
- this.addMass( new SmallTrashCan( new Vector2( 3.7, 0 ), false ) );
+ this.addMass( new FireExtinguisher( new Vector2( 2.7, 0 ), false, tandem.createTandem( 'fireExtinguisher1' ) ) );
+ this.addMass( new FireExtinguisher( new Vector2( 3.2, 0 ), false, tandem.createTandem( 'fireExtinguisher2' ) ) );
+ this.addMass( new SmallTrashCan( new Vector2( 3.7, 0 ), false, tandem.createTandem( 'smallTrashCan' ) ) );
}
balancingAct.register( 'BAIntroModel', BAIntroModel );
Index: js/common/model/masses/SmallTrashCan.js
IDEA additional info:
Subsystem: com.intellij.openapi.diff.impl.patch.CharsetEP
<+>UTF-8
===================================================================
--- js/common/model/masses/SmallTrashCan.js (revision bdb38565d338d01cc13b664945c92a2b62d6b7cd)
+++ js/common/model/masses/SmallTrashCan.js (date 1579544422862)
@@ -18,10 +18,11 @@
/**
* @param initialPosition
* @param isMystery
+ * @param {Tandem} tandem
* @constructor
*/
- function SmallTrashCan( initialPosition, isMystery ) {
- ImageMass.call( this, MASS, trashCanImage, HEIGHT, initialPosition, isMystery );
+ function SmallTrashCan( initialPosition, isMystery, tandem ) {
+ ImageMass.call( this, MASS, trashCanImage, HEIGHT, initialPosition, isMystery, tandem );
}
balancingAct.register( 'SmallTrashCan', SmallTrashCan );
Index: js/balancing-act-main.js
IDEA additional info:
Subsystem: com.intellij.openapi.diff.impl.patch.CharsetEP
<+>UTF-8
===================================================================
--- js/balancing-act-main.js (revision bdb38565d338d01cc13b664945c92a2b62d6b7cd)
+++ js/balancing-act-main.js (date 1579544757240)
@@ -8,7 +8,7 @@
// modules
const BAIntroScreen = require( 'BALANCING_ACT/intro/BAIntroScreen' );
- const BalanceGameScreen = require( 'BALANCING_ACT/game/BalanceGameScreen' );
+ // const BalanceGameScreen = require( 'BALANCING_ACT/game/BalanceGameScreen' );
const BalanceLabScreen = require( 'BALANCING_ACT/balancelab/BalanceLabScreen' );
const Sim = require( 'JOIST/Sim' );
const SimLauncher = require( 'JOIST/SimLauncher' );
@@ -35,7 +35,7 @@
new Sim( balancingActTitleString, [
new BAIntroScreen( tandem.createTandem( 'introScreen' ) ),
new BalanceLabScreen( tandem.createTandem( 'balanceLabScreen' ) ),
- new BalanceGameScreen( tandem.createTandem( 'gameScreen' ) )
+ // new BalanceGameScreen( tandem.createTandem( 'gameScreen' ) )
], simOptions ).start();
} );
} );
\ No newline at end of file
Index: js/common/model/masses/FireExtinguisher.js
IDEA additional info:
Subsystem: com.intellij.openapi.diff.impl.patch.CharsetEP
<+>UTF-8
===================================================================
--- js/common/model/masses/FireExtinguisher.js (revision bdb38565d338d01cc13b664945c92a2b62d6b7cd)
+++ js/common/model/masses/FireExtinguisher.js (date 1579543813116)
@@ -18,10 +18,11 @@
/**
* @param initialPosition
* @param isMystery
+ * @param {Tandem} tandem
* @constructor
*/
- function FireExtinguisher( initialPosition, isMystery ) {
- ImageMass.call( this, MASS, fireExtinguisherImage, HEIGHT, initialPosition, isMystery );
+ function FireExtinguisher( initialPosition, isMystery, tandem ) {
+ ImageMass.call( this, MASS, fireExtinguisherImage, HEIGHT, initialPosition, isMystery, tandem );
this.centerOfMassXOffset = 0.03; // Empirically determined.
}
Index: js/common/model/ImageMass.js
IDEA additional info:
Subsystem: com.intellij.openapi.diff.impl.patch.CharsetEP
<+>UTF-8
===================================================================
--- js/common/model/ImageMass.js (revision bdb38565d338d01cc13b664945c92a2b62d6b7cd)
+++ js/common/model/ImageMass.js (date 1579543869648)
@@ -26,10 +26,11 @@
* @param height
* @param initialPosition
* @param isMystery
+ * @param {Tandem} tandem
* @constructor
*/
- function ImageMass( mass, image, height, initialPosition, isMystery ) {
- Mass.call( this, mass, initialPosition, isMystery );
+ function ImageMass( mass, image, height, initialPosition, isMystery, tandem ) {
+ Mass.call( this, mass, initialPosition, isMystery, tandem );
// Property that contains the current image.
this.imageProperty = new Property( image );
Index: js/common/model/Plank.js
IDEA additional info:
Subsystem: com.intellij.openapi.diff.impl.patch.CharsetEP
<+>UTF-8
===================================================================
--- js/common/model/Plank.js (revision bdb38565d338d01cc13b664945c92a2b62d6b7cd)
+++ js/common/model/Plank.js (date 1579544336417)
@@ -22,6 +22,7 @@
const ObservableArray = require( 'AXON/ObservableArray' );
const Property = require( 'AXON/Property' );
const Shape = require( 'KITE/Shape' );
+ const StringIO = require( 'TANDEM/types/StringIO' );
const Vector2 = require( 'DOT/Vector2' );
// constants
@@ -73,8 +74,9 @@
this.massDroppedOnPlankEmitter = new Emitter( {
tandem: tandem.createTandem( 'massDroppedOnPlankEmitter' ),
parameters: [
+ { name: 'phetioID', phetioType: StringIO },
{ name: 'mass', phetioType: NumberIO },
- { name: 'position', phetioType: NumberIO },
+ { name: 'distance', phetioType: NumberIO },
{ name: 'fullState', phetioType: ObjectIO } ]
} );
@@ -82,8 +84,9 @@
this.massRemovedFromPlankEmitter = new Emitter( {
tandem: tandem.createTandem( 'massRemovedFromPlankEmitter' ),
parameters: [
+ { name: 'phetioID', phetioType: StringIO },
{ name: 'mass', phetioType: NumberIO },
- { name: 'position', phetioType: NumberIO },
+ { name: 'distance', phetioType: NumberIO },
{ name: 'fullState', phetioType: ObjectIO } ]
} );
@@ -202,20 +205,14 @@
};
this.massDistancePairs.push( result );
- const fullState = this.massDistancePairs.map( massDistancePair => {
- return {
- mass: massDistancePair.mass.massValue,
- distance: massDistancePair.distance
- };
- } );
- this.massDroppedOnPlankEmitter.emit( mass.massValue, result.distance, fullState );
+ this.massDroppedOnPlankEmitter.emit( mass.tandem.phetioID, mass.massValue, result.distance, this.getPhetioState() );
// Add the force vector for this mass.
this.forceVectors.push( new MassForceVector( mass ) );
// Add an observer that will remove this mass when the user picks it up.
const self = this;
- var userControlledObserver = function( userControlled ) {
+ const userControlledObserver = function( userControlled ) {
if ( userControlled ) {
// The user has picked up this mass, so it is no longer
// on the surface.
@@ -234,6 +231,20 @@
return massAdded;
},
+ /**
+ * @returns {Object}
+ * @private
+ */
+ getPhetioState() {
+ return this.massDistancePairs.map( massDistancePair => {
+ return {
+ name: massDistancePair.mass.tandem.phetioID,
+ mass: massDistancePair.mass.massValue,
+ distance: massDistancePair.distance
+ };
+ } )
+ },
+
// Add a mass to the specified location on the plank.
addMassToSurfaceAt: function( mass, distanceFromCenter ) {
if ( Math.abs( distanceFromCenter ) > PLANK_LENGTH / 2 ) {
@@ -283,14 +294,7 @@
const distance = this.massDistancePairs[ i ].distance;
this.massDistancePairs.splice( i, 1 );
-
- const fullState = this.massDistancePairs.map( massDistancePair => {
- return {
- mass: massDistancePair.mass.massValue,
- distance: massDistancePair.distance
- };
- } );
- this.massRemovedFromPlankEmitter.emit( mass.massValue, distance, fullState );
+ this.massRemovedFromPlankEmitter.emit( mass.tandem.phetioID, mass.massValue, distance, this.getPhetioState() );
break;
}
```
kathy-phet
chrisklus
marlitas
For https://github.com/phetsims/balancing-act/issues/96
@kathy-phet said: