Merge remote-tracking branch 'origin/master'

# Conflicts: # js/common/enum/ForcesModeChoice.js # js/common/enum/SimSpeedChoice.js
phetsims · Jan 30, 2019 · 1fab22b · 1fab22b
2 parents 7f2c2e1 + 5fd6d9b
commit 1fab22b
Show file tree

Hide file tree

Showing 30 changed files with 42 additions and 32 deletions.
diff --git a/js/common/model/MassesAndSpringsModel.js b/js/common/model/MassesAndSpringsModel.js
@@ -1,4 +1,4 @@
-// Copyright 2016-2018, University of Colorado Boulder
+// Copyright 2016-2019, University of Colorado Boulder
 
 /**
  * Common model (base type) for Masses and Springs

diff --git a/js/common/model/Spring.js b/js/common/model/Spring.js
@@ -1,4 +1,4 @@
-// Copyright 2016-2018, University of Colorado Boulder
+// Copyright 2016-2019, University of Colorado Boulder
 
 /**
  * Responsible for the attributes associated with each spring.
@@ -55,6 +55,8 @@ define( function( require ) {
     } );
 
     // Link to manage gravity value for the spring object.
+    // REVIEW: This would be a leak if springs keep sharing one gravity property (and springs could be created).
+    // REVIEW: Probably a good place to mention object lifetimes.
     gravityProperty.link( function( gravity ) {
       self.gravityProperty.set( gravity );
     } );
@@ -621,5 +623,4 @@ define( function( require ) {
       }
     }
   } );
-} )
-;
+} );
diff --git a/js/common/view/DraggableRulerNode.js b/js/common/view/DraggableRulerNode.js
@@ -1,4 +1,4 @@
-// Copyright 2017-2018, University of Colorado Boulder
+// Copyright 2017-2019, University of Colorado Boulder
 
 /**
  * Responsible for the attributes and drag handlers associated with the ruler node.

diff --git a/js/common/view/DraggableTimerNode.js b/js/common/view/DraggableTimerNode.js
@@ -1,4 +1,4 @@
-// Copyright 2017-2018, University of Colorado Boulder
+// Copyright 2017-2019, University of Colorado Boulder
 
 /**
  * Responsible for the attributes and drag handlers associated with the timer node.

diff --git a/js/common/view/EnergyGraphNode.js b/js/common/view/EnergyGraphNode.js
@@ -1,4 +1,4 @@
-// Copyright 2017-2018, University of Colorado Boulder
+// Copyright 2017-2019, University of Colorado Boulder
 
 /**
  * Bar graph that represents the kinetic, potential, elastic potential, thermal, and total energy of the mass attached
@@ -111,6 +111,9 @@ define( function( require ) {
       },
       scale: 0.7
     } );
+
+    // REVIEW: Probably good to mention the lifetime of this, since this would be a memory leak if many of these are
+    // REVIEW: created.
     model.firstSpring.thermalEnergyProperty.link( function( value ) {
       clearThermalButton.enabled = ( value > 0 );
       clearThermalButton.pickable = ( value > 0 );

diff --git a/js/common/view/ForceVectorArrow.js b/js/common/view/ForceVectorArrow.js
@@ -1,4 +1,4 @@
-// Copyright 2017-2018, University of Colorado Boulder
+// Copyright 2017-2019, University of Colorado Boulder
 
 /**
  * Responsible for the creation of the arrowNodes associated with the masses and visibility panels.

diff --git a/js/common/view/GravityAndDampingControlNode.js b/js/common/view/GravityAndDampingControlNode.js
@@ -1,4 +1,4 @@
-// Copyright 2017-2018, University of Colorado Boulder
+// Copyright 2017-2019, University of Colorado Boulder
 
 /**
  * Node for the gravity control panel and combo box for planet gravity options.
@@ -254,6 +254,8 @@ define( function( require ) {
     }
 
     // Responsible for managing bodies
+    // REVIEW: Probably good to mention the lifetime of this, since this would be a memory leak if many of these are
+    // REVIEW: created.
     model.bodyProperty.link( function( newBody, oldBody ) {
       var body = _.find( Body.BODIES, newBody );
 

diff --git a/js/common/view/GravityComboBox.js b/js/common/view/GravityComboBox.js
@@ -1,4 +1,4 @@
-// Copyright 2017-2019, University of Colorado Boulder
+// Copyright 2019, University of Colorado Boulder
 
 /**
  * ComboBox used for selecting planets.

diff --git a/js/common/view/MassNode.js b/js/common/view/MassNode.js
@@ -1,4 +1,4 @@
-// Copyright 2017-2018, University of Colorado Boulder
+// Copyright 2017-2019, University of Colorado Boulder
 
 /**
  * Node responsible for representing the mass object.
@@ -79,6 +79,8 @@ define( function( require ) {
       } );
 
     // Update the size of the massNode
+    // REVIEW: Probably good to mention the lifetime of this, since this would be a memory leak if many of these are
+    // REVIEW: created for a single mass
     mass.radiusProperty.link( function( radiusValue ) {
 
       self.rect.rectBounds = new Bounds2(

diff --git a/js/common/view/MassValueControlPanel.js b/js/common/view/MassValueControlPanel.js
@@ -1,4 +1,4 @@
-// Copyright 2017-2018, University of Colorado Boulder
+// Copyright 2017-2019, University of Colorado Boulder
 
 /**
  * Panel that is responsible for adjusting the value of its corresponding mass.

diff --git a/js/common/view/MovableLineNode.js b/js/common/view/MovableLineNode.js
@@ -1,4 +1,4 @@
-// Copyright 2017-2018, University of Colorado Boulder
+// Copyright 2017-2019, University of Colorado Boulder
 
 /**
  * Node for the reference line and laser pointer node.

diff --git a/js/common/view/OneSpringScreenView.js b/js/common/view/OneSpringScreenView.js
@@ -1,4 +1,4 @@
-// Copyright 2016-2018, University of Colorado Boulder
+// Copyright 2016-2019, University of Colorado Boulder
 
 /**
  * Common ScreenView for using one mass.

diff --git a/js/common/view/OscillatingSpringNode.js b/js/common/view/OscillatingSpringNode.js
@@ -1,4 +1,4 @@
-// Copyright 2017-2018, University of Colorado Boulder
+// Copyright 2017-2019, University of Colorado Boulder
 
 /**
  * Node for handling the representation of an oscillating spring.
@@ -73,6 +73,7 @@ define( function( require ) {
       self.y = modelViewTransform2.modelToViewY( spring.positionProperty.get().y - spring.lengthProperty.get() );
     }
 
+    // REVIEW: Probably worth noting that this type creates permanent listeners.
     spring.naturalRestingLengthProperty.link( function( springLength ) {
       self.loopsProperty.set( MAP_NUMBER_OF_LOOPS( springLength ) );
       updateViewLength();

diff --git a/js/common/view/ReferenceLineNode.js b/js/common/view/ReferenceLineNode.js
@@ -1,4 +1,4 @@
-// Copyright 2017-2018, University of Colorado Boulder
+// Copyright 2017-2019, University of Colorado Boulder
 
 /**
  * Responsible for the attributes associated with the reference line nodes.

diff --git a/js/common/view/ShelfNode.js b/js/common/view/ShelfNode.js
@@ -1,4 +1,4 @@
-// Copyright 2017, University of Colorado Boulder
+// Copyright 2017-2019, University of Colorado Boulder
 
 /**
  * Shelf used to house the masses when they are not being dragged or attached to a spring

diff --git a/js/common/view/SpringControlPanel.js b/js/common/view/SpringControlPanel.js
@@ -1,4 +1,4 @@
-// Copyright 2016-2018, University of Colorado Boulder
+// Copyright 2016-2019, University of Colorado Boulder
 
 /**
  * Panel responsible for adjusting the a Property of the spring using an hslider.

diff --git a/js/common/view/SpringHangerNode.js b/js/common/view/SpringHangerNode.js
@@ -1,4 +1,4 @@
-// Copyright 2017-2018, University of Colorado Boulder
+// Copyright 2017-2019, University of Colorado Boulder
 
 /**
  * Object that creates the grey bar that the springs hang from and their respective numerical label.

diff --git a/js/common/view/SpringScreenView.js b/js/common/view/SpringScreenView.js
@@ -1,4 +1,4 @@
-// Copyright 2017-2018, University of Colorado Boulder
+// Copyright 2017-2019, University of Colorado Boulder
 
 /**
  * Common ScreenView used for both singular and multispring screen view.

diff --git a/js/common/view/ToolboxPanel.js b/js/common/view/ToolboxPanel.js
@@ -1,4 +1,4 @@
-// Copyright 2017-2018, University of Colorado Boulder
+// Copyright 2017-2019, University of Colorado Boulder
 
 /**
  * Responsible for the toolbox panel and the ruler/timer icons held within

diff --git a/js/common/view/VectorArrow.js b/js/common/view/VectorArrow.js
@@ -1,4 +1,4 @@
-// Copyright 2017-2018, University of Colorado Boulder
+// Copyright 2017-2019, University of Colorado Boulder
 
 /**
  * Responsible for the creation of the arrowNodes associated with the masses and visibility panels.

diff --git a/js/energy/model/EnergyModel.js b/js/energy/model/EnergyModel.js
@@ -1,4 +1,4 @@
-// Copyright 2017-2018, University of Colorado Boulder
+// Copyright 2017-2019, University of Colorado Boulder
 
 /**
  * Energy model (base type) for Masses and Springs

diff --git a/js/intro/enum/SceneModeChoice.js b/js/intro/enum/SceneModeChoice.js
@@ -1,4 +1,4 @@
-// Copyright 2018, University of Colorado Boulder
+// Copyright 2018-2019, University of Colorado Boulder
 
 /**
  * Enumeration for scene mode choices intro screen.

diff --git a/js/intro/model/IntroModel.js b/js/intro/model/IntroModel.js
@@ -1,4 +1,4 @@
-// Copyright 2016-2018, University of Colorado Boulder
+// Copyright 2016-2019, University of Colorado Boulder
 
 /**
  * Intro model (base type) for Masses and Springs

diff --git a/js/intro/view/ConstantsControlPanel.js b/js/intro/view/ConstantsControlPanel.js
@@ -1,4 +1,4 @@
-// Copyright 2017-2018, University of Colorado Boulder
+// Copyright 2017-2019, University of Colorado Boulder
 
 /**
  * Panel responsible for keeping the spring constant and spring thickness constant.
@@ -59,6 +59,7 @@ define( function( require ) {
       } );
 
     var constantText = new Text(
+      // REVIEW: Why the fill in with an empty string? Looks suspicious
       StringUtils.fillIn( springConstantString, { spring: '' } ),
       _.extend( { font: TITLE_FONT, tandem: tandem.createTandem( 'constantText' ) },
         constantsSelectionButtonOptions ) );

diff --git a/js/intro/view/IntroScreenView.js b/js/intro/view/IntroScreenView.js
@@ -1,4 +1,4 @@
-// Copyright 2016-2018, University of Colorado Boulder
+// Copyright 2016-2019, University of Colorado Boulder
 
 /**
  * ScreenView for the 'Intro' screen

diff --git a/js/lab/model/LabModel.js b/js/lab/model/LabModel.js
@@ -1,4 +1,4 @@
-// Copyright 2016-2018, University of Colorado Boulder
+// Copyright 2016-2019, University of Colorado Boulder
 
 /**
  * Lab model (base type) for Masses and Springs

diff --git a/js/lab/view/LabScreenView.js b/js/lab/view/LabScreenView.js
@@ -1,4 +1,4 @@
-// Copyright 2016-2018, University of Colorado Boulder
+// Copyright 2016-2019, University of Colorado Boulder
 
 /**
  * Screen view used for lab screen.

diff --git a/js/lab/view/PeriodTraceNode.js b/js/lab/view/PeriodTraceNode.js
@@ -1,4 +1,4 @@
-// Copyright 2018, University of Colorado Boulder
+// Copyright 2018-2019, University of Colorado Boulder
 
 /**
  * View for period trace of mass oscillation.

diff --git a/js/vectors/view/IndicatorVisibilityControlNode.js b/js/vectors/view/IndicatorVisibilityControlNode.js
@@ -1,4 +1,4 @@
-// Copyright 2017-2018, University of Colorado Boulder
+// Copyright 2017-2019, University of Colorado Boulder
 
 /**
  * Panel that manages options for visibility of reference lines on vector screen.

diff --git a/js/vectors/view/VectorVisibilityControlNode.js b/js/vectors/view/VectorVisibilityControlNode.js
@@ -1,4 +1,4 @@
-// Copyright 2017-2018, University of Colorado Boulder
+// Copyright 2017-2019, University of Colorado Boulder
 
 /**
  * Panel that manages options visibility for vectors and period trace in Basics version.