Files
modeling-app/docs/kcl/translate.md

62 lines
104 KiB
Markdown
Raw Normal View History

---
title: "translate"
excerpt: "Move a solid."
layout: manual
---
Move a solid.
```js
translate(
solid: Solid,
translate: [number],
global?: bool,
) -> Solid
```
### Arguments
| Name | Type | Description | Required |
|----------|------|-------------|----------|
| `solid` | [`Solid`](/docs/kcl/types/Solid) | The solid to move. | Yes |
| `translate` | `[number]` | The amount to move the solid in all three axes. | Yes |
| `global` | `bool` | If true, the transform is applied in global space. The origin of the model will move. By default, the transform is applied in local sketch axis, therefore the origin will not move. | No |
### Returns
[`Solid`](/docs/kcl/types/Solid) - A solid is a collection of extrude surfaces.
### Examples
```js
// Move a pipe.
// Create a path for the sweep.
sweepPath = startSketchOn('XZ')
|> startProfileAt([0.05, 0.05], %)
|> line(end = [0, 7])
|> tangentialArc({ offset = 90, radius = 5 }, %)
|> line(end = [-3, 0])
|> tangentialArc({ offset = -90, 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 }, %)
|> hole(pipeHole, %)
|> sweep(path = sweepPath)
|> translate(translate = [1.0, 1.0, 2.5])
```
![Rendered example of translate 0](data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAABQAAAALQCAYAAADPfd1WAAEy80lEQVR4Ae3AA6AkWZbG8f937o3IzKdyS2Oubdu2bdu2bdu2bWmMnpZKr54yMyLu+Xa3anqmhztr1a8+6EEP4qqrrrrqqquuuuqqq6666qqrrrrqqquu+j+JylVXXXXVVVddddVVV1111VVXXXXVVVdd9X8Vlauuuuqqq6666qqrrrrqqquuuuqqq6666v8qKlddddVVV1111VVXXXXVVVddddVVV1111f9VVK666qqrrrrqqquuuuqqq6666qqrrrrqqv+rqFx11VVXXXXVVVddddVVV1111VVXXXXVVf9XUbnqqquuuuqqq6666qqrrrrqqquuuuqqq/6vonLVVVddddVVV1111VVXXXXVVVddddVVV/1fReWqq6666qqrrrrqqquuuuqqq6666qqrrvq/ispVV1111VVXXXXVVVddddVVV1111VVXXfV/FZWrrrrqqquuuuqqq6666qqrrrrqqquuuur/KipXXXXVVVddddVVV1111VVXXXXVVVddddX/VVSuuuqqq6666qqrrrrqqquuuuqqq6666qr/q6hcddVVV1111VVXXXXVVVddddVVV1111VX/V1G56qqrrrrqqquuuuqqq6666qqrrrrqqqv+r6Jy1VVXXXXVVVddddVVV1111VVXXXXVVVf9X0Xlqquuuuqqq6666qqrrrrqqquuuuqqq676v4rKVVddddVVV1111VVXXXXVVVddddVVV131fxWVq6666qqrrrrqqquuuuqqq6666qqrrrrq/yoqV1111VVXXXXVVVddddVVV1111VVXXXXV/1VUrrrqqquuuuqqq6666qqrrrrqqquuuuqq/6uoXHXVVVddddVVV1111VVXXXXVVVddddVV/1dRueqqq6666qqrrrrqqquuuuqqq6666qqr/q+ictVVV1111VVXXXXVVVddddVVV1111VVX/V9F5aqrrrrqqquuuuqqq6666qqrrrrqqquu+r+KylVXXXXVVVddddVVV1111VVXXXXVVVdd9X8Vlauuuuqqq6666qqrrrrqqquuuuqqq6666v8qKlddddVVV1111VVXXXXVVVddddVVV1111f9VVK666qqrrrrqqquuuuqqq6666qqrrrrqqv+rqFx11VVXXXXVVVddddVVV1111VVXXXXVVf9XUbnqqquuuuqqq6666qqrrrrqqquuuuqqq/6vonLVVVddddVVV1111VVXXXXVVVddddVVV/1fReWqq6666qqrrrrqqquuuuqqq6666qqrrvq/ispVV1111VVXXXXVVVddddVVV1111VVXXfV/FZWrrrrqqquuuuqqq6666qqrrrrqqquuuur/KipXXXXVVVddddVVV1111VVXXXXVVVddddX/VVSuuuqqq6666qqrrrrqqquuuuqqq6666qr/q6hcddVVV1111VVXXXXVVVddddVVV1111VX/V1G56qqrrrrqqquuuuqqq6666qqrrrrqqqv+r6Jy1VVXXXXVVVddddVVV1111VVXXXXVVVf9X0Xlqquuuuqqq6666qqrrrrqqquuuuqqq676v4rKVVddddVVV1111VVXXXXVVVddddVVV131fxWVq6666qqrrrrqqquuuuqqq6666qqrrrrq/yoqV1111VVXXXXVVVddddVVV1111VVXXXXV/1VUrrrqqquuuuqqq6666qqrrrrqqquuuuqq/6uoXHXVVVddddVVV1111VVXXXXVVVddddVV/1dRueqqq6666qqrrrrqqquuuuqqq6666qqr/q+ictVVV1111VVXXXXVVVddddVVV1111VVX/V9F5aqrrrrqqquuuuqqq6666qqrrrrqqquu+r+KylVXXXXVVVddddVVV1111VVXXXXVVVdd9X8Vlauuuuqqq6666qqrrrrqqquuuuqqq6666v8qKlddddVVV1111VVXXXXVVVddddVVV1111f9VVK666qqrrrrqqquuuuqqq6666qqrrrrqqv+rqFx11VVXXXXVVVddddVVV1111VVXXXXVVf9XUbnqqquuuuqqq6666qqrrrrqqquuuuqqq/6vonLVVVddddVVV1111VVXXXXVVVddddVVV/1fReWqq6666qqrrrrqqquuuuqqq6666qqrrvq/ispVV1111VVXXXXVVVddddVVV1111VVXXfV/FZWrrrrqqquuuuqqq6666qqrrrrqqquuuur/KipXXXXVVVddddVVV1111VVXXXXVVVddddX/VVSuuuqqq6666qqrrrrqqquuuuqqq6666qr/q6hcddVVV1111VVXXXXVVVddddVVV1111VX/V1G56qqrrrrqqquuuuqqq6666qqrrrrqqqv+r6Jy1VVXXXXVVVddddVVV1111VVXXXXVVVf9X0Xlqquuuuqqq6666qqrrrrqqquuuuqqq676v4rKVVddddVVV1111VVXXXXVVVddddVVV131fxWVq6666qqrrrrqqquuuuqqq6666qqrrrrq/yoqV1111VVXXXXVVVddddVVV1111VVXXXXV/1VUrrrqqquuuuqqf5NrrrnmwQBnzpx5MMA111zzYIAzZ848iGe65pprHgxwzTXXPJhnOnPmzIN5gGuuuebB/Dvcd999t15zzTUPvu+++27luZw9e/ZWgPvuu+9Wnum+++67FeDs2bPPALjvvvtuBTh79uyt9913361cddVVV1111VVXXXXVVf+XoAc96EFcddVVV1111VVXXHPNNQ8GOHPmzINf7MVe7LV4phd/8Rd/bYAzZ848+JprrnkwL8B99913a9/3Dwa49dZbefCDH8zu7i7Hjx8H4Pjx4+zu7vKiOH78OAC7u7sA7O7uAnD8+HGe2+7uLs9td3eX++3u7nL8+HEAjh8/DsCDH/xgnp/77rvv1rNnz95633333QrwD//wD79z33333Xr27Nlb77vvvlu56qqrrrrqqquuuuqqq/43QQ960IO46qqrrrrqqv9PrrnmmgefOXPmwS/2Yi/2WgAv/uIv/toAL/ZiL/baPJdbb72V3d1ddnd3OX78OPc7fvw4u7u7ABw/fpzjx49z/Phxnp/d3V3ut7u7y/0e/OAH8x/p1ltv5X7Hjx/n+PHj3G93d5fjx4+zu7vL7u4uu7u7ANx6663s7u6yu7sLwIkTJzh+/DgAD3rQgwA4fvw4D37wgwH4h3/4h98GuO+++279rd/6re/5h3/4h9/mqquuuuqqq6666qqrrvqfDD3oQQ/iqquuuuqqq/6vuuaaax78Yi/2Yq995syZB734i7/4a7/Yi73Ya/MAf/3Xf83u7i4At956KwC7u7u89Eu/NAAPfvCDOX78OMePH+d+u7u77O7uslgsuPbaa3luR0dHAEhiuVwSEQzDQESQmdRaqbVSayUiKKUgCUlkJq01pmlitVoxDAPr9Zr1ek1EMI4jrTVaa0zTRGaSmWxsbJCZbG5uAmCbra0tALa3t9nZ2eG5/fVf/zXHjx/nwQ9+MAC7u7vceuutPOMZz+Cv//qveW7Hjx/nwQ9+MAAv9VIvxYMf/GDuu+++W//hH/7ht3/0R3/0c+67775bueqqq6666qqrrrrqqqv+p0EPetCDuOqqq6666qr/S6655poHv/Zrv/Z7vdM7vdNn80y33nort956K894xjO49dZbeaAHP/jBPOhBD+LBD34wD37wgwHY3d3l+PHjPNDBwQH7+/scHh5ycHCAJA4PDzk6OmK5XLJcLokISimUUiil0HUdXdfRdR2z2Yz5fM58Pmc+nzOfz5nNZnRdRykFgMxkmibW6zXr9ZrlcslyuWS5XLJarViv1wzDwDiOjOPINE201mit0VqjtUZmkpnYJjPJTGyztbVFZrKzs8P29ja2uemmmzh27BgPetCDeKDd3V1+53d+h7/5m7/hBTl+/DjHjh3jpV/6pbn++utv/dEf/dHP+a3f+q3v5qqrrrrqqquuuuqqq676n4TKVVddddVVV/