ByoungSooPark/modeling-app
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Make the function signature less prominent, add an early example to docs

Browse Source 
Signed-off-by: Nick Cameron <nrc@ncameron.org>
This commit is contained in:
Nick Cameron
2025-06-19 17:08:46 +12:00
parent 6358eed7e4
commit ff1be99351
99 changed files with 2137 additions and 686 deletions
Download Patch File Download Diff File Expand all files Collapse all files

53
docs/kcl-std/functions/std-transform-translate.md
View File

@ -8,21 +8,29 @@ layout: manual
Move a solid or a sketch.
```kcl
translate(
@objects: [Solid; 1+] | [Sketch; 1+] | ImportedGeometry,
x?: number(Length),
y?: number(Length),
z?: number(Length),
global?: bool,
): [Solid; 1+] | [Sketch; 1+] | ImportedGeometry
// Move a pipe.
// Create a path for the sweep.
sweepPath = startSketchOn(XZ)
|> startProfile(at = [0.05, 0.05])
|> line(end = [0, 7])
|> tangentialArc(angle = 90deg, radius = 5)
|> line(end = [-3, 0])
|> tangentialArc(angle = -90deg, radius = 5)
|> line(end = [0, 7])
// Create a hole for the pipe.
pipeHole = startSketchOn(XY)
|> circle(center = [0, 0], radius = 1.5)
sweepSketch = startSketchOn(XY)
|> circle(center = [0, 0], radius = 2)
|> subtract2d(tool = pipeHole)
|> sweep(path = sweepPath)
|> translate(x = 1.0, y = 1.0, z = 2.5)
```
This is really useful for assembling parts together. You can create a part
and then move it to the correct location.
Translate is really useful for sketches if you want to move a sketch
and then rotate it using the `rotate` function to create a loft.
### Arguments
| Name | Type | Description | Required |
@ -37,6 +45,25 @@ and then rotate it using the `rotate` function to create a loft.
[`[Solid; 1+]`](/docs/kcl-std/types/std-types-Solid) or [`[Sketch; 1+]`](/docs/kcl-std/types/std-types-Sketch) or [`ImportedGeometry`](/docs/kcl-std/types/std-types-ImportedGeometry)
### Description
This is really useful for assembling parts together. You can create a part
and then move it to the correct location.
Translate is really useful for sketches if you want to move a sketch
and then rotate it using the `rotate` function to create a loft.
### Function signature
```kcl
translate(
@objects: [Solid; 1+] | [Sketch; 1+] | ImportedGeometry,
x?: number(Length),
y?: number(Length),
z?: number(Length),
global?: bool,
): [Solid; 1+] | [Sketch; 1+] | ImportedGeometry
```
### Examples