1
0
mirror of https://github.com/JustinSDK/dotSCAD.git synced 2025-01-17 06:08:31 +01:00

update docs

This commit is contained in:
Justin Lin 2019-06-17 08:33:00 +08:00
parent 218db7f7a8
commit ab99a24352
20 changed files with 5 additions and 35 deletions

View File

@ -4,8 +4,6 @@ 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/lib-polysections.html) for details.
Dependencies: `rotate_p`, `archimedean_spiral`, `cross_sections`, `polysections`.
## Parameters
- `shape_pts` : A list of points represent a shape. See the example below.

View File

@ -2,8 +2,6 @@
Given a path, the `bezier_smooth` function uses bazier curves to smooth all corners. You can use it to create smooth lines or rounded shapes.
Dependencies: the `bezier_curve` function.
## Parameters
- `path_pts` : A list of points represent the path.

View File

@ -2,8 +2,6 @@
Given a set of control points, the `bezier_surface` function returns points of the Bézier surface. Combined with the `function_grapher` module defined in my library, you can create a Bézier surface.
It depends on the `bezier_curve` function so remember to include bezier_curve.scad.
## Parameters
- `t_step` : The distance between two points of the Bézier path.

View File

@ -2,8 +2,6 @@
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.
It depends on the `rotate_p` function. Remember to include "rotate_p.scad".
## Parameters
- `shape_pts`: A list of points represent a shape. See the example below.

View File

@ -4,8 +4,6 @@ Uses spherical coordinate system to create a crystal ball.
![Spherical coordinates (r, θ, φ) often used in mathematics](https://upload.wikimedia.org/wikipedia/commons/d/dc/3D_Spherical_2.svg)
Dependencies: `rotate_p`, `cross_sections`, `polysections`, `ring_extrude`, `shape_pie`.
## Parameters
- `radius` : The radial distance r.

View File

@ -2,8 +2,6 @@
Given a set of points `[x, y, f(x, y)]` where `f(x, y)` is a mathematics function, the `function_grapher` module can create the graph of `f(x, y)`.
It depends on the `line3d`, `polyline3d`, `hull_polyline3d` modules so you have to include "line3d.scad", "polyline3d.scad" and "hull_polyline3d.scad".
## Parameters
- `points` : A set of points `[x, y, f(x, y)]`. See examples below.

View File

@ -4,8 +4,6 @@ Gets all points and angles on the path of a golden spiral based on Fibonacci num
It returns a vector of `[[x, y], angle]`.
Because of depending on `circle_path` and `rotate_p`, remember to include "circle_path.scad" and "rotate_p.scad".
## Parameters
- `from` : The nth Fibonacci number you wanna start from.

View File

@ -4,8 +4,6 @@ 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/lib-polysections.html) for details.
Dependencies: `circle_path`, `rotate_p`, `golden_spiral`, `cross_sections`, `polysections`.
## Parameters
- `shape_pts` : A list of points represent a shape. See the example below.

View File

@ -6,8 +6,6 @@ When using this module, you should use points to represent the 2D shape. If your
Its `$fa`, `$fs` and `$fn` parameters are consistent with the `cylinder` module.
Dependencies: `helix`, `rotate_p`, `cross_sections`, `polysections`.
## Parameters
- `shape_pts` : A list of points represent a shape. See the example below.

View File

@ -1,6 +1,6 @@
# parse_number
Parses the string argument as an number. It depends on the `split_str` and the `sub_str` functions so remember to include split_str.scad and sub_str.scad.
Parses the string argument as an number.
## Parameters

View File

@ -2,8 +2,6 @@
It extrudes a 2D shape along a path. This module is suitable for a path created by a continuous function.
It depends on the `rotate_p` function and the `polysections` module. Remember to include "rotate_p.scad" and "polysections.scad".
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/lib-polysections.html) for details.
## Parameters

View File

@ -1,6 +1,6 @@
# polyline2d
Creates a polyline from a list of `x`, `y` coordinates. When the end points are `CAP_ROUND`, you can use `$fa`, `$fs` or `$fn` to controll the circle module used internally. It depends on the `line2d` module so you have to `include` line2d.scad.
Creates a polyline from a list of `x`, `y` coordinates. When the end points are `CAP_ROUND`, you can use `$fa`, `$fs` or `$fn` to controll the circle module used internally.
## Parameters

View File

@ -1,6 +1,6 @@
# polyline3d
Creates a polyline from a list of `[x, y, z]` coordinates. It depends on the `line3d` module so you have to `include` line3d.scad.
Creates a polyline from a list of `[x, y, z]` coordinates.
## Parameters

View File

@ -4,8 +4,6 @@ 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`.
This module depends on `rotate_p`, `cross_section` and `polysections`. Remember to include corresponding ".scad".
If your 2D shape is not solid, indexes of triangles are required. See [polysections](https://openhome.cc/eGossip/OpenSCAD/lib-polysections.html) for details.
## Parameters

View File

@ -2,8 +2,6 @@
Returns shape points of two glued circles. They can be used with xxx_extrude modules of dotSCAD. The shape points can be also used with the built-in polygon module.
Dependencies: `rotate_p`, `bezier_curve`, `shape_pie`.
## Parameters
- `radius` : The radius of two circles.

View File

@ -4,8 +4,6 @@ It extends a 2D stroke along a path to create a 2D shape. This module is suitabl
When using this function, you should use points to represent the 2D stroke.
It depends on the `rotate_p` function. Remember to include "rotate_p.scad".
## Parameters
- `stroke_pts` : A list of points represent a stroke. See the example below.

View File

@ -1,6 +1,6 @@
# sphere_spiral
Creates all points and angles on the path of a spiral around a sphere. It returns a vector of `[[x, y, z], [ax, ay, az]]`. `[x, y, z]` is actually obtained from rotating `[radius, 0, 0]` by `[ax, ay, az]`. It depends on the `rotate_p` function. Remember to include rotate_p.scad first.
Creates all points and angles on the path of a spiral around a sphere. It returns a vector of `[[x, y, z], [ax, ay, az]]`. `[x, y, z]` is actually obtained from rotating `[radius, 0, 0]` by `[ax, ay, az]`.
## Parameters

View File

@ -4,8 +4,6 @@ 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/lib-polysections.html) for details.
Dependencies: `rotate_p`, `sphere_spiral`, `cross_sections`, `polysections`.
## Parameters
- `shape_pts` : A list of points represent a shape. See the example below.

View File

@ -1,6 +1,6 @@
# split_str
Splits the given string around matches of the given delimiting character. It depeneds on the `sub_str` function so remember to `include <sub_str.scad>`.
Splits the given string around matches of the given delimiting character.
## Parameters

View File

@ -4,8 +4,6 @@ An OpenSCAD implementation of 3D Turtle Graphics. When using the function, imagi
For more details, please see [3D turtle graphics](https://openhome.cc/eGossip/OpenSCAD/3DTurtleGraphics.html).
## Parameters
- `cmd` : A string command. Different commands use different numbers of arguments.