aad583be2e
Move axes to std constants; move helix, revolve, and mirror2d to be declated in KCL Signed-off-by: Nick Cameron <nrc@ncameron.org>
218 lines
574 KiB
Markdown
218 lines
574 KiB
Markdown
---
|
|
title: "startSketchOn"
|
|
excerpt: "Start a new 2-dimensional sketch on a specific plane or face."
|
|
layout: manual
|
|
---
|
|
|
|
Start a new 2-dimensional sketch on a specific plane or face.
|
|
|
|
### Sketch on Face Behavior
|
|
|
|
There are some important behaviors to understand when sketching on a face:
|
|
|
|
The resulting sketch will _include_ the face and thus Solid that was sketched on. So say you were to export the resulting Sketch / Solid from a sketch on a face, you would get both the artifact of the sketch on the face and the parent face / Solid itself.
|
|
|
|
This is important to understand because if you were to then sketch on the resulting Solid, it would again include the face and parent Solid that was sketched on. This could go on indefinitely.
|
|
|
|
The point is if you want to export the result of a sketch on a face, you only need to export the final Solid that was created from the sketch on the face, since it will include all the parent faces and Solids.
|
|
|
|
```js
|
|
startSketchOn(
|
|
data: SketchData,
|
|
tag?: FaceTag,
|
|
): SketchSurface
|
|
```
|
|
|
|
|
|
### Arguments
|
|
|
|
| Name | Type | Description | Required |
|
|
|----------|------|-------------|----------|
|
|
| `data` | [`SketchData`](/docs/kcl/types/SketchData) | Data for start sketch on. You can start a sketch on a plane or an solid. | Yes |
|
|
| [`tag`](/docs/kcl/types/tag) | [`FaceTag`](/docs/kcl/types/FaceTag) | A tag for a face. | No |
|
|
|
|
### Returns
|
|
|
|
[`SketchSurface`](/docs/kcl/types/SketchSurface) - A sketch type.
|
|
|
|
|
|
### Examples
|
|
|
|
```js
|
|
exampleSketch = startSketchOn(XY)
|
|
|> startProfileAt([0, 0], %)
|
|
|> line(end = [10, 0])
|
|
|> line(end = [0, 10])
|
|
|> line(end = [-10, 0])
|
|
|> close()
|
|
|
|
example = extrude(exampleSketch, length = 5)
|
|
|
|
exampleSketch002 = startSketchOn(example, 'end')
|
|
|> startProfileAt([1, 1], %)
|
|
|> line(end = [8, 0])
|
|
|> line(end = [0, 8])
|
|
|> line(end = [-8, 0])
|
|
|> close()
|
|
|
|
example002 = extrude(exampleSketch002, length = 5)
|
|
|
|
exampleSketch003 = startSketchOn(example002, 'end')
|
|
|> startProfileAt([2, 2], %)
|
|
|> line(end = [6, 0])
|
|
|> line(end = [0, 6])
|
|
|> line(end = [-6, 0])
|
|
|> close()
|
|
|
|
example003 = extrude(exampleSketch003, length = 5)
|
|
```
|
|
|
|
|
|
|
|
```js
|
|
// Sketch on the end of an extruded face by tagging the end face.
|
|
|
|
|
|
exampleSketch = startSketchOn(XY)
|
|
|> startProfileAt([0, 0], %)
|
|
|> line(end = [10, 0])
|
|
|> line(end = [0, 10])
|
|
|> line(end = [-10, 0])
|
|
|> close()
|
|
|
|
example = extrude(exampleSketch, length = 5, tagEnd = $end01)
|
|
|
|
exampleSketch002 = startSketchOn(example, end01)
|
|
|> startProfileAt([1, 1], %)
|
|
|> line(end = [8, 0])
|
|
|> line(end = [0, 8])
|
|
|> line(end = [-8, 0])
|
|
|> close()
|
|
|
|
example002 = extrude(exampleSketch002, length = 5, tagEnd = $end02)
|
|
|
|
exampleSketch003 = startSketchOn(example002, end02)
|
|
|> startProfileAt([2, 2], %)
|
|
|> line(end = [6, 0])
|
|
|> line(end = [0, 6])
|
|
|> line(end = [-6, 0])
|
|
|> close()
|
|
|
|
example003 = extrude(exampleSketch003, length = 5)
|
|
```
|
|
|
|
|
|
|
|
```js
|
|
exampleSketch = startSketchOn(XY)
|
|
|> startProfileAt([0, 0], %)
|
|
|> line(end = [10, 0])
|
|
|> line(end = [0, 10], tag = $sketchingFace)
|
|
|> line(end = [-10, 0])
|
|
|> close()
|
|
|
|
example = extrude(exampleSketch, length = 10)
|
|
|
|
exampleSketch002 = startSketchOn(example, sketchingFace)
|
|
|> startProfileAt([1, 1], %)
|
|
|> line(end = [8, 0])
|
|
|> line(end = [0, 8])
|
|
|> line(end = [-8, 0])
|
|
|> close(tag = $sketchingFace002)
|
|
|
|
example002 = extrude(exampleSketch002, length = 10)
|
|
|
|
exampleSketch003 = startSketchOn(example002, sketchingFace002)
|
|
|> startProfileAt([-8, 12], %)
|
|
|> line(end = [0, 6])
|
|
|> line(end = [6, 0])
|
|
|> line(end = [0, -6])
|
|
|> close()
|
|
|
|
example003 = extrude(exampleSketch003, length = 5)
|
|
```
|
|
|
|
|
|
|
|
```js
|
|
exampleSketch = startSketchOn(XY)
|
|
|> startProfileAt([4, 12], %)
|
|
|> line(end = [2, 0])
|
|
|> line(end = [0, -6])
|
|
|> line(end = [4, -6])
|
|
|> line(end = [0, -6])
|
|
|> line(end = [-3.75, -4.5])
|
|
|> line(end = [0, -5.5])
|
|
|> line(end = [-2, 0])
|
|
|> close()
|
|
|
|
example = revolve(exampleSketch, axis = Y, angle = 180)
|
|
|
|
exampleSketch002 = startSketchOn(example, 'end')
|
|
|> startProfileAt([4.5, -5], %)
|
|
|> line(end = [0, 5])
|
|
|> line(end = [5, 0])
|
|
|> line(end = [0, -5])
|
|
|> close()
|
|
|
|
example002 = extrude(exampleSketch002, length = 5)
|
|
```
|
|
|
|
|
|
|
|
```js
|
|
// Sketch on the end of a revolved face by tagging the end face.
|
|
|
|
|
|
exampleSketch = startSketchOn(XY)
|
|
|> startProfileAt([4, 12], %)
|
|
|> line(end = [2, 0])
|
|
|> line(end = [0, -6])
|
|
|> line(end = [4, -6])
|
|
|> line(end = [0, -6])
|
|
|> line(end = [-3.75, -4.5])
|
|
|> line(end = [0, -5.5])
|
|
|> line(end = [-2, 0])
|
|
|> close()
|
|
|
|
example = revolve(
|
|
exampleSketch,
|
|
axis = Y,
|
|
angle = 180,
|
|
tagEnd = $end01,
|
|
)
|
|
|
|
exampleSketch002 = startSketchOn(example, end01)
|
|
|> startProfileAt([4.5, -5], %)
|
|
|> line(end = [0, 5])
|
|
|> line(end = [5, 0])
|
|
|> line(end = [0, -5])
|
|
|> close()
|
|
|
|
example002 = extrude(exampleSketch002, length = 5)
|
|
```
|
|
|
|
|
|
|
|
```js
|
|
a1 = startSketchOn({
|
|
plane = {
|
|
origin = { x = 0, y = 0, z = 0 },
|
|
xAxis = { x = 1, y = 0, z = 0 },
|
|
yAxis = { x = 0, y = 1, z = 0 },
|
|
zAxis = { x = 0, y = 0, z = 1 }
|
|
}
|
|
})
|
|
|> startProfileAt([0, 0], %)
|
|
|> line(end = [100.0, 0])
|
|
|> yLine(length = -100.0)
|
|
|> xLine(length = -100.0)
|
|
|> yLine(length = 100.0)
|
|
|> close()
|
|
|> extrude(length = 3.14)
|
|
```
|
|
|
|
|
|
|
|
|