Move all StatsScreen-specific parameters into model options - #313

js/common/ProjectileMotionConstants.js

@@ -37,8 +37,9 @@ const ProjectileMotionConstants = {
   CANNONBALL_DRAG_COEFFICIENT: 0.47,
 
   // productive constraints
-  MAX_NUMBER_OF_TRAJECTORIES: 150,
-  RAPID_FIRE_DELTA_TIME: 0.1,
+  MAX_NUMBER_OF_TRAJECTORIES: 10,
+  MAX_NUMBER_OF_TRAJECTORIES_STATS: 20,
+  RAPID_FIRE_DELTA_TIME: 0.2,
 
   //group size
   GROUP_SIZE_DEFAULT: 20,

js/common/model/ProjectileMotionModel.js

@@ -42,7 +42,7 @@ const TIME_PER_DATA_POINT = ProjectileMotionConstants.TIME_PER_DATA_POINT; // ms
 
 class ProjectileMotionModel {
   /**
-   * @param {ProjectileObjectType} defaultProjectileObjectType -  default object type for the each model
+   * @param {ProjectileObjectType} defaultProjectileObjectType -  default object type for the model
    * @param {boolean} defaultAirResistance -  default air resistance on value
    * @param {ProjectileObjectType[]} possibleObjectTypes - a list of the possible ProjectileObjectTypes for the model
    * @param {Tandem} tandem
@@ -57,20 +57,22 @@ class ProjectileMotionModel {
   ) {
     options = merge(
       {
+        maxProjectiles: ProjectileMotionConstants.MAX_NUMBER_OF_TRAJECTORIES,
         defaultCannonHeight: 0,
         defaultCannonAngle: 80,
         defaultInitialSpeed: 18,
-        defaultSpeedStandardDeviation: 1,
-        defaultAngleStandardDeviation: 2,
-        phetioInstrumentAltitudeProperty: true,
-        statsScreen: false
+        defaultSpeedStandardDeviation: 0,
+        defaultAngleStandardDeviation: 0,
+        phetioInstrumentAltitudeProperty: true
       },
       options
     );
 
     assert && assert( defaultProjectileObjectType instanceof ProjectileObjectType,
       'defaultProjectileObjectType should be a ProjectileObjectType' );
 
+    this.maxProjectiles = options.maxProjectiles;
+
     // @public {Target} model for handling scoring ( if/when projectile hits target )
     this.target = new Target(
       ProjectileMotionConstants.TARGET_X_DEFAULT,
@@ -95,11 +97,8 @@ class ProjectileMotionModel {
       }
     );
 
-    const speedInitialSD = options.statsScreen ? options.defaultSpeedStandardDeviation : 0;
-    const angleInitialSD = options.statsScreen ? options.defaultAngleStandardDeviation : 0;
-
     // @public {Property.<number>}
-    this.initialSpeedStandardDeviationProperty = new NumberProperty( speedInitialSD, {
+    this.initialSpeedStandardDeviationProperty = new NumberProperty( options.defaultSpeedStandardDeviation, {
       tandem: tandem.createTandem( 'initialSpeedStandardDeviationProperty' ),
       phetioDocumentation: 'The standard deviation of the launch speed',
       units: 'm/s',
@@ -120,7 +119,7 @@ class ProjectileMotionModel {
     );
 
     // @public {Property.<number>}
-    this.initialAngleStandardDeviationProperty = new NumberProperty( angleInitialSD, {
+    this.initialAngleStandardDeviationProperty = new NumberProperty( options.defaultAngleStandardDeviation, {
       tandem: tandem.createTandem( 'initialAngleStandardDeviationProperty' ),
       phetioDocumentation: 'The standard deviation of the launch angle',
       units: '\u00B0', // degrees
@@ -265,10 +264,10 @@ class ProjectileMotionModel {
     this.fireEnabledProperty = new DerivedProperty(
       [ this.numberOfMovingProjectilesProperty, this.rapidFireModeProperty ],
       ( numMoving, rapidFireMode ) =>
-        !rapidFireMode && numMoving < ProjectileMotionConstants.MAX_NUMBER_OF_TRAJECTORIES,
+        !rapidFireMode && numMoving < this.maxProjectiles,
       {
         tandem: tandem.createTandem( 'fireEnabledProperty' ),
-        phetioDocumentation: `The fire button is only enabled if there are less than ${ProjectileMotionConstants.MAX_NUMBER_OF_TRAJECTORIES} projectiles in the air.`,
+        phetioDocumentation: `The fire button is only enabled if there are less than ${this.maxProjectiles} projectiles in the air.`,
         phetioValueType: BooleanIO
       }
     );
@@ -294,7 +293,7 @@ class ProjectileMotionModel {
       phetioReadOnly: true
     } );
 
-    // @public {PhetioGroup.<Trajectory>} a group of trajectories, limited to MAX_NUMBER_OF_TRAJECTORIES
+    // @public {PhetioGroup.<Trajectory>} a group of trajectories, limited to this.maxProjectiles
     // Create this after model properties to support the PhetioGroup creating the prototype immediately
     this.trajectoryGroup = Trajectory.createGroup( this, tandem.createTandem( 'trajectoryGroup' ) );
 
@@ -398,7 +397,7 @@ class ProjectileMotionModel {
   limitTrajectories() {
     // create a temporary array to hold all trajectories to be disposed, to avoid array mutation of trajectoryGroup while looping
     const trajectoriesToDispose = [];
-    const numTrajectoriesToDispose = this.trajectoryGroup.count - ProjectileMotionConstants.MAX_NUMBER_OF_TRAJECTORIES;
+    const numTrajectoriesToDispose = this.trajectoryGroup.count - this.maxProjectiles;
     if ( numTrajectoriesToDispose > 0 ) {
       for ( let i = 0; i < this.trajectoryGroup.count; i++ ) {
         const trajectory = this.trajectoryGroup.getElement( i );
@@ -442,7 +441,6 @@ class ProjectileMotionModel {
     }
 
     this.limitTrajectories();
-    this.updateTrajectoryRanksEmitter.emit(); // increment rank of all trajectories
   }
 
   /**

js/common/model/Trajectory.js

@@ -27,13 +27,9 @@ import NullableIO from '../../../../tandem/js/types/NullableIO.js';
 import NumberIO from '../../../../tandem/js/types/NumberIO.js';
 import ReferenceIO from '../../../../tandem/js/types/ReferenceIO.js';
 import projectileMotion from '../../projectileMotion.js';
-import ProjectileMotionConstants from '../ProjectileMotionConstants.js';
 import DataPoint from './DataPoint.js';
 import ProjectileObjectType from './ProjectileObjectType.js';
 
-// constants
-const MAX_NUMBER_OF_TRAJECTORIES = ProjectileMotionConstants.MAX_NUMBER_OF_TRAJECTORIES;
-
 class Trajectory extends PhetioObject {
 
   /**
@@ -131,8 +127,8 @@ class Trajectory extends PhetioObject {
       phetioDocumentation: `${
         'The count of how old this projectile trajectory is. Older trajectories have more ' +
         'opacity until they are subsequently removed. The most recent trajectory fired has rank 0. ' +
-        'The second most recent has rank 1. The oldest still on screen has rank '
-      }${MAX_NUMBER_OF_TRAJECTORIES - 1}`,
+        'The second most recent has rank 1.'
+      }`,
       phetioReadOnly: true
     } );
 

js/common/view/ProjectileMotionScreenView.js

@@ -70,23 +70,22 @@ class ProjectileMotionScreenView extends ScreenView {
    * @param {ProjectileMotionViewProperties} viewProperties - Properties that determine which vectors are shown
    * @param {Tandem} tandem
    * @param {Object} [options]
-   * @param {boolean} showPaths - show the trajectory paths
    */
   constructor(
     model,
     topRightPanel,
     bottomRightPanel,
     viewProperties,
     tandem,
-    options,
-    maxNumberOfTrajectories = ProjectileMotionConstants.MAX_NUMBER_OF_TRAJECTORIES,
-    constantTrajectoryOpacity = false,
-    showPaths = true
+    options
   ) {
     options = merge( {
       tandem: tandem,
       cannonNodeOptions: {},
-      addFlatirons: true // if false, then flatirons easteregg will never be shown
+      addFlatirons: true, // if false, then flatirons easteregg will never be shown
+      maxTrajectories: ProjectileMotionConstants.MAX_NUMBER_OF_TRAJECTORIES, // max number of trajectories that can be shown
+      showPaths: true, // if false, trajectory paths will not be drawn
+      constantTrajectoryOpacity: false // if true, trajectory paths will not be faded when new ones are added
     }, options );
 
     super( options );
@@ -124,9 +123,9 @@ class ProjectileMotionScreenView extends ScreenView {
         viewProperties,
         addedTrajectory,
         transformProperty,
-        maxNumberOfTrajectories,
-        constantTrajectoryOpacity,
-        showPaths
+        options.maxTrajectories,
+        options.showPaths,
+        options.constantTrajectoryOpacity
       );
 
       // add the view to scene graph

js/common/view/TrajectoryNode.js

@@ -47,9 +47,9 @@ class TrajectoryNode extends Node {
     viewProperties,
     trajectory,
     transformProperty,
-    maxNumberOfTrajectories = ProjectileMotionConstants.MAX_NUMBER_OF_TRAJECTORIES,
-    constantTrajectoryOpacity = false,
-    showPath = true
+    maxNumberOfTrajectories,
+    showPath,
+    constantTrajectoryOpacity
   ) {
     super( { pickable: false, preventFit: true } );
 

js/stats/model/StatsModel.js

@@ -35,11 +35,13 @@ class StatsModel extends ProjectileMotionModel {
     ];
 
     super( objectTypes[ 0 ], false, objectTypes, tandem, {
+      maxProjectiles: ProjectileMotionConstants.MAX_NUMBER_OF_TRAJECTORIES_STATS,
       defaultCannonHeight: 2,
       defaultCannonAngle: 60,
       defaultInitialSpeed: 15,
-      phetioInstrumentAltitudeProperty: false,
-      statsScreen: true
+      defaultSpeedStandardDeviation: 1,
+      defaultAngleStandardDeviation: 2,
+      phetioInstrumentAltitudeProperty: false
     } );
 
     this.objectTypes = objectTypes;
@@ -60,10 +62,10 @@ class StatsModel extends ProjectileMotionModel {
     this.fireMultipleEnabledProperty = new DerivedProperty(
       [ this.numberOfMovingProjectilesProperty, this.groupSizeProperty, this.rapidFireModeProperty ],
       ( numMoving, groupSize, rapidFireMode ) =>
-        !rapidFireMode && numMoving + groupSize <= ProjectileMotionConstants.MAX_NUMBER_OF_TRAJECTORIES,
+        !rapidFireMode && numMoving + groupSize <= ProjectileMotionConstants.MAX_NUMBER_OF_TRAJECTORIES_STATS,
       {
         tandem: tandem.createTandem( 'fireMultipleEnabledProperty' ),
-        phetioDocumentation: `The fire-multi button is only enabled if the number of moving projectiles would not exceed ${ProjectileMotionConstants.MAX_NUMBER_OF_TRAJECTORIES}.`,
+        phetioDocumentation: `The fire-multi button is only enabled if the number of moving projectiles would not exceed ${ProjectileMotionConstants.MAX_NUMBER_OF_TRAJECTORIES_STATS}.`,
         phetioValueType: BooleanIO
       }
     );

js/stats/view/StatsScreenView.js

@@ -30,7 +30,11 @@ class StatsScreenView extends ProjectileMotionScreenView {
   constructor( model, tandem, options ) {
     options = merge( {
       addFlatirons: false,
-      cannonNodeOptions: { preciseCannonDelta: true }
+      cannonNodeOptions: { preciseCannonDelta: true },
+      maxTrajectories: ProjectileMotionConstants.MAX_NUMBER_OF_TRAJECTORIES_STATS,
+      showPaths: false,
+      constantTrajectoryOpacity: true
+
     }, options );
 
     // contains Properties about vector visibility, used in super class
@@ -80,10 +84,7 @@ class StatsScreenView extends ProjectileMotionScreenView {
       statsPanel,
       visibilityProperties,
       tandem,
-      options,
-      ProjectileMotionConstants.MAX_NUMBER_OF_TRAJECTORIES,
-      true, //constantTrajectoryOpacity
-      false //showPaths
+      options
     );
 
     // @private