Merge pull request #3 from gl-vis/autoscale

Autoscale [fix #2]

README.md

@@ -17,7 +17,6 @@ var bounds = [];
 var streamTube = createStreamTube({
     startingPositions: positionsArray,
     maxLength: 1000,
-    widthScale: 10000,
     getVelocity: velocityFunction,
     colormap: 'portland'
 }, bounds)
@@ -48,7 +47,8 @@ Creates a stream tube plot of a vector field.
     + `getVelocity(point)` *(Required)* A getter function to get the velocity at a given point.
     + `getDivergence(point)` *(Optional)* A getter function to get the divergence at a given point. Used for the width of the streamtube. Defaults to the divergence of the getVelocity function.
     + `maxLength` *(Optional)* The maximum number of segments to add to a streamtube. Default is 1000.
-    + `widthScale` *(Optional)* The divergence multiplier to get the width of the streamtube. Default is 10000.
+    + `tubeSize` *(Optional)* The scaling factor for the streamtubes. The default is 1, which avoids two max divergence tubes from touching at adjacent starting positions.
+    + `absoluteTubeSize` *(Optional)* Absolute scaling factor for the streamtubes. A value of 1 scales divergence of 1 to 1 coordinate system unit. Overrides tubeSize. 
     + `colormap` *(Optional)* The colormap to use.
 
 **Returns** A streamtube plot object that can be passed to gl-mesh3d.