openscad/dotSCAD
1
0
Fork 0
mirror of https://github.com/JustinSDK/dotSCAD.git synced 2025-08-01 04:20:27 +02:00
Code Issues Releases Wiki Activity

update docs

Browse Source
This commit is contained in:
Justin Lin
2020-06-27 10:45:34 +08:00
parent 95b151318e
commit bb169008d2
9 changed files with 28 additions and 28 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
docs/lib2x-archimedean_spiral_extrude.md
View File

@@ -2,7 +2,7 @@
Extrudes a 2D shape along the path of an archimedean spiral.
When using this module, you should use points to represent the 2D shape. If your 2D shape is not solid, indexes of triangles are required. See [polysections](https://openhome.cc/eGossip/OpenSCAD/lib2x-polysections.html) for details.
When using this module, you should use points to represent the 2D shape. If your 2D shape is not solid, indexes of triangles are required. See [sweep](https://openhome.cc/eGossip/OpenSCAD/lib2x-sweep.html) for details.
## Parameters
@@ -10,7 +10,7 @@ When using this module, you should use points to represent the 2D shape. If your
- `arm_distance`, `init_angle`, `point_distance`, `num_of_points` and `rt_dir` : See [archimedean_spiral](https://openhome.cc/eGossip/OpenSCAD/lib2x-archimedean_spiral.html) for details.
- `twist` : The number of degrees of through which the shape is extruded.
- `scale` : Scales the 2D shape by this value over the length of the extrusion. Scale can be a scalar or a vector.
- `triangles` : `"SOLID"` (default), `"HOLLOW"` or user-defined indexes. See [polysections](https://openhome.cc/eGossip/OpenSCAD/lib2x-polysections.html) for details.
- `triangles` : `"SOLID"` (default), `"HOLLOW"` or user-defined indexes. See [sweep](https://openhome.cc/eGossip/OpenSCAD/lib2x-sweep.html) for details.
## Examples

6
docs/lib2x-cross_sections.md
View File

@@ -1,6 +1,6 @@
# cross_sections
Given a 2D shape, points and angles along the path, this function will return all cross-sections. Combined with the `polysections` module, you can create a specific path extrusion.
Given a 2D shape, points and angles along the path, this function will return all cross-sections. Combined with the `sweep` module, you can create a specific path extrusion.
## Parameters
@@ -12,7 +12,7 @@ Given a 2D shape, points and angles along the path, this function will return al
## Examples
use <polysections.scad>;
use <sweep.scad>;
use <cross_sections.scad>;
use <archimedean_spiral.scad>;
@@ -35,7 +35,7 @@ Given a 2D shape, points and angles along the path, this function will return al
for(i = [0:len(pts_angles) - 1]) [90, 0, pts_angles[i][1]]
];
polysections(
sweep(
cross_sections(shape_pts, pts, angles, twist = 180, scale = 0.1)
);

4
docs/lib2x-golden_spiral_extrude.md
View File

@@ -2,7 +2,7 @@
Extrudes a 2D shape along the path of a golden spiral.
When using this module, you should use points to represent the 2D shape. If your 2D shape is not solid, indexes of triangles are required. See [polysections](https://openhome.cc/eGossip/OpenSCAD/lib2x-polysections.html) for details.
When using this module, you should use points to represent the 2D shape. If your 2D shape is not solid, indexes of triangles are required. See [sweep](https://openhome.cc/eGossip/OpenSCAD/lib2x-sweep.html) for details.
## Parameters
@@ -13,7 +13,7 @@ When using this module, you should use points to represent the 2D shape. If your
- `rt_dir` : `"CT_CLK"` for counterclockwise. `"CLK"` for clockwise. The default value is `"CT_CLK"`.
- `twist` : The number of degrees of through which the shape is extruded.
- `scale` : Scales the 2D shape by this value over the length of the extrusion. Scale can be a scalar or a vector.
- `triangles` : `"SOLID"` (default), `"HOLLOW"` or user-defined indexes. See [polysections](https://openhome.cc/eGossip/OpenSCAD/lib2x-polysections.html) for details.
- `triangles` : `"SOLID"` (default), `"HOLLOW"` or user-defined indexes. See [sweep](https://openhome.cc/eGossip/OpenSCAD/lib2x-sweep.html) for details.
## Examples

4
docs/lib2x-helix_extrude.md
View File

@@ -2,7 +2,7 @@
Extrudes a 2D shape along a helix path.
When using this module, you should use points to represent the 2D shape. If your 2D shape is not solid, indexes of triangles are required. See [polysections](https://openhome.cc/eGossip/OpenSCAD/lib2x-polysections.html) for details.
When using this module, you should use points to represent the 2D shape. If your 2D shape is not solid, indexes of triangles are required. See [sweep](https://openhome.cc/eGossip/OpenSCAD/lib2x-sweep.html) for details.
Its `$fa`, `$fs` and `$fn` parameters are consistent with the `cylinder` module.
@@ -16,7 +16,7 @@ Its `$fa`, `$fs` and `$fn` parameters are consistent with the `cylinder` module.
- `rt_dir` : `"CT_CLK"` for counterclockwise. `"CLK"` for clockwise. The default value is `"CT_CLK"`.
- `twist` : The number of degrees of through which the shape is extruded.
- `scale` : Scales the 2D shape by this value over the length of the extrusion. Scale can be a scalar or a vector.
- `triangles` : `"SOLID"` (default), `"HOLLOW"` or user-defined indexes. See [polysections](https://openhome.cc/eGossip/OpenSCAD/lib2x-polysections.html) for details.
- `triangles` : `"SOLID"` (default), `"HOLLOW"` or user-defined indexes. See [sweep](https://openhome.cc/eGossip/OpenSCAD/lib2x-sweep.html) for details.
- `$fa`, `$fs`, `$fn` : Check [the cylinder module](https://en.wikibooks.org/wiki/OpenSCAD_User_Manual/Primitive_Solids#cylinder) for more details.
## Examples

2
docs/lib2x-path_extrude.md
View File

@@ -2,7 +2,7 @@
It extrudes a 2D shape along a path. This module is suitable for a path created by a continuous function.
When using this module, you should use points to represent the 2D shape. If your 2D shape is not solid, indexes of triangles are required. See [polysections](https://openhome.cc/eGossip/OpenSCAD/lib2x-polysections.html) for details.
When using this module, you should use points to represent the 2D shape. If your 2D shape is not solid, indexes of triangles are required. See [sweep](https://openhome.cc/eGossip/OpenSCAD/lib2x-sweep.html) for details.
## Parameters

18
docs/lib2x-path_scaling_sections.md
View File

@@ -1,6 +1,6 @@
# path_scaling_sections
Given an edge path with the first point at the outline of a shape. This function uses the path to calculate scaling factors and returns all scaled sections in the reversed order of the edge path. Combined with the `polysections` module, you can create an extrusion with the path as an edge.
Given an edge path with the first point at the outline of a shape. This function uses the path to calculate scaling factors and returns all scaled sections in the reversed order of the edge path. Combined with the `sweep` module, you can create an extrusion with the path as an edge.
In order to control scaling factors easily, I suggest using `[x, 0, 0]` as the first point and keeping y = 0 while building the edge path.
@@ -18,7 +18,7 @@ You can use any point as the first point of the edge path. Just remember that yo
use <hull_polyline3d.scad>;
use <shape_taiwan.scad>;
use <path_scaling_sections.scad>;
use <polysections.scad>;
use <sweep.scad>;
taiwan = shape_taiwan(100);
fst_pt = [13, 0, 0];
@@ -34,14 +34,14 @@ You can use any point as the first point of the edge path. Just remember that yo
];
#hull_polyline3d(edge_path);
polysections(path_scaling_sections(taiwan, edge_path));
sweep(path_scaling_sections(taiwan, edge_path));
![path_scaling_sections](images/lib2x-path_scaling_sections-1.JPG)
use <hull_polyline3d.scad>;
use <shape_taiwan.scad>;
use <path_scaling_sections.scad>;
use <polysections.scad>;
use <sweep.scad>;
use <bezier_curve.scad>;
@@ -59,13 +59,13 @@ You can use any point as the first point of the edge path. Just remember that yo
]);
#hull_polyline3d(edge_path);
polysections(path_scaling_sections(taiwan, edge_path));
sweep(path_scaling_sections(taiwan, edge_path));
![path_scaling_sections](images/lib2x-path_scaling_sections-2.JPG)
use <shape_taiwan.scad>;
use <path_scaling_sections.scad>;
use <polysections.scad>;
use <sweep.scad>;
use <bezier_curve.scad>;
use <rotate_p.scad>;
@@ -95,14 +95,14 @@ You can use any point as the first point of the edge path. Just remember that yo
]
];
polysections(rotated_sections);
sweep(rotated_sections);
![path_scaling_sections](images/lib2x-path_scaling_sections-3.JPG)
use <hull_polyline3d.scad>;
use <shape_taiwan.scad>;
use <path_scaling_sections.scad>;
use <polysections.scad>;
use <sweep.scad>;
use <rotate_p.scad>;
taiwan = shape_taiwan(100);
@@ -124,6 +124,6 @@ You can use any point as the first point of the edge path. Just remember that yo
];
#hull_polyline3d(edge_path);
polysections(path_scaling_sections(taiwan, edge_path));
sweep(path_scaling_sections(taiwan, edge_path));
![path_scaling_sections](images/lib2x-path_scaling_sections-4.JPG)

10
docs/lib2x-paths2sections.md
View File

@@ -1,6 +1,6 @@
# paths2sections
Given a list of paths, this function will return all cross-sections described by those paths. Combined with the `polysections` module, you can describe a more complex model.
Given a list of paths, this function will return all cross-sections described by those paths. Combined with the `sweep` module, you can describe a more complex model.
You paths should be indexed count-clockwisely.
@@ -12,7 +12,7 @@ You paths should be indexed count-clockwisely.
use <paths2sections.scad>;
use <hull_polyline3d.scad>;
use <polysections.scad>;
use <sweep.scad>;
paths = [
[[5, 0, 5], [15, 10, 10], [25, 20, 5]],
@@ -23,7 +23,7 @@ You paths should be indexed count-clockwisely.
sections = paths2sections(paths);
polysections(sections);
sweep(sections);
#for(path = paths) {
hull_polyline3d(path, 0.5);
@@ -34,7 +34,7 @@ You paths should be indexed count-clockwisely.
use <bezier_curve.scad>;
use <paths2sections.scad>;
use <hull_polyline3d.scad>;
use <polysections.scad>;
use <sweep.scad>;
t_step = 0.05;
@@ -56,7 +56,7 @@ You paths should be indexed count-clockwisely.
sections = paths2sections(paths);
polysections(sections);
sweep(sections);
#for(path = paths) {
hull_polyline3d(path, 0.5);

4
docs/lib2x-ring_extrude.md
View File

@@ -4,7 +4,7 @@ Rotational extrusion spins a 2D shape around the Z-axis. It's similar to the bui
Because we cannot retrieve the shape points of built-in 2D modules, it's necessary to provide `shapt_pts` and `triangles`.
If your 2D shape is not solid, indexes of triangles are required. See [polysections](https://openhome.cc/eGossip/OpenSCAD/lib2x-polysections.html) for details.
If your 2D shape is not solid, indexes of triangles are required. See [sweep](https://openhome.cc/eGossip/OpenSCAD/lib2x-sweep.html) for details.
## Parameters
@@ -13,7 +13,7 @@ If your 2D shape is not solid, indexes of triangles are required. See [polysecti
- `angle` : Defaults to 360. Specifies the number of degrees to sweep, starting at the positive X axis. It also accepts a 2 element vector which defines the central angle. The first element of the vector is the beginning angle in degrees, and the second element is the ending angle.
- `twist` : The number of degrees of through which the shape is twisted.
- `scale` : Scales the 2D shape by this value over the length of the extrusion. Scale can be a scalar or a vector.
- `triangles` : `"SOLID"` (default), `"HOLLOW"` or user-defined indexes. See [polysections](https://openhome.cc/eGossip/OpenSCAD/lib2x-polysections.html) for details.
- `triangles` : `"SOLID"` (default), `"HOLLOW"` or user-defined indexes. See [sweep](https://openhome.cc/eGossip/OpenSCAD/lib2x-sweep.html) for details.
- `$fa`, `$fs`, `$fn` : Check [the circle module](https://en.wikibooks.org/wiki/OpenSCAD_User_Manual/Using_the_2D_Subsystem#circle) for more details.
## Examples

4
docs/lib2x-sphere_spiral_extrude.md
View File

@@ -2,7 +2,7 @@
Extrudes a 2D shape along the path of a sphere spiral.
When using this module, you should use points to represent the 2D shape. If your 2D shape is not solid, indexes of triangles are required. See [polysections](https://openhome.cc/eGossip/OpenSCAD/lib2x-polysections.html) for details.
When using this module, you should use points to represent the 2D shape. If your 2D shape is not solid, indexes of triangles are required. See [sweep](https://openhome.cc/eGossip/OpenSCAD/lib2x-sweep.html) for details.
## Parameters
@@ -10,7 +10,7 @@ When using this module, you should use points to represent the 2D shape. If your
- `radius` , `za_step`, `z_circles`, `begin_angle`, `end_angle`, `vt_dir`, `rt_dir` : See [sphere_spiral](https://openhome.cc/eGossip/OpenSCAD/lib2x-sphere_spiral.html) for details.
- `twist` : The number of degrees of through which the shape is extruded.
- `scale` : Scales the 2D shape by this value over the length of the extrusion. Scale can be a scalar or a vector.
- `triangles` : `"SOLID"` (default), `"HOLLOW"` or user-defined indexes. See [polysections](https://openhome.cc/eGossip/OpenSCAD/lib2x-polysections.html) for details.
- `triangles` : `"SOLID"` (default), `"HOLLOW"` or user-defined indexes. See [sweep](https://openhome.cc/eGossip/OpenSCAD/lib2x-sweep.html) for details.
## Examples