poly-extrude 0.5.0 → 0.7.0

package/index.js

@@ -2,4 +2,5 @@ import { extrudePolygons } from './src/polygon';
 import { extrudePolylines, expandLine, leftOnLine, extrudeSlopes } from './src/polyline';
 import { cylinder } from './src/cylinder';
 import { expandPaths } from './src/path';
-export { extrudePolygons, extrudePolylines, extrudeSlopes, expandLine, leftOnLine, cylinder, expandPaths };
+import { expandTubes } from './src/tube';
+export { extrudePolygons, extrudePolylines, extrudeSlopes, expandLine, leftOnLine, cylinder, expandPaths, expandTubes };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "poly-extrude",
-  "version": "0.5.0",
+  "version": "0.7.0",
   "description": "",
   "main": "dist/poly-extrude.js",
   "module": "dist/poly-extrude.mjs",

package/readme.md

@@ -1,62 +1,75 @@
 # poly-extrude
 
-
 Extrude polygons/polylines. Born in [maptalks.three](https://github.com/maptalks/maptalks.three) project<br>
 
 ## Examples
-[building](https://deyihu.github.io/poly-extrude/test/building.html)<br>
-![](./gallery/building.png)<br>
-[buildings](https://deyihu.github.io/poly-extrude/test/buildings.html)<br>
-![](./gallery/buildings.png)<br>
+
+[building](https://deyihu.github.io/poly-extrude/test/building.html)
+<!-- ![](./gallery/building.png)<br> -->
+[buildings](https://deyihu.github.io/poly-extrude/test/buildings.html)
+<!-- ![](./gallery/buildings.png)<br> -->
 [multi-polygon](https://deyihu.github.io/poly-extrude/test/multi-polygon.html)<br>
-![](./gallery/multi-polygon.png)<br>
+<!-- ![](./gallery/multi-polygon.png)<br> -->
 [street](https://deyihu.github.io/poly-extrude/test/street.html)<br>
-![](./gallery/street.png)<br>
+<!-- ![](./gallery/street.png)<br> -->
 [line-uv](https://deyihu.github.io/poly-extrude/test/line-uv.html)<br>
-![](./gallery/line-uv.png)
+<!-- ![](./gallery/line-uv.png) -->
 [ny-building](https://deyihu.github.io/poly-extrude/test/ny-building.html)<br>
-![](./gallery/ny-building.png)
+<!-- ![](./gallery/ny-building.png) -->
 [cylinder](https://deyihu.github.io/poly-extrude/test/cylinder.html)<br>
-![](./gallery/cylinder.png)
+<!-- ![](./gallery/cylinder.png) -->
 [brige](https://deyihu.github.io/poly-extrude/test/brige.html)<br>
-![](./gallery/brige.png)
+<!-- ![](./gallery/brige.png) -->
 [spring](https://deyihu.github.io/poly-extrude/test/spring.html)<br>
-![](./gallery/spring.png)
+<!-- ![](./gallery/spring.png) -->
 [expand paths](https://deyihu.github.io/poly-extrude/test/expand-paths-brige.html)<br>
-![](./gallery/expand-paths-brige.png)
+<!-- ![](./gallery/expand-paths-brige.png) -->
+[slope](https://deyihu.github.io/poly-extrude/test/slope.html)<br>
+
+[tube](https://deyihu.github.io/poly-extrude/test/tube.html)<br>
 
 ## Install
 
+### NPM
+
 ```sh
 npm i poly-extrude
 
-#   or
-
-yarn add poly-extrude
+```
 
-# or
+### CDN
 
-pnpm i poly-extrude
+```html
+<script type="text/javascript" src="https://unpkg.com/poly-extrude/dist/poly-extrude.js"></script>
 ```
 
-## API
-
-### ESM
+## Use
 
 ```js
   import {
       extrudePolygons,
       extrudePolylines,
       cylinder,
-      expandPaths
+      expandPaths,
+      extrudeSlopes,
+      expandTubes
   } from 'poly-extrude';
+
+  //if you use cdn
+
+  //   const {
+  //       extrudePolygons,
+  //       extrudePolylines
+  //   } = window.polyextrude;
+
   const polygons = [
       //polygon
       [
           //outring
           [
               [x, y],
-              [x, y], ...........
+              [x, y],
+              ...........
           ],
           //holes
           [
@@ -68,35 +81,25 @@ pnpm i poly-extrude
       ],
       //other polygons
       ......
-  ]
-
-  const result = extrudePolygons(polygons, {
-      depth: 2
-  });
-  const {
-      positon,
-      normal,
-      uv,
-      indices
-  } = result;
-  //do something
+  ];
 
   const polylines = [
       // polyline
       [
           [x, y],
-          [x, y], ...........
+          [x, y],
+          ...........
       ],
       //polyline
       [
           [x, y],
-          [x, y], ...........
+          [x, y],
+          ...........
       ],
   ];
 
-  const result = extrudePolylines(polylines, {
-      depth: 2,
-      lineWidth: 2
+  const result = extrudePolygons(polygons, {
+      depth: 2
   });
   const {
       positon,
@@ -105,39 +108,20 @@ pnpm i poly-extrude
       indices
   } = result;
   //do something
+```
 
-  const center = [0, 0];
-  const result = cylinder(center, {
-      radius: 1,
-      height: 2,
-      radialSegments: 6
-  });
-  const {
-      positon,
-      normal,
-      uv,
-      indices
-  } = result;
-  //do something
+## API
 
+![](./img/extrudePolygons.png)
 
-  
-  const polylines = [
-      // polyline
-      [
-          [x, y],
-          [x, y], ...........
-      ],
-      //polyline
-      [
-          [x, y],
-          [x, y], ...........
-      ],
-  ];
+### `extrudePolygons(polygons, options)`
 
-  const result = expandPaths(polylines, {
-      cornerRadius: 0.5,
-      lineWidth: 2
+* `polygons`
+* `options.depth`
+
+```js
+  const result = extrudePolygons(polygons, {
+      depth: 2
   });
   const {
       positon,
@@ -146,110 +130,128 @@ pnpm i poly-extrude
       indices
   } = result;
   //do something
+```
+
+
+### `extrudePolylines(lines, options)`
 
+* `lines`
+* `options.depth`
+* `options.lineWidth`
+* `options.bottomStickGround`  Is the bottom attached to the ground
+
+```js
+   const result = extrudePolylines(polylines, {
+       depth: 2,
+       lineWidth: 2
+   });
+   const {
+       positon,
+       normal,
+       uv,
+       indices
+   } = result;
+   //do something
 ```
 
-### CDN
+### `cylinder(center, options)`
 
-```html
-<script src="https://unpkg.com/poly-extrude/dist/poly-extrude.js"></script>
-
-<script>
-    const polygons = [
-        //polygon
-        [
-            //outring
-            [
-                [x, y],
-                [x, y], ...........
-            ],
-            //holes
-            [
-                [x, y],
-                [x, y], ...........
-            ],
-            ........
-
-        ],
-        //other polygons
-        ......
-    ]
-
-    const result = polyextrude.extrudePolygons(polygons, {
-        depth: 2
-    })
-    const {
-        positon,
-        normal,
-        uv,
-        indices
-    } = result;
-    //do something
-
-    const polylines = [
-        // polyline
-        [
-            [x, y],
-            [x, y], ...........
-        ],
-        //polyline
-        [
-            [x, y],
-            [x, y], ...........
-        ],
-    ];
-
-    const result = polyextrude.extrudePolylines(polylines, {
-        depth: 2,
-        lineWidth: 2
-    });
-    const {
-        positon,
-        normal,
-        uv,
-        indices
-    } = result;
-    //do something
-
-    const center = [0, 0];
-    const result = polyextrude.cylinder(center, {
-        radius: 1,
-        height: 2,
-        radialSegments: 6
-    });
-    const {
-        positon,
-        normal,
-        uv,
-        indices
-    } = result;
-    //do something
-
-
-    
-  const polylines = [
-      // polyline
-      [
-          [x, y],
-          [x, y], ...........
-      ],
-      //polyline
-      [
-          [x, y],
-          [x, y], ...........
-      ],
-  ];
+* `center`
+* `options.radius`
+* `options.height`
+* `options.radialSegments`
 
-  const result = polyextrude.expandPaths(polylines, {
-      cornerRadius: 0.5,
-      lineWidth: 2
-  });
-  const {
-      positon,
-      normal,
-      uv,
-      indices
-  } = result;
-  //do something
-</script>
+```js
+const center = [0, 0];
+const result = cylinder(center, {
+
+    radius: 1,
+    height: 2,
+    radialSegments: 6
+
+});
+const {
+    positon,
+    normal,
+    uv,
+    indices
+
+} = result;
+//do something
+```
+
+### `expandPaths(lines, options)`
+
+* `lines`
+* `options.lineWidth`
+
+```js
+const result = expandPaths(polylines, {
+
+    cornerRadius: 0.5,
+    lineWidth: 2
+
+});
+const {
+
+    positon,
+    normal,
+    uv,
+    indices
+
+} = result;
+//do something
+```
+
+### `extrudeSlopes(lines, options)`
+
+* `lines`
+* `options.depth`
+* `options.lineWidth`
+* `options.side` Which side serves as the slope, 'left' or 'right'
+* `options.sideDepth` slope depth 
+* `options.bottomStickGround` Is the bottom attached to the ground
+
+```js
+const result = extrudeSlopes(polylines, {
+
+    depth: 1,
+    side: 'left',
+    sideDepth: 0,
+    lineWidth: 2
+
+});
+const {
+
+    positon,
+    normal,
+    uv,
+    indices
+
+} = result;
+//do something
+```
+
+### `expandTubes(lines, options)`
+
+* `lines`
+* `options.radius`
+* `options.radialSegments`
+
+```js
+const result = expandTubes(polylines, {
+
+    radius: 1,
+    radialSegments: 8
+
+});
+const {
+
+    positon,
+    normal,
+    uv,
+    indices
+
+} = result;
+//do something
 ```