kcl

patternLinear2d

Repeat a 2-dimensional sketch along some dimension, with a dynamic amount of distance between each repetition, some specified number of times.

patternLinear2d(
  sketchSet: SketchSet,
  instances: integer,
  distance: number,
  axis: [number],
  useOriginal?: bool,
): [Sketch]

Arguments

NameTypeDescriptionRequired
sketchSetSketchSetThe sketch(es) to duplicateYes
instancesintegerThe 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
distancenumberDistance between each repetition. Also known as 'spacing'.Yes
axis[number]The axis of the pattern. A 2D vector.Yes
useOriginalboolIf 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]

Examples

exampleSketch = startSketchOn('XZ')
  |> circle(center = [0, 0], radius = 1)
  |> patternLinear2d(axis = [1, 0], instances = 7, distance = 4)

example = extrude(exampleSketch, length = 1)

Rendered example of patternLinear2d 0