State schema improvements, see #183

phetsims · Sep 30, 2021 · 8bba72b · 8bba72b
1 parent 18e56ce
commit 8bba72b
Show file tree

Hide file tree

Showing 4 changed files with 32 additions and 22 deletions.
diff --git a/js/common/model/Bond.js b/js/common/model/Bond.js
@@ -7,6 +7,8 @@
  * @author Jonathan Olson <[email protected]>
  */
 
+import IOType from '../../../../tandem/js/types/IOType.js';
+import NumberIO from '../../../../tandem/js/types/NumberIO.js';
 import moleculeShapes from '../../moleculeShapes.js';
 
 class Bond {
@@ -84,5 +86,16 @@ class Bond {
   }
 }
 
+// @public {IOType}
+Bond.BondIO = new IOType( 'BondIO', {
+  valueType: Bond,
+  stateSchema: {
+    a: NumberIO,
+    b: NumberIO,
+    order: NumberIO,
+    length: NumberIO
+  }
+} );
+
 moleculeShapes.register( 'Bond', Bond );
 export default Bond;
diff --git a/js/common/model/MoleculeShapesModel.js b/js/common/model/MoleculeShapesModel.js
@@ -18,7 +18,6 @@ import BooleanIO from '../../../../tandem/js/types/BooleanIO.js';
 import IOType from '../../../../tandem/js/types/IOType.js';
 import NullableIO from '../../../../tandem/js/types/NullableIO.js';
 import NumberIO from '../../../../tandem/js/types/NumberIO.js';
-import ObjectLiteralIO from '../../../../tandem/js/types/ObjectLiteralIO.js';
 import moleculeShapes from '../../moleculeShapes.js';
 import Bond from './Bond.js';
 import ElectronGeometry from './ElectronGeometry.js';
@@ -194,26 +193,8 @@ MoleculeShapesModel.MoleculeShapesModelIO = new IOType( 'MoleculeShapesModelIO',
 
   stateSchema: {
     isReal: BooleanIO,
-
-    // TODO: Provide IO Types to specify these schemas instead of ObjectLiteralIO, see https://github.com/phetsims/molecule-shapes/issues/183
-    // Shaped like this:
-    // {
-    //       position: Vector3.Vector3IO,
-    //       velocity: Vector3.Vector3IO,
-    //       isLonePair: BooleanIO,
-    //       element: NullableIO( StringIO ),
-    //       isCentralAtom: BooleanIO
-    //     }
-    groups: ArrayIO( ObjectLiteralIO ),
-
-    // Shaped like this:
-    //    {
-    //     a: NumberIO,
-    //     b: NumberIO,
-    //     order: NumberIO,
-    //     length: NumberIO
-    //   }
-    bonds: ArrayIO( ObjectLiteralIO ),
+    groups: ArrayIO( PairGroup.PairGroupIO ),
+    bonds: ArrayIO( Bond.BondIO ),
     realMoleculeShape: NullableIO( RealMoleculeShape.RealMoleculeShapeIO ),
     bondLengthOverride: NullableIO( NumberIO )
   }

diff --git a/js/common/model/PairGroup.js b/js/common/model/PairGroup.js
@@ -11,6 +11,10 @@ import Property from '../../../../axon/js/Property.js';
 import Vector3 from '../../../../dot/js/Vector3.js';
 import Element from '../../../../nitroglycerin/js/Element.js';
 import merge from '../../../../phet-core/js/merge.js';
+import BooleanIO from '../../../../tandem/js/types/BooleanIO.js';
+import IOType from '../../../../tandem/js/types/IOType.js';
+import NullableIO from '../../../../tandem/js/types/NullableIO.js';
+import StringIO from '../../../../tandem/js/types/StringIO.js';
 import moleculeShapes from '../../moleculeShapes.js';
 
 let nextId = 0;
@@ -323,4 +327,16 @@ function interpolate( a, b, ratio ) {
   return a * ( 1 - ratio ) + b * ratio;
 }
 
+// @public {IOType}
+PairGroup.PairGroupIO = new IOType( 'PairGroupIO', {
+  valueType: PairGroup,
+  stateSchema: {
+    position: Vector3.Vector3IO,
+    velocity: Vector3.Vector3IO,
+    isLonePair: BooleanIO,
+    element: NullableIO( StringIO ),
+    isCentralAtom: BooleanIO
+  }
+} );
+
 export default PairGroup;
diff --git a/js/common/view/OptionsNode.js b/js/common/view/OptionsNode.js
@@ -34,7 +34,7 @@ class OptionsNode extends VBox {
     const showLonePairsLabel = new Text( controlShowLonePairsString, {
       font: optionsFont,
       fill: MoleculeShapesColors.controlPanelTextProperty,
-      tandem: showBondAnglesCheckboxTandem.createTandem( 'labelText' )
+      tandem: showLonePairsCheckboxTandem.createTandem( 'labelText' )
     } );
 
     const showBondAnglesLabel = new Text( controlShowBondAnglesString, {