Skip to content

Commit b466cb6

Browse files
jtranjtran
committed
Update generated docs
1 parent d54b4e8 commit b466cb6

12 files changed

+77
-82
lines changed

‎docs/kcl-std/functions/std-solid-appearance.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -37,13 +37,13 @@ This will work on any solid, including extruded solids, revolved solids, and she
3737
```kcl
3838
// Add color to an extruded solid.
3939
exampleSketch = startSketchOn(XZ)
40-
|> startProfile(at = [0, 0])
40+
exampleProfile = startProfile(exampleSketch, at = [0, 0])
4141
|> line(endAbsolute = [10, 0])
4242
|> line(endAbsolute = [0, 10])
4343
|> line(endAbsolute = [-10, 0])
4444
|> close()
4545

46-
example = extrude(exampleSketch, length = 5)
46+
example = extrude(exampleProfile, length = 5)
4747
// There are other options besides 'color', but they're optional.
4848
|> appearance(color = '#ff0000')
4949

@@ -54,7 +54,7 @@ example = extrude(exampleSketch, length = 5)
5454
```kcl
5555
// Add color to a revolved solid.
5656
sketch001 = startSketchOn(XY)
57-
|> circle(center = [15, 0], radius = 5)
57+
profile001 = circle(sketch001, center = [15, 0], radius = 5)
5858
|> revolve(angle = 360deg, axis = Y)
5959
|> appearance(color = '#ff0000', metalness = 90, roughness = 90)
6060

@@ -65,8 +65,8 @@ sketch001 = startSketchOn(XY)
6565
```kcl
6666
// Add color to different solids.
6767
fn cube(center) {
68-
return startSketchOn(XY)
69-
|> startProfile(at = [center[0] - 10, center[1] - 10])
68+
cubeSketch = startSketchOn(XY)
69+
return startProfile(cubeSketch, at = [center[0] - 10, center[1] - 10])
7070
|> line(endAbsolute = [center[0] + 10, center[1] - 10])
7171
|> line(endAbsolute = [center[0] + 10, center[1] + 10])
7272
|> line(endAbsolute = [center[0] - 10, center[1] + 10])
@@ -99,14 +99,14 @@ appearance(
9999
// You can set the appearance before or after you shell it will yield the same result.
100100
// This example shows setting the appearance _after_ the shell.
101101
firstSketch = startSketchOn(XY)
102-
|> startProfile(at = [-12, 12])
102+
firstSolid = startProfile(firstSketch, at = [-12, 12])
103103
|> line(end = [24, 0])
104104
|> line(end = [0, -24])
105105
|> line(end = [-24, 0])
106106
|> close()
107107
|> extrude(length = 6)
108108

109-
shell(firstSketch, faces = [END], thickness = 0.25)
109+
shell(firstSolid, faces = [END], thickness = 0.25)
110110
|> appearance(color = '#ff0000', metalness = 90, roughness = 90)
111111

112112
```
@@ -135,13 +135,13 @@ shell(firstSketch, faces = [END], thickness = 0.25)
135135
// Setting the appearance of a 3D pattern can be done _before_ or _after_ the pattern.
136136
// This example shows _before_ the pattern.
137137
exampleSketch = startSketchOn(XZ)
138-
|> startProfile(at = [0, 0])
138+
exampleProfile = startProfile(exampleSketch, at = [0, 0])
139139
|> line(end = [0, 2])
140140
|> line(end = [3, 1])
141141
|> line(end = [0, -4])
142142
|> close()
143143

144-
example = extrude(exampleSketch, length = 1)
144+
example = extrude(exampleProfile, length = 1)
145145
|> appearance(color = '#ff0000', metalness = 90, roughness = 90)
146146
|> patternLinear3d(axis = [1, 0, 1], instances = 7, distance = 6)
147147

‎docs/kcl-std/functions/std-solid-chamfer.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -44,13 +44,13 @@ thickness = 1
4444
chamferLength = 2
4545
4646
mountingPlateSketch = startSketchOn(XY)
47-
|> startProfile(at = [-width / 2, -length / 2])
47+
mountingPlateProfile = startProfile(mountingPlateSketch, at = [-width / 2, -length / 2])
4848
|> line(endAbsolute = [width / 2, -length / 2], tag = $edge1)
4949
|> line(endAbsolute = [width / 2, length / 2], tag = $edge2)
5050
|> line(endAbsolute = [-width / 2, length / 2], tag = $edge3)
5151
|> close(tag = $edge4)
5252
53-
mountingPlate = extrude(mountingPlateSketch, length = thickness)
53+
mountingPlate = extrude(mountingPlateProfile, length = thickness)
5454
|> chamfer(
5555
length = chamferLength,
5656
tags = [
@@ -68,13 +68,13 @@ mountingPlate = extrude(mountingPlateSketch, length = thickness)
6868
```kcl
6969
// Sketch on the face of a chamfer.
7070
fn cube(pos, scale) {
71-
sg = startSketchOn(XY)
72-
|> startProfile(at = pos)
71+
cubeSketch = startSketchOn(XY)
72+
cubeProfile = startProfile(cubeSketch, at = pos)
7373
|> line(end = [0, scale])
7474
|> line(end = [scale, 0])
7575
|> line(end = [0, -scale])
7676
77-
return sg
77+
return cubeProfile
7878
}
7979
8080
part001 = cube(pos = [0, 0], scale = 20)
@@ -84,7 +84,7 @@ part001 = cube(pos = [0, 0], scale = 20)
8484
|> chamfer(length = 10, tags = [getOppositeEdge(line1)], tag = $chamfer1)
8585
8686
sketch001 = startSketchOn(part001, face = chamfer1)
87-
|> startProfile(at = [10, 10])
87+
profile001 = startProfile(sketch001, at = [10, 10])
8888
|> line(end = [2, 0])
8989
|> line(end = [0, 2])
9090
|> line(end = [-2, 0])

‎docs/kcl-std/functions/std-solid-fillet.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -45,13 +45,13 @@ thickness = 1
4545
filletRadius = 2
4646
4747
mountingPlateSketch = startSketchOn(XY)
48-
|> startProfile(at = [-width / 2, -length / 2])
48+
mountingPlateProfile = startProfile(mountingPlateSketch, at = [-width / 2, -length / 2])
4949
|> line(endAbsolute = [width / 2, -length / 2], tag = $edge1)
5050
|> line(endAbsolute = [width / 2, length / 2], tag = $edge2)
5151
|> line(endAbsolute = [-width / 2, length / 2], tag = $edge3)
5252
|> close(tag = $edge4)
5353
54-
mountingPlate = extrude(mountingPlateSketch, length = thickness)
54+
mountingPlate = extrude(mountingPlateProfile, length = thickness)
5555
|> fillet(
5656
radius = filletRadius,
5757
tags = [
@@ -73,13 +73,13 @@ thickness = 1
7373
filletRadius = 1
7474
7575
mountingPlateSketch = startSketchOn(XY)
76-
|> startProfile(at = [-width / 2, -length / 2])
76+
mountingPlateProfile = startProfile(mountingPlateSketch, at = [-width / 2, -length / 2])
7777
|> line(endAbsolute = [width / 2, -length / 2], tag = $edge1)
7878
|> line(endAbsolute = [width / 2, length / 2], tag = $edge2)
7979
|> line(endAbsolute = [-width / 2, length / 2], tag = $edge3)
8080
|> close(tag = $edge4)
8181
82-
mountingPlate = extrude(mountingPlateSketch, length = thickness)
82+
mountingPlate = extrude(mountingPlateProfile, length = thickness)
8383
|> fillet(
8484
radius = filletRadius,
8585
tolerance = 0.000001,

‎docs/kcl-std/functions/std-solid-intersect.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -38,8 +38,8 @@ verifying fit, and analyzing overlapping geometries in assemblies.
3838
3939
4040
fn cube(center, size) {
41-
return startSketchOn(XY)
42-
|> startProfile(at = [center[0] - size, center[1] - size])
41+
cubeSketch = startSketchOn(XY)
42+
return startProfile(cubeSketch, at = [center[0] - size, center[1] - size])
4343
|> line(endAbsolute = [center[0] + size, center[1] - size])
4444
|> line(endAbsolute = [center[0] + size, center[1] + size])
4545
|> line(endAbsolute = [center[0] - size, center[1] + size])
@@ -64,8 +64,8 @@ intersectedPart = intersect([part001, part002])
6464
6565
6666
fn cube(center, size) {
67-
return startSketchOn(XY)
68-
|> startProfile(at = [center[0] - size, center[1] - size])
67+
cubeSketch = startSketchOn(XY)
68+
return startProfile(cubeSketch, at = [center[0] - size, center[1] - size])
6969
|> line(endAbsolute = [center[0] + size, center[1] - size])
7070
|> line(endAbsolute = [center[0] + size, center[1] + size])
7171
|> line(endAbsolute = [center[0] - size, center[1] + size])

‎docs/kcl-std/functions/std-solid-patternLinear3d.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -41,13 +41,13 @@ patternLinear3d(
4141
4242
4343
exampleSketch = startSketchOn(XZ)
44-
|> startProfile(at = [0, 0])
44+
exampleProfile = startProfile(exampleSketch, at = [0, 0])
4545
|> line(end = [0, 2])
4646
|> line(end = [3, 1])
4747
|> line(end = [0, -4])
4848
|> close()
4949
50-
example = extrude(exampleSketch, length = 1)
50+
example = extrude(exampleProfile, length = 1)
5151
|> patternLinear3d(axis = X, instances = 7, distance = 6)
5252
5353
```
@@ -59,13 +59,13 @@ example = extrude(exampleSketch, length = 1)
5959
6060
6161
exampleSketch = startSketchOn(XZ)
62-
|> startProfile(at = [0, 0])
62+
exampleProfile = startProfile(exampleSketch, at = [0, 0])
6363
|> line(end = [0, 2])
6464
|> line(end = [3, 1])
6565
|> line(end = [0, -4])
6666
|> close()
6767
68-
example = extrude(exampleSketch, length = 1)
68+
example = extrude(exampleProfile, length = 1)
6969
|> patternLinear3d(axis = [1, 0, 1], instances = 7, distance = 6)
7070
7171
```
@@ -75,8 +75,8 @@ example = extrude(exampleSketch, length = 1)
7575
```kcl
7676
// Pattern a whole sketch on face.
7777
size = 100
78-
case = startSketchOn(XY)
79-
|> startProfile(at = [-size, -size])
78+
caseSketch = startSketchOn(XY)
79+
case = startProfile(caseSketch, at = [-size, -size])
8080
|> line(end = [2 * size, 0])
8181
|> line(end = [0, 2 * size])
8282
|> tangentialArc(endAbsolute = [-size, size])
@@ -107,8 +107,8 @@ patternLinear3d(
107107
```kcl
108108
// Pattern an object on a face.
109109
size = 100
110-
case = startSketchOn(XY)
111-
|> startProfile(at = [-size, -size])
110+
caseSketch = startSketchOn(XY)
111+
case = startProfile(caseSketch, at = [-size, -size])
112112
|> line(end = [2 * size, 0])
113113
|> line(end = [0, 2 * size])
114114
|> tangentialArc(endAbsolute = [-size, size])

‎docs/kcl-std/functions/std-solid-patternTransform.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ fn transform(@id) {
7878

7979
// Sketch 4 cylinders.
8080
sketch001 = startSketchOn(XZ)
81-
|> circle(center = [0, 0], radius = 2)
81+
extrude001 = circle(sketch001, center = [0, 0], radius = 2)
8282
|> extrude(length = 5)
8383
|> patternTransform(instances = 4, transform = transform)
8484

@@ -95,7 +95,7 @@ fn transform(@id) {
9595
}
9696

9797
sketch001 = startSketchOn(XZ)
98-
|> circle(center = [0, 0], radius = 2)
98+
extrude001 = circle(sketch001, center = [0, 0], radius = 2)
9999
|> extrude(length = 5)
100100
|> patternTransform(instances = 4, transform = transform)
101101

‎docs/kcl-std/functions/std-solid-subtract.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -41,8 +41,8 @@ and complex multi-body part modeling.
4141
4242
4343
fn cube(center, size) {
44-
return startSketchOn(XY)
45-
|> startProfile(at = [center[0] - size, center[1] - size])
44+
cubeSketch = startSketchOn(XY)
45+
return startProfile(cubeSketch, at = [center[0] - size, center[1] - size])
4646
|> line(endAbsolute = [center[0] + size, center[1] - size])
4747
|> line(endAbsolute = [center[0] + size, center[1] + size])
4848
|> line(endAbsolute = [center[0] - size, center[1] + size])
@@ -67,8 +67,8 @@ subtractedPart = subtract([part001], tools = [part002])
6767
6868
6969
fn cube(center, size) {
70-
return startSketchOn(XY)
71-
|> startProfile(at = [center[0] - size, center[1] - size])
70+
cubeSketch = startSketchOn(XY)
71+
return startProfile(cubeSketch, at = [center[0] - size, center[1] - size])
7272
|> line(endAbsolute = [center[0] + size, center[1] - size])
7373
|> line(endAbsolute = [center[0] + size, center[1] + size])
7474
|> line(endAbsolute = [center[0] - size, center[1] + size])

‎docs/kcl-std/functions/std-solid-union.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -35,8 +35,8 @@ union(
3535
3636
3737
fn cube(center, size) {
38-
return startSketchOn(XY)
39-
|> startProfile(at = [center[0] - size, center[1] - size])
38+
cubeSketch = startSketchOn(XY)
39+
return startProfile(cubeSketch, at = [center[0] - size, center[1] - size])
4040
|> line(endAbsolute = [center[0] + size, center[1] - size])
4141
|> line(endAbsolute = [center[0] + size, center[1] + size])
4242
|> line(endAbsolute = [center[0] - size, center[1] + size])
@@ -61,8 +61,8 @@ unionedPart = union([part001, part002])
6161
6262
6363
fn cube(center, size) {
64-
return startSketchOn(XY)
65-
|> startProfile(at = [center[0] - size, center[1] - size])
64+
cubeSketch = startSketchOn(XY)
65+
return startProfile(cubeSketch, at = [center[0] - size, center[1] - size])
6666
|> line(endAbsolute = [center[0] + size, center[1] - size])
6767
|> line(endAbsolute = [center[0] + size, center[1] + size])
6868
|> line(endAbsolute = [center[0] - size, center[1] + size])
@@ -88,8 +88,8 @@ unionedPart = part001 + part002
8888
8989
9090
fn cube(center, size) {
91-
return startSketchOn(XY)
92-
|> startProfile(at = [center[0] - size, center[1] - size])
91+
cubeSketch = startSketchOn(XY)
92+
return startProfile(cubeSketch, at = [center[0] - size, center[1] - size])
9393
|> line(endAbsolute = [center[0] + size, center[1] - size])
9494
|> line(endAbsolute = [center[0] + size, center[1] + size])
9595
|> line(endAbsolute = [center[0] - size, center[1] + size])

‎docs/kcl-std/functions/std-transform-mirror2d.md

Lines changed: 13 additions & 13 deletions
Large diffs are not rendered by default.

‎docs/kcl-std/functions/std-transform-rotate.md

Lines changed: 12 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -78,11 +78,10 @@ sweepPath = startSketchOn(XZ)
7878
|> line(end = [0, 7])
7979

8080
// Create a hole for the pipe.
81-
pipeHole = startSketchOn(XY)
82-
|> circle(center = [0, 0], radius = 1.5)
81+
pipeSketch = startSketchOn(XY)
82+
pipeHole = circle(pipeSketch, center = [0, 0], radius = 1.5)
8383

84-
sweepSketch = startSketchOn(XY)
85-
|> circle(center = [0, 0], radius = 2)
84+
pipe = circle(pipeSketch, center = [0, 0], radius = 2)
8685
|> subtract2d(tool = pipeHole)
8786
|> sweep(path = sweepPath)
8887
|> rotate(roll = 10, pitch = 10, yaw = 90)
@@ -104,11 +103,10 @@ sweepPath = startSketchOn(XZ)
104103
|> line(end = [0, 7])
105104

106105
// Create a hole for the pipe.
107-
pipeHole = startSketchOn(XY)
108-
|> circle(center = [0, 0], radius = 1.5)
106+
pipeSketch = startSketchOn(XY)
107+
pipeHole = circle(pipeSketch, center = [0, 0], radius = 1.5)
109108

110-
sweepSketch = startSketchOn(XY)
111-
|> circle(center = [0, 0], radius = 2)
109+
pipe = circle(pipeSketch, center = [0, 0], radius = 2)
112110
|> subtract2d(tool = pipeHole)
113111
|> sweep(path = sweepPath)
114112
|> rotate(roll = 10)
@@ -130,11 +128,10 @@ sweepPath = startSketchOn(XZ)
130128
|> line(end = [0, 7])
131129

132130
// Create a hole for the pipe.
133-
pipeHole = startSketchOn(XY)
134-
|> circle(center = [0, 0], radius = 1.5)
131+
pipeSketch = startSketchOn(XY)
132+
pipeHole = circle(pipeSketch, center = [0, 0], radius = 1.5)
135133

136-
sweepSketch = startSketchOn(XY)
137-
|> circle(center = [0, 0], radius = 2)
134+
pipe = circle(pipeSketch, center = [0, 0], radius = 2)
138135
|> subtract2d(tool = pipeHole)
139136
|> sweep(path = sweepPath)
140137
|> rotate(axis = Z, angle = 90deg)
@@ -169,11 +166,10 @@ sweepPath = startSketchOn(XZ)
169166
|> line(end = [0, 7])
170167

171168
// Create a hole for the pipe.
172-
pipeHole = startSketchOn(XY)
173-
|> circle(center = [0, 0], radius = 1.5)
169+
pipeSketch = startSketchOn(XY)
170+
pipeHole = circle(pipeSketch, center = [0, 0], radius = 1.5)
174171

175-
sweepSketch = startSketchOn(XY)
176-
|> circle(center = [0, 0], radius = 2)
172+
pipe = circle(pipeSketch, center = [0, 0], radius = 2)
177173
|> subtract2d(tool = pipeHole)
178174
|> sweep(path = sweepPath)
179175
|> rotate(axis = [0, 0, 1.0], angle = 90deg)

0 commit comments

Comments
 (0)