clean up formatting, comments, JSDoc, etc. #154

js/lens/LensScreen.js

@@ -19,17 +19,13 @@ class LensScreen extends Screen {
   constructor() {
 
     // create convex lens for home screen icon
-    const iconNode = CurveControl.createIconNode(
-      Optic.Curve.CONVEX,
-      Optic.Type.LENS,
-      {
-        radius: 20,
-        diameter: 30,
-        outline: { stroke: 'black' }
-      } );
+    const iconNode = CurveControl.createIconNode( Optic.Curve.CONVEX, Optic.Type.LENS, {
+      radius: 20,
+      diameter: 30,
+      outline: { stroke: 'black' }
+    } );
 
     const options = {
-
       name: geometricOpticsStrings.screen.lens,
       homeScreenIcon: new ScreenIcon( iconNode ),
       backgroundColorProperty: GeometricOpticsColors.screenBackgroundColorProperty
@@ -44,4 +40,4 @@ class LensScreen extends Screen {
 }
 
 geometricOptics.register( 'LensScreen', LensScreen );
-export default LensScreen;
+export default LensScreen;

js/lens/model/Guide.js

@@ -33,16 +33,16 @@ class Guide {
         return opticPosition.plusXY( 0, locationSign * opticDiameter / 2 );
       } );
 
-    // @public (read-only) {Property.<number>} angle of rotation of the incident guide with respect to the positive
-    // x-axis
+    // @public (read-only) {DerivedProperty.<number>}
+    // angle of rotation of the incident guide with respect to the positive x-axis
     this.incidentAngleProperty = new DerivedProperty( [ objectPositionProperty, this.fulcrumPositionProperty ],
       ( objectPosition, fulcrumPosition ) => {
         const displacementVector = objectPosition.minus( fulcrumPosition );
         return displacementVector.getAngle();
       } );
 
-    // @public (read-only) {Property.<number>} find the angle of the transmitted guide with respect to the positive
-    // x-axis
+    // @public (read-only) {DerivedProperty.<number>}
+    // find the angle of the transmitted guide with respect to the positive x-axis
     this.transmittedAngleProperty = new DerivedProperty( [ optic.focalLengthProperty,
         optic.diameterProperty,
         this.incidentAngleProperty ],
@@ -97,4 +97,4 @@ class Guide {
 Guide.Location = Enumeration.byKeys( [ 'TOP', 'BOTTOM' ] );
 
 geometricOptics.register( 'Guide', Guide );
-export default Guide;
+export default Guide;

js/lens/model/LensModel.js

@@ -10,44 +10,36 @@ import Optic from '../../common/model/Optic.js';
 import geometricOptics from '../../geometricOptics.js';
 import Guide from './Guide.js';
 
-const INDEX_OF_REFRACTION_RANGE = GeometricOpticsConstants.LENS_INDEX_OF_REFRACTION_RANGE;
-const RADIUS_OF_CURVATURE_RANGE = GeometricOpticsConstants.LENS_RADIUS_OF_CURVATURE_RANGE;
-const DIAMETER_RANGE = GeometricOpticsConstants.LENS_DIAMETER_RANGE;
-const INITIAL_CURVATURE_TYPE = GeometricOpticsConstants.LENS_INITIAL_CURVATURE_TYPE;
-const INITIAL_POSITION = GeometricOpticsConstants.LENS_INITIAL_POSITION;
-
 class LensModel extends GeometricOpticsModel {
 
   constructor() {
 
-    super( INITIAL_POSITION, RADIUS_OF_CURVATURE_RANGE, DIAMETER_RANGE,
-      INDEX_OF_REFRACTION_RANGE, INITIAL_CURVATURE_TYPE, Optic.Type.LENS );
+    super(
+      GeometricOpticsConstants.LENS_INITIAL_POSITION,
+      GeometricOpticsConstants.LENS_RADIUS_OF_CURVATURE_RANGE,
+      GeometricOpticsConstants.LENS_DIAMETER_RANGE,
+      GeometricOpticsConstants.LENS_INDEX_OF_REFRACTION_RANGE,
+      GeometricOpticsConstants.LENS_INITIAL_CURVATURE_TYPE,
+      Optic.Type.LENS
+    );
 
     // @public {Guide} model for top guide associated with the first source/object
     this.firstTopGuide = new Guide( this.sourceObject.firstPositionProperty, this.optic );
 
     // @public {Guide} model for bottom guide associated with the first source/object
-    this.firstBottomGuide = new Guide( this.sourceObject.firstPositionProperty, this.optic,
-      { location: Guide.Location.BOTTOM } );
+    this.firstBottomGuide = new Guide( this.sourceObject.firstPositionProperty, this.optic, {
+      location: Guide.Location.BOTTOM
+    } );
 
     // @public {Guide} model for top guide associated with the second source/object
     this.secondTopGuide = new Guide( this.sourceObject.secondPositionProperty, this.optic );
 
     // @public {Guide} model for bottom guide associated with the second source/object
-    this.secondBottomGuide = new Guide( this.sourceObject.secondPositionProperty, this.optic,
-      { location: Guide.Location.BOTTOM } );
-
-  }
-
-  /**
-   * REVIEW: you don't need to override just to call to super.
-   * Resets the model.
-   * @public
-   */
-  reset() {
-    super.reset();
+    this.secondBottomGuide = new Guide( this.sourceObject.secondPositionProperty, this.optic, {
+      location: Guide.Location.BOTTOM
+    } );
   }
 }
 
 geometricOptics.register( 'LensModel', LensModel );
-export default LensModel;
+export default LensModel;

js/lens/model/ProjectorScreen.js

@@ -14,6 +14,7 @@ import GeometricOpticsConstants from '../../common/GeometricOpticsConstants.js';
 import geometricOptics from '../../geometricOptics.js';
 import Spotlight from './Spotlight.js';
 
+// constants
 const MASK_CORNERS = GeometricOpticsConstants.MASK_CORNERS;
 const INITIAL_POSITION = GeometricOpticsConstants.PROJECTOR_INITIAL_POSITION;
 
@@ -26,10 +27,8 @@ class ProjectorScreen {
    * @param {Property.<Vector2>} secondTargetPositionProperty
    * @param {Optic} optic
    */
-  constructor( firstSourcePositionProperty,
-               secondSourcePositionProperty,
-               firstTargetPositionProperty,
-               secondTargetPositionProperty,
+  constructor( firstSourcePositionProperty, secondSourcePositionProperty,
+               firstTargetPositionProperty, secondTargetPositionProperty,
                optic ) {
 
     // @public {Property.<Vector2>} position of the center of the screen
@@ -109,4 +108,4 @@ class ProjectorScreen {
 }
 
 geometricOptics.register( 'ProjectorScreen', ProjectorScreen );
-export default ProjectorScreen;
+export default ProjectorScreen;

js/lens/model/Spotlight.js

@@ -14,8 +14,6 @@ import GeometricOpticsConstants from '../../common/GeometricOpticsConstants.js';
 import Optic from '../../common/model/Optic.js';
 import geometricOptics from '../../geometricOptics.js';
 
-const FULL_BRIGHT_SPOT_HEIGHT = GeometricOpticsConstants.FULL_BRIGHT_SPOT_HEIGHT;
-
 class Spotlight {
 
   /**
@@ -25,11 +23,7 @@ class Spotlight {
    * @param {Optic} optic
    * @param {function} getScreenShape - returns the shape of the screen {Shape}
    */
-  constructor( sourcePositionProperty,
-               screenPositionProperty,
-               targetPositionProperty,
-               optic,
-               getScreenShape ) {
+  constructor( sourcePositionProperty, screenPositionProperty, targetPositionProperty, optic, getScreenShape ) {
 
     // @private {function}
     this.getScreenShape = getScreenShape;
@@ -63,7 +57,6 @@ class Spotlight {
       ( screenPosition, opticPosition, opticDiameter, targetPosition ) => {
         return this.getLightIntensity( screenPosition, opticPosition, opticDiameter, targetPosition );
       } );
-
   }
 
   /**
@@ -134,7 +127,6 @@ class Spotlight {
    */
   getIntersectPosition( screenPosition, point, targetPosition ) {
     const blend = this.getRatio( screenPosition, point, targetPosition );
-
     return point.blend( targetPosition, blend );
   }
 
@@ -221,10 +213,10 @@ class Spotlight {
     else {
 
       // intensity saturates to 1 for a spotlight height less than FULL_BRIGHT_SPOT_HEIGHT
-      return Math.min( 1, FULL_BRIGHT_SPOT_HEIGHT / spotlightHeight );
+      return Math.min( 1, GeometricOpticsConstants.FULL_BRIGHT_SPOT_HEIGHT / spotlightHeight );
     }
   }
 }
 
 geometricOptics.register( 'Spotlight', Spotlight );
-export default Spotlight;
+export default Spotlight;

js/lens/view/GuideNode.js

@@ -13,10 +13,6 @@ import Rectangle from '../../../../scenery/js/nodes/Rectangle.js';
 import GeometricOpticsConstants from '../../common/GeometricOpticsConstants.js';
 import geometricOptics from '../../geometricOptics.js';
 
-const GUIDE_FULCRUM_RADIUS = GeometricOpticsConstants.GUIDE_FULCRUM_RADIUS;
-const GUIDE_RECTANGLE_WIDTH = GeometricOpticsConstants.GUIDE_RECTANGLE_WIDTH;
-const GUIDE_RECTANGLE_HEIGHT = GeometricOpticsConstants.GUIDE_RECTANGLE_HEIGHT;
-
 class GuideNode extends Node {
 
   /**
@@ -41,11 +37,11 @@ class GuideNode extends Node {
     super();
 
     // width and height of the guide rectangles
-    const viewRectangleWidth = modelViewTransform.modelToViewDeltaX( GUIDE_RECTANGLE_WIDTH );
-    const viewRectangleHeight = Math.abs( modelViewTransform.modelToViewDeltaY( GUIDE_RECTANGLE_HEIGHT ) );
+    const viewRectangleWidth = modelViewTransform.modelToViewDeltaX( GeometricOpticsConstants.GUIDE_RECTANGLE_WIDTH );
+    const viewRectangleHeight = Math.abs( modelViewTransform.modelToViewDeltaY( GeometricOpticsConstants.GUIDE_RECTANGLE_HEIGHT ) );
 
     // create fulcrum circle
-    const fulcrumCircle = new Circle( GUIDE_FULCRUM_RADIUS, options.circle );
+    const fulcrumCircle = new Circle( GeometricOpticsConstants.GUIDE_FULCRUM_RADIUS, options.circle );
 
     // create two rectangles, with left center side laying on fulcrum circle (initially)
     const incidentRectangle = new Rectangle( fulcrumCircle.x, fulcrumCircle.y - viewRectangleHeight / 2, viewRectangleWidth, viewRectangleHeight, options.rectangle );
@@ -117,7 +113,6 @@ class GuideNode extends Node {
 
     // update guides visibility based on checkbox
     visibleProperty.linkAttribute( this, 'visible' );
-
   }
 }
 

js/lens/view/LensScreenView.js

@@ -70,4 +70,4 @@ class LensScreenView extends GeometricOpticsScreenView {
 }
 
 geometricOptics.register( 'LensScreenView', LensScreenView );
-export default LensScreenView;
+export default LensScreenView;

js/lens/view/ProjectorScreenNode.js

@@ -36,14 +36,8 @@ class ProjectorScreenNode extends Node {
    * @param {ModelViewTransform2} modelViewTransform
    * @param {Object} [options]
    */
-  constructor( projectorScreen,
-               representationProperty,
-               enableFirstSpotlightProperty,
-               enableSecondSpotlightProperty,
-               secondSourceVisibleProperty,
-               visibleModelBoundsProperty,
-               modelViewTransform,
-               options ) {
+  constructor( projectorScreen, representationProperty, enableFirstSpotlightProperty, enableSecondSpotlightProperty,
+               secondSourceVisibleProperty, visibleModelBoundsProperty, modelViewTransform, options ) {
 
     options = merge( {
       cursor: 'pointer'
@@ -155,4 +149,4 @@ class ProjectorScreenNode extends Node {
 }
 
 geometricOptics.register( 'ProjectorScreenNode', ProjectorScreenNode );
-export default ProjectorScreenNode;
+export default ProjectorScreenNode;

js/mirror/MirrorScreen.js

@@ -19,14 +19,11 @@ class MirrorScreen extends Screen {
   constructor() {
 
     // create concave mirror for home screen icon
-    const iconNode = CurveControl.createIconNode(
-      Optic.Curve.CONCAVE,
-      Optic.Type.MIRROR,
-      {
-        radius: 20,
-        diameter: 30,
-        outline: { stroke: 'black' }
-      } );
+    const iconNode = CurveControl.createIconNode( Optic.Curve.CONCAVE, Optic.Type.MIRROR, {
+      radius: 20,
+      diameter: 30,
+      outline: { stroke: 'black' }
+    } );
 
     const options = {
       name: geometricOpticsStrings.screen.mirror,
@@ -43,4 +40,4 @@ class MirrorScreen extends Screen {
 }
 
 geometricOptics.register( 'MirrorScreen', MirrorScreen );
-export default MirrorScreen;
+export default MirrorScreen;

js/mirror/model/MirrorModel.js

@@ -10,11 +10,6 @@ import GeometricOpticsModel from '../../common/model/GeometricOpticsModel.js';
 import Optic from '../../common/model/Optic.js';
 import geometricOptics from '../../geometricOptics.js';
 
-const INITIAL_POSITION = GeometricOpticsConstants.MIRROR_INITIAL_POSITION;
-const RADIUS_OF_CURVATURE_RANGE = GeometricOpticsConstants.MIRROR_RADIUS_OF_CURVATURE_RANGE;
-const DIAMETER_RANGE = GeometricOpticsConstants.MIRROR_DIAMETER_RANGE;
-const INITIAL_CURVATURE_TYPE = GeometricOpticsConstants.MIRROR_INITIAL_CURVATURE_TYPE;
-
 class MirrorModel extends GeometricOpticsModel {
 
   constructor() {
@@ -24,18 +19,16 @@ class MirrorModel extends GeometricOpticsModel {
     // its focal length is equivalent to a lens with an index of refraction of 2
     const indexOfRefractionRange = new RangeWithValue( 2, 2, 2 );
 
-    super( INITIAL_POSITION, RADIUS_OF_CURVATURE_RANGE, DIAMETER_RANGE,
-      indexOfRefractionRange, INITIAL_CURVATURE_TYPE, Optic.Type.MIRROR );
-  }
-
-  /**
-   * Resets the model.
-   * @public
-   */
-  reset() {
-    super.reset();
+    super(
+      GeometricOpticsConstants.MIRROR_INITIAL_POSITION,
+      GeometricOpticsConstants.MIRROR_RADIUS_OF_CURVATURE_RANGE,
+      GeometricOpticsConstants.MIRROR_DIAMETER_RANGE,
+      indexOfRefractionRange,
+      GeometricOpticsConstants.MIRROR_INITIAL_CURVATURE_TYPE,
+      Optic.Type.MIRROR
+    );
   }
 }
 
 geometricOptics.register( 'MirrorModel', MirrorModel );
-export default MirrorModel;
+export default MirrorModel;

js/mirror/view/MirrorScreenView.js

@@ -20,4 +20,4 @@ class MirrorScreenView extends GeometricOpticsScreenView {
 }
 
 geometricOptics.register( 'MirrorScreenView', MirrorScreenView );
-export default MirrorScreenView;
+export default MirrorScreenView;