kcl-stdfunctionspatternLinear2d

patternLinear2dFunction in std::sketch

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

patternLinear2d(
  @sketches: [Sketch; 1+],
  instances: number(_),
  distance: number(Length),
  axis: Axis2d | Point2d,
  useOriginal?: bool,
): [Sketch; 1+]

Arguments

NameTypeDescriptionRequired
sketches[Sketch; 1+]The sketch(es) to duplicate.Yes
instancesnumber(_)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
distancenumber(Length)Distance between each repetition. Also known as 'spacing'.Yes
axisAxis2d or Point2dThe 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.No

Returns

[Sketch; 1+]

Examples

// / 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)

Rendered example of patternLinear2d 0

// / 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)

Rendered example of patternLinear2d 1

Found a typo?