Add KCL constants for sweep relativeTo strings (#6974)
* Add KCL constants for sweep relativeTo strings Before: ``` sweep(pill, path = sweepPath, relativeTo = "trajectoryCurve") ``` After: ``` sweep(pill, path = sweepPath, relativeTo = sweep::TRAJECTORY) ``` * Update docs
This commit is contained in:
@ -21,6 +21,7 @@ export import * from "std::sketch"
|
||||
export import * from "std::solid"
|
||||
export import * from "std::transform"
|
||||
export import "std::turns"
|
||||
export import "std::sweep"
|
||||
|
||||
/// An abstract 3d plane aligned with the X and Y axes. Its normal is the positive Z axis.
|
||||
export XY = {
|
||||
@ -83,7 +84,7 @@ export END = 'end'
|
||||
/// // Create a spring by sweeping around the helix path.
|
||||
/// springSketch = startSketchOn(YZ)
|
||||
/// |> circle( center = [0, 0], radius = 0.5)
|
||||
/// |> sweep(path = helixPath, relativeTo = "sketchPlane")
|
||||
/// |> sweep(path = helixPath, relativeTo = sweep::SKETCH_PLANE)
|
||||
/// ```
|
||||
///
|
||||
/// ```
|
||||
@ -104,7 +105,7 @@ export END = 'end'
|
||||
/// // Create a spring by sweeping around the helix path.
|
||||
/// springSketch = startSketchOn(XY)
|
||||
/// |> circle( center = [0, 0], radius = 0.5 )
|
||||
/// |> sweep(path = helixPath, relativeTo = "sketchPlane")
|
||||
/// |> sweep(path = helixPath, relativeTo = sweep::SKETCH_PLANE)
|
||||
/// ```
|
||||
///
|
||||
/// ```
|
||||
@ -124,7 +125,7 @@ export END = 'end'
|
||||
/// // Create a spring by sweeping around the helix path.
|
||||
/// springSketch = startSketchOn(XY)
|
||||
/// |> circle( center = [0, 0], radius = 1 )
|
||||
/// |> sweep(path = helixPath, relativeTo = "sketchPlane")
|
||||
/// |> sweep(path = helixPath, relativeTo = sweep::SKETCH_PLANE)
|
||||
/// ```
|
||||
///
|
||||
/// ```
|
||||
@ -413,7 +414,7 @@ export fn offsetPlane(
|
||||
/// // Create a spring by sweeping around the helix path.
|
||||
/// sweepedSpring = clone(springSketch)
|
||||
/// |> translate(x=100)
|
||||
/// |> sweep(path = helixPath, relativeTo = "sketchPlane")
|
||||
/// |> sweep(path = helixPath, relativeTo = sweep::SKETCH_PLANE)
|
||||
/// ```
|
||||
///
|
||||
/// ```kcl
|
||||
|
Reference in New Issue
Block a user