123 lines
510 KiB
Markdown
123 lines
510 KiB
Markdown
|
---
|
||
|
|
title: "std::offsetPlane"
|
||
|
|
excerpt: "Offset a plane by a distance along its normal."
|
||
|
|
layout: manual
|
||
|
|
---
|
||
|
|
|
||
|
|
Offset a plane by a distance along its normal.
|
||
|
|
|
||
|
|
For example, if you offset the `XZ` plane by 10, the new plane will be parallel to the `XZ`
|
||
|
|
plane and 10 units away from it.
|
||
|
|
|
||
|
|
```js
|
||
|
|
offsetPlane(
|
||
|
|
@plane: Plane,
|
||
|
|
offset: number(Length),
|
||
|
|
): Plane
|
||
|
|
```
|
||
|
|
|
||
|
|
|
||
|
|
### Arguments
|
||
|
|
|
||
|
|
| Name | Type | Description | Required |
|
||
|
|
|----------|------|-------------|----------|
|
||
|
|
| `plane` | [`Plane`](/docs/kcl/types/Plane) | The plane (e.g. `XY`) which this new plane is created from. | Yes |
|
||
|
|
| `offset` | `number(Length)` | Distance from the standard plane this new plane will be created at. | Yes |
|
||
|
|
|
||
|
|
### Returns
|
||
|
|
|
||
|
|
[`Plane`](/docs/kcl/types/Plane)
|
||
|
|
|
||
|
|
|
||
|
|
### Examples
|
||
|
|
|
||
|
|
```js
|
||
|
|
// Loft a square and a circle on the `XY` plane using offset.
|
||
|
|
squareSketch = startSketchOn(XY)
|
||
|
|
|> startProfileAt([-100, 200], %)
|
||
|
|
|> line(end = [200, 0])
|
||
|
|
|> line(end = [0, -200])
|
||
|
|
|> line(end = [-200, 0])
|
||
|
|
|> line(endAbsolute = [profileStartX(%), profileStartY(%)])
|
||
|
|
|> close()
|
||
|
|
|
||
|
|
circleSketch = startSketchOn(offsetPlane(XY, offset = 150))
|
||
|
|
|> circle( center = [0, 100], radius = 50 )
|
||
|
|
|
||
|
|
loft([squareSketch, circleSketch])
|
||
|
|
```
|
||
|
|
|
||
|
|
|
||
|
|
|> startProfileAt([-100, 200], %)
|
||
|
|
|> line(end = [200, 0])
|
||
|
|
|> line(end = [0, -200])
|
||
|
|
|> line(end = [-200, 0])
|
||
|
|
|> line(endAbsolute = [profileStartX(%), profileStartY(%)])
|
||
|
|
|> close()
|
||
|
|
|
||
|
|
circleSketch = startSketchOn(offsetPlane(XZ, offset = 150))
|
||
|
|
|> circle( center = [0, 100], radius = 50 )
|
||
|
|
|
||
|
|
loft([squareSketch, circleSketch])
|
||
|
|
```
|
||
|
|
|
||
|
|
|
||
|
|
|> startProfileAt([-100, 200], %)
|
||
|
|
|> line(end = [200, 0])
|
||
|
|
|> line(end = [0, -200])
|
||
|
|
|> line(end = [-200, 0])
|
||
|
|
|> line(endAbsolute = [profileStartX(%), profileStartY(%)])
|
||
|
|
|> close()
|
||
|
|
|
||
|
|
circleSketch = startSketchOn(offsetPlane(YZ, offset = 150))
|
||
|
|
|> circle( center = [0, 100], radius = 50 )
|
||
|
|
|
||
|
|
loft([squareSketch, circleSketch])
|
||
|
|
```
|
||
|
|
|
||
|
|
|
||
|
|
|> startProfileAt([-100, 200], %)
|
||
|
|
|> line(end = [200, 0])
|
||
|
|
|> line(end = [0, -200])
|
||
|
|
|> line(end = [-200, 0])
|
||
|
|
|> line(endAbsolute = [profileStartX(%), profileStartY(%)])
|
||
|
|
|> close()
|
||
|
|
|
||
|
|
circleSketch = startSketchOn(offsetPlane(-XZ, offset = 150))
|
||
|
|
|> circle(center = [0, 100], radius = 50)
|
||
|
|
|
||
|
|
loft([squareSketch, circleSketch])
|
||
|
|
```
|
||
|
|
|
||
|
|
|
||
|
|
|> startProfileAt([0, 0], %)
|
||
|
|
|> circle( radius = 10, center = [0, 0] )
|
||
|
|
|
||
|
|
// Triangle on the plane 4 units above
|
||
|
|
startSketchOn(offsetPlane(XY, offset = 4))
|
||
|
|
|> startProfileAt([0, 0], %)
|
||
|
|
|> line(end = [10, 0])
|
||
|
|
|> line(end = [0, 10])
|
||
|
|
|> close()
|
||
|
|
```
|
||
|
|
|
||
|
|
![Rendered example of std::offsetPlane 4](data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAABQAAAALQCAYAAADPfd1WAACDrUlEQVR4Ae3AA6AkWZbG8f937o3IzKdyS2Oubdu2bdu2bdu2bWmMnpZKr54yMyLu+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/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/KipXXXXVVVddddVVV1111VVXXXXVVVd
|
||
|
|
|
||
|
|
|