358b34de4c
* change translate & scale to be better & docs Signed-off-by: Jess Frazelle <github@jessfraz.com> * autocomplete Signed-off-by: Jess Frazelle <github@jessfraz.com> * gen std Signed-off-by: Jess Frazelle <github@jessfraz.com> * kcl-samples Signed-off-by: Jess Frazelle <github@jessfraz.com> * updates Signed-off-by: Jess Frazelle <github@jessfraz.com> --------- Signed-off-by: Jess Frazelle <github@jessfraz.com>
122 lines
272 KiB
Markdown
122 lines
272 KiB
Markdown
---
|
|
title: "scale"
|
|
excerpt: "Scale a solid or a sketch."
|
|
layout: manual
|
|
---
|
|
|
|
Scale a solid or a sketch.
|
|
|
|
This is really useful for resizing parts. You can create a part and then scale it to the correct size.
|
|
|
|
For sketches, you can use this to scale a sketch and then loft it with another sketch.
|
|
|
|
By default the transform is applied in local sketch axis, therefore the origin will not move.
|
|
|
|
If you want to apply the transform in global space, set `global` to `true`. The origin of the model will move. If the model is not centered on origin and you scale globally it will look like the model moves and gets bigger at the same time. Say you have a square `(1,1) - (1,2) - (2,2) - (2,1)` and you scale by 2 globally it will become `(2,2) - (2,4)`...etc so the origin has moved from `(1.5, 1.5)` to `(2,2)`.
|
|
|
|
```js
|
|
scale(
|
|
objects: SolidOrSketchOrImportedGeometry,
|
|
x: number,
|
|
y: number,
|
|
z: number,
|
|
global?: bool,
|
|
): SolidOrSketchOrImportedGeometry
|
|
```
|
|
|
|
|
|
### Arguments
|
|
|
|
| Name | Type | Description | Required |
|
|
|----------|------|-------------|----------|
|
|
| `objects` | [`SolidOrSketchOrImportedGeometry`](/docs/kcl/types/SolidOrSketchOrImportedGeometry) | The solid, sketch, or set of solids or sketches to scale. | Yes |
|
|
| `x` | [`number`](/docs/kcl/types/number) | The scale factor for the x axis. | Yes |
|
|
| `y` | [`number`](/docs/kcl/types/number) | The scale factor for the y axis. | Yes |
|
|
| `z` | [`number`](/docs/kcl/types/number) | The scale factor for the z axis. | Yes |
|
|
| `global` | [`bool`](/docs/kcl/types/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
|
|
|
|
[`SolidOrSketchOrImportedGeometry`](/docs/kcl/types/SolidOrSketchOrImportedGeometry) - Data for a solid or an imported geometry.
|
|
|
|
|
|
### Examples
|
|
|
|
```js
|
|
// Scale 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)
|
|
|> scale(x = 1.0, y = 1.0, z = 2.5)
|
|
```
|
|
|
|
|
|
|
|
```js
|
|
// Scale an imported model.
|
|
|
|
|
|
import "tests/inputs/cube.sldprt" as cube
|
|
|
|
cube
|
|
|> scale(x = 1.0, y = 1.0, z = 2.5)
|
|
```
|
|
|
|
|
|
|
|
```js
|
|
// Sweep two sketches along the same path.
|
|
|
|
|
|
sketch001 = startSketchOn(XY)
|
|
rectangleSketch = startProfileAt([-200, 23.86], sketch001)
|
|
|> angledLine([0, 73.47], %, $rectangleSegmentA001)
|
|
|> angledLine([
|
|
segAng(rectangleSegmentA001) - 90,
|
|
50.61
|
|
], %)
|
|
|> angledLine([
|
|
segAng(rectangleSegmentA001),
|
|
-segLen(rectangleSegmentA001)
|
|
], %)
|
|
|> line(endAbsolute = [profileStartX(%), profileStartY(%)])
|
|
|> close()
|
|
|
|
circleSketch = circle(sketch001, center = [200, -30.29], radius = 32.63)
|
|
|
|
sketch002 = startSketchOn(YZ)
|
|
sweepPath = startProfileAt([0, 0], sketch002)
|
|
|> yLine(length = 231.81)
|
|
|> tangentialArc({ radius = 80, offset = -90 }, %)
|
|
|> xLine(length = 384.93)
|
|
|
|
parts = sweep([rectangleSketch, circleSketch], path = sweepPath)
|
|
|
|
// Scale the sweep.
|
|
scale(
|
|
parts,
|
|
x = 1.0,
|
|
y = 1.0,
|
|
z = 0.5,
|
|
)
|
|
```
|
|
|
|
|
|
|
|
|