Renaming PhotonState for QuantumPossibleState to avoid future confusi…

…on with serialization, see #65

js/photons/model/Mirror.ts

@@ -13,7 +13,7 @@ import { EmptySelfOptions } from '../../../../phet-core/js/optionize.js';
 import PickRequired from '../../../../phet-core/js/types/PickRequired.js';
 import { PhetioObjectOptions } from '../../../../tandem/js/PhetioObject.js';
 import quantumMeasurement from '../../quantumMeasurement.js';
-import Photon, { DOWN, PhotonState } from './Photon.js';
+import Photon, { DOWN, QuantumPossibleState } from './Photon.js';
 import { PhotonInteractionTestResult } from './PhotonsModel.js';
 import { TPhotonInteraction } from './TPhotonInteraction.js';
 
@@ -40,7 +40,7 @@ export default class Mirror implements TPhotonInteraction {
     this.mirrorSurfaceLine = new Line( endpoint1, endpoint2 );
   }
 
-  public testForPhotonInteraction( photonState: PhotonState, photon: Photon, dt: number ): PhotonInteractionTestResult {
+  public testForPhotonInteraction( photonState: QuantumPossibleState, photon: Photon, dt: number ): PhotonInteractionTestResult {
 
     assert && assert( photon.activeProperty.value, 'save CPU cycles - don\'t use this method with inactive photons' );
 

js/photons/model/Photon.ts

@@ -30,10 +30,10 @@ type possiblePolarizationResult = 'vertical' | 'horizontal';
 
 // TODO: This class could live in its own file, once the feature is fully green lit, will move https://github.com/phetsims/quantum-measurement/issues/63
 /**
- * PhotonState is a class that represents a possible state of a photon at a given point in time.
+ * QuantumPossibleState is a class that represents a possible state of a photon at a given point in time.
  * It contains properties for position, direction and the probability of the photon being in that state.
  */
-export class PhotonState {
+export class QuantumPossibleState {
   public readonly positionProperty: Vector2Property;
   public readonly directionProperty: Vector2Property;
   public readonly probabilityProperty: NumberProperty;
@@ -86,7 +86,7 @@ export default class Photon extends PhetioObject {
 
   // Contains all the possible states of the photon, which include position, direction, and probability.
   // Since they contain properties, and based on the design of this simulation, it will always have two states.
-  public possibleStates: [ PhotonState, PhotonState ];
+  public possibleStates: [ QuantumPossibleState, QuantumPossibleState ];
 
   // whether this photon is active, and should thus be moved by the model and shown in the view
   public readonly activeProperty: BooleanProperty;
@@ -110,8 +110,8 @@ export default class Photon extends PhetioObject {
     } );
 
     this.possibleStates = [
-      new PhotonState( 'vertical', tandem.createTandem( 'verticalState' ) ),
-      new PhotonState( 'horizontal', tandem.createTandem( 'horizontalState' ) )
+      new QuantumPossibleState( 'vertical', tandem.createTandem( 'verticalState' ) ),
+      new QuantumPossibleState( 'horizontal', tandem.createTandem( 'horizontalState' ) )
     ];
 
     // Entangle the possible states

js/photons/model/PhotonDetector.ts

@@ -18,7 +18,7 @@ import { PhetioObjectOptions } from '../../../../tandem/js/PhetioObject.js';
 import AveragingCounterNumberProperty from '../../common/model/AveragingCounterNumberProperty.js';
 import quantumMeasurement from '../../quantumMeasurement.js';
 import { PHOTON_BEAM_WIDTH } from './Laser.js';
-import Photon, { PhotonState } from './Photon.js';
+import Photon, { QuantumPossibleState } from './Photon.js';
 import { PhotonInteractionTestResult } from './PhotonsModel.js';
 import { TPhotonInteraction } from './TPhotonInteraction.js';
 
@@ -88,7 +88,7 @@ export default class PhotonDetector implements TPhotonInteraction {
     } );
   }
 
-  public testForPhotonInteraction( photonState: PhotonState, photon: Photon, dt: number ): PhotonInteractionTestResult {
+  public testForPhotonInteraction( photonState: QuantumPossibleState, photon: Photon, dt: number ): PhotonInteractionTestResult {
 
     assert && assert( photon.activeProperty.value, 'save CPU cycles - don\'t use this method with inactive photons' );
 

js/photons/model/PolarizingBeamSplitter.ts

@@ -16,7 +16,7 @@ import { Line } from '../../../../kite/js/imports.js';
 import PickRequired from '../../../../phet-core/js/types/PickRequired.js';
 import { PhetioObjectOptions } from '../../../../tandem/js/PhetioObject.js';
 import quantumMeasurement from '../../quantumMeasurement.js';
-import Photon, { PhotonState, RIGHT, UP } from './Photon.js';
+import Photon, { QuantumPossibleState, RIGHT, UP } from './Photon.js';
 import { PhotonInteractionTestResult } from './PhotonsModel.js';
 import { TPhotonInteraction } from './TPhotonInteraction.js';
 
@@ -49,7 +49,7 @@ export default class PolarizingBeamSplitter implements TPhotonInteraction {
     this.polarizingSurfaceLine = new Line( endpoint1, endpoint2 );
   }
 
-  public testForPhotonInteraction( photonState: PhotonState, photon: Photon, dt: number ): PhotonInteractionTestResult {
+  public testForPhotonInteraction( photonState: QuantumPossibleState, photon: Photon, dt: number ): PhotonInteractionTestResult {
 
     assert && assert( photon.activeProperty.value, 'save CPU cycles - don\'t use this method with inactive photons' );
 

js/photons/model/TPhotonInteraction.ts

@@ -6,9 +6,9 @@
  * @author John Blanco, PhET Interactive Simulations
  */
 
-import Photon, { PhotonState } from './Photon.js';
+import Photon, { QuantumPossibleState } from './Photon.js';
 import { PhotonInteractionTestResult } from './PhotonsModel.js';
 
 export type TPhotonInteraction = {
-  testForPhotonInteraction( state: PhotonState, photon: Photon, dt: number ): PhotonInteractionTestResult;
+  testForPhotonInteraction( state: QuantumPossibleState, photon: Photon, dt: number ): PhotonInteractionTestResult;
 };