You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -44,11 +44,11 @@ Creates a stream tube plot of a vector field.
44
44
*`params` is an object that has the following properties:
45
45
46
46
+`startingPositions`*(Required)* An array of starting positions for the vector field, encoded as arrays.
47
-
+`getVelocity(point)`*(Required)* A getter function to get the velocity at a given point.
47
+
+`getVelocity(point)`*(Optional)* A getter function to get the velocity at a given point.
48
48
+`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.
49
49
+`maxLength`*(Optional)* The maximum number of segments to add to a streamtube. Default is 1000.
50
50
+`tubeSize`*(Optional)* The scaling factor for the streamtubes. The default is 1, which avoids two max divergence tubes from touching at adjacent starting positions.
51
-
+`absoluteTubeSize`*(Optional)* Absolute scaling factor for the streamtubes. A value of 1 scales divergence of 1 to 1 coordinate system unit. Overrides tubeSize.
51
+
+`absoluteTubeSize`*(Optional)* Absolute scaling factor for the streamtubes. A value of 1 scales divergence of 1 to 1 coordinate system unit. Overrides tubeSize.
52
52
+`colormap`*(Optional)* The colormap to use.
53
53
54
54
**Returns** A streamtube plot object that can be passed to gl-mesh3d.
0 commit comments