kcl-std → functions → patternLinear3d

patternLinear3dFunction in std::solid

Repeat a 3-dimensional solid along a linear path, with a dynamic amount of distance between each repetition, some specified number of times.

Arguments

NameTypeDescriptionRequired
solids[Solid; 1+]The solid(s) 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
axisAxis3d or Point3dThe axis of the pattern. A 3D 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

[Solid; 1+]

Examples

Found a typo?