658497da1d
* allow named axis for patterns Signed-off-by: Jess Frazelle <github@jessfraz.com> * docs Signed-off-by: Jess Frazelle <github@jessfraz.com> * images Signed-off-by: Jess Frazelle <github@jessfraz.com> * Fix typo Co-authored-by: Jonathan Tran <jonnytran@gmail.com> --------- Signed-off-by: Jess Frazelle <github@jessfraz.com> Co-authored-by: Adam Chalmers <adam.chalmers@zoo.dev> Co-authored-by: Jonathan Tran <jonnytran@gmail.com>
66 lines
126 KiB
Markdown
66 lines
126 KiB
Markdown
---
|
|
title: "patternLinear2d"
|
|
subtitle: "Function in std"
|
|
excerpt: "Repeat a 2-dimensional sketch along some dimension, with a dynamic amount of distance between each repetition, some specified number of times."
|
|
layout: manual
|
|
---
|
|
|
|
Repeat a 2-dimensional sketch along some dimension, with a dynamic amount of distance between each repetition, some specified number of times.
|
|
|
|
```kcl
|
|
patternLinear2d(
|
|
@sketches: [Sketch],
|
|
instances: number,
|
|
distance: number,
|
|
axis: Point2d,
|
|
useOriginal?: bool,
|
|
): [Sketch]
|
|
```
|
|
|
|
|
|
|
|
### Arguments
|
|
|
|
| Name | Type | Description | Required |
|
|
|----------|------|-------------|----------|
|
|
| `sketches` | [`[Sketch]`](/docs/kcl-std/types/std-types-Sketch) | The sketch(es) to duplicate | Yes |
|
|
| `instances` | [`number`](/docs/kcl-std/types/std-types-number) | The number of total instances. Must be greater than or equal to 1. This includes the original entity. For example, if instances is 2, there will be two copies -- the original, and one new copy. If instances is 1, this has no effect. | Yes |
|
|
| `distance` | [`number`](/docs/kcl-std/types/std-types-number) | Distance between each repetition. Also known as 'spacing'. | Yes |
|
|
| `axis` | [`Point2d`](/docs/kcl-std/types/std-types-Point2d) | The axis of the pattern. A 2D vector. | Yes |
|
|
| `useOriginal` | [`bool`](/docs/kcl-std/types/std-types-bool) | If the target was sketched on an extrusion, setting this will use the original sketch as the target, not the entire joined solid. Defaults to false. | No |
|
|
|
|
### Returns
|
|
|
|
[`[Sketch]`](/docs/kcl-std/types/std-types-Sketch)
|
|
|
|
|
|
### Examples
|
|
|
|
```kcl
|
|
// / Pattern using a named axis.
|
|
|
|
|
|
exampleSketch = startSketchOn(XZ)
|
|
|> circle(center = [0, 0], radius = 1)
|
|
|> patternLinear2d(axis = X, instances = 7, distance = 4)
|
|
|
|
example = extrude(exampleSketch, length = 1)
|
|
```
|
|
|
|
|
|
|
|
```kcl
|
|
// / Pattern using a raw axis.
|
|
|
|
|
|
exampleSketch = startSketchOn(XZ)
|
|
|> circle(center = [0, 0], radius = 1)
|
|
|> patternLinear2d(axis = [1, 0], instances = 7, distance = 4)
|
|
|
|
example = extrude(exampleSketch, length = 1)
|
|
```
|
|
|
|
|
|
|
|
|