Files
modeling-app/docs/kcl/patternTransform.md

373 lines
454 KiB
Markdown
Raw Normal View History

2024-06-27 22:20:51 -05:00
---
title: "patternTransform"
excerpt: "A linear pattern on a 3D solid."
layout: manual
---
A linear pattern on a 3D solid.
Each repetition of the pattern can be transformed (e.g. scaled, translated, hidden, etc).
```js
patternTransform(num_repetitions: u32, transform_function: FunctionParam, extrude_group_set: ExtrudeGroupSet) -> [ExtrudeGroup]
```
### Examples
```js
// Parameters
const r = 50 // base radius
const h = 10 // layer height
const t = 0.005 // taper factor [0-1)
// Defines how to modify each layer of the vase.
// Each replica is shifted up the Z axis, and has a smoothly-varying radius
fn transform = (replicaId) => {
let scale = r * abs(1 - (t * replicaId)) * (5 + cos(replicaId / 8))
return {
translate: [0, 0, replicaId * 10],
scale: [scale, scale, 0]
}
}
// Each layer is just a pretty thin cylinder.
fn layer = () => {
return startSketchOn("XY")
// or some other plane idk
|> circle([0, 0], 1, %, $tag1)
|> extrude(h, %)
}
// The vase is 100 layers tall.
// The 100 layers are replica of each other, with a slight transformation applied to each.
let vase = layer()
|> patternTransform(100, transform, %)
```
![Rendered example of patternTransform 0](data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAABQAAAALQCAYAAADPfd1WAAU1DklEQVR4Ae3gAZAkSZIkSRKLqpm7R0REZmZmVlVVVVV3d3d3d/fMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMdHd3d3dXV1VVVVVmZkZGRIS7m5kKz0xmV3d1d3dPz8zMzMxMYn3Qgx7EVVddddVVV1111VVXXXXVVVddddVVV131fxKVq6666qqrrrrqqquuuuqqq6666qqrrrrq/yoqV1111VVXXXXVVVddddVVV1111VVXXXXV/1VUrrrqqquuuuqqq6666qqrrrrqqquuuuqq/6uoXHXVVVddddVVV1111VVXXXXVVVddddVV/1dRueqqq6666qqrrrrqqquuuuqqq6666qqr/q+ictVVV1111VVXXXXVVVddddVVV1111VVX/V9F5aqrrrrqqquuuuqqq6666qqrrrrqqquu+r+KylVXXXXVVVddddVVV1111VVXXXXVVVdd9X8Vlauuuuqqq6666qqrrrrqqquuuuqqq6666v8qKlddddVVV1111VVXXXXVVVddddVVV1111f9VVK666qqrrrrqqquuuuqqq6666qqrrrrqqv+rqFx11VVXXXXVVVddddVVV1111VVXXXXVVf9XUbnqqquuuuqqq6666qqrrrrqqquuuuqqq/6vonLVVVddddVVV1111VVXXXXVVVddddVVV/1fReWqq6666qqrrrrqqquuuuqqq6666qqrrvq/ispVV1111VVXXXXVVVddddVVV1111VVXXfV/FZWrrrrqqquuuuqqq6666qqrrrrqqquuuur/KipXXXXVVVddddVVV1111VVXXXXVVVddddX/VVSuuuqqq6666qqrrrrqqquuuuqqq6666qr/q6hcddVVV1111VVXXXXVVVddddVVV1111VX/V1G56qqrrrrqqquuuuqqq6666qqrrrrqqqv+r6Jy1VVXXXXVVVddddVVV1111VVXXXXVVVf9X0Xlqquuuuqqq6666qqrrrrqqquuuuqqq676v4rKVVddddVVV1111VVXXXXVVVddddVVV131fxWVq6666qqrrrrqqquuuuqqq6666qqrrrrq/yoqV1111VVXXXXVVVddddVVV1111VVXXXXV/1VUrrrqqquuuuqqq6666qqrrrrqqquuuuqq/6uoXHXVVVddddVVV1111VVXXXXVVVddddVV/1dRueqqq6666qqrrrrqqquuuuqqq6666qqr/q+ictVVV1111VVXXXXVVVddddVVV1111VVX/V9F5aqrrrrqqquuuuqqq6666qqrrrrqqquu+r+KylVXXXXVVVddddVVV1111VVXXXXVVVdd9X8Vlauuuuqqq6666qqrrrrqqquuuuqqq6666v8qKlddddVVV1111VVXXXXVVVddddVVV1111f9VVK666qqrrrrqqquuuuqqq6666qqrrrrqqv+rqFx11VVXXXXVVVddddVVV1111VVXXXXVVf9XUbnqqquuuuqqq6666qqrrrrqqquuuuqqq/6vonLVVVddddVVV1111VVXXXXVVVddddVVV/1fReWqq6666qqrrrrqqquuuuqqq6666qqrrvq/ispVV1111VVXXXXVVVddddVVV1111VVXXfV/FZWrrrrqqquuuuqqq6666qqrrrrqqquuuur/KipXXXXVVVddddVVV1111VVXXXXVVVddddX/VVSuuuqqq6666qqrrvoPdc011zyYZzpz5syDeaZrrrnmwTzAmTNnHsRzueaaax7Mc7nmmmsezAtx5syZB/Of7OzZs7fyAtx333238nzcd999t/IAZ8+efQYPcN99993KM509e/ZWnum+++67lauuuuqqq6666qqr/qOgBz3oQVx11VVXXXXVVVddBddcc82DAc6cOfNggGuuuebBZ86ceRDPdM011zwY4Jprrnkwz3TmzJkHA1xzzTUP5t/oD//wD3luly5d4vnZ29vjBZHE/S5dusS/1bFjx/iX7Ozs8ILs7OwAIAmAV3mVV+Hf6r777ruVZzp79uytAPfdd9+tPNN9991369mzZ5/BM9133323Apw9e/bW++6771auuuqqq6666qqrrkIPetCDuOqqq6666qqrrvq/5pprrnkwwJkzZx58zTXXPPjMmTMP4pmuueaaB19zzTUPPnPmzIMBrrnmmgfzAvzFX/wFFy9eZGNjA4BLly4BsLe3x/0uXboEwN7eHv/ZJPE/iST+s+zs7HC/nZ0dAI4dO8b9dnZ26PsegJd7uZfjBbnvvvtuBTh79uyt9913360A9913361nz559BsB99913K8A//MM//DZXXXXVVVddddVV//egBz3oQVx11VVXXXXVVVf9b3LNNdc8GODFXuzFXvvMmTMPArjmmmsefM011zz4zJkzD77mmmsefN999916zTXXPJhn+su//EuWyyUAe3t7XLp0CYC9vT329vb4n0QS/9NI4n8aSfxLdnZ2ANjZ2QFgZ2cHgJtvvpnlcsnLvdzL8UD33XffrQBnz5699b777rsV4B/+4R9+B+C+++679ezZs7fed999t3LVVVddddVVV131vwd60IMexFVXXXXVVVddddX/NNdcc82Dz5w58+AXe7EXey2AF3/xF3/tM2fOPPiaa655MA/wl3/5lyyXSwBuv/12AG6//XaemyT+p5HE/ySS+J9GEv+VdnZ2ANjZ2WFnZ4ednR1msxkv+7Ivy/3uu+++WwHOnj1763333XfrP/zDP/zOfffdd+vZs2dvve+++27lqquuuuqqq6666n8W9KAHPYirrrrqqquuuuqq/y7XXHPNg8+cOfPgF3uxF3uta6655sHXXHPNg1/sxV7stXmmv/zLv2S5XLK3t8elS5e4/fbbeWEk8T+JJP6nkcT/NJL4n0gSz21nZ4ednR12dnYAOH36NC/7si8LwH333XcrwD/8wz/89j/8wz/8zn333XfrP/zDP/w2V1111VVXXXXVVf990IMe9CCuuuqqq6666qqr/qtcc801D37t137t9wJ4p3d6p8/mmX7jN36D+XzO7bffzu23386/RBL/k0jifxpJ/E8kif9pJPEfYWdnh52dHXZ2djh9+jQv+7IvC8B999136z/8wz/89j/8wz/8zn333XfrP/zDP/w2V1111VVXXXXVVf810IMe9CCuuuqqq6666qqr/jNdc801D36xF3ux137Hd3zHz7rmmmse/PSnP5277rqL22+/ndtvv50XRBL/00jifxpJ/E8kif+JJPFfaWdnB4CbbrqJ06dP87Iv+7Lcd999t/7Wb/3Wd//DP/zD7/zDP/zDb3PVVVddddVVV131nwc96EEP4qqrrrrqqquuuuo/wzu+4zt+1uu8zuu89zXXXPPgX/qlX+LSpUvcfvvtPDdJ/E8jif+JJPE/jST+p5LE/0THjh3jMY95DK/8yq/Mfffdd+tv/dZvffeP/uiPfg5XXXXVVVddddVV//HQgx70IK666qqrrrrqqqv+I11zzTUP/vAP//DvuuGGG177j//4j/n7v/97ACTxP40k/ieSxP9EkvifSBL/U0nihbnpppt42Zd9WY6Ojn77Mz/zM1+Hq6666qqrrrrqqv9YlOPHj3PVVVddddVVV131H+l93ud9vmqaprf+2Z/9Wc6ePYskJPHfTRKSkIQkJPE/gSQkIQlJSOJ/AklIQhKSkMT/BJKQhCQkIYn/KSQhCUlIQhL/kr29PZ74xCdy5syZB9900038wz/8w+9w1VVXXXXVVVdd9R+H4Kqrrrrqqquuuuo/2OHh4YP5byQJSUhCEpKQxH83SUhCEpKQhCT+J5CEJCQhCUn8TyAJSUhCEpL4n0ISkpCEJCTx7/XgBz/4va+55poHc9VVV1111VVXXfUfh+Cqq6666qqrrrrqP9A111zz4MP
2024-06-27 22:20:51 -05:00
### Arguments
* `num_repetitions`: `u32` (REQUIRED)
* `transform_function`: `FunctionParam` (REQUIRED)
* `extrude_group_set`: `ExtrudeGroupSet` - A extrude group or a group of extrude groups. (REQUIRED)
```js
{
// The id of the extrusion end cap
endCapId: uuid,
// Chamfers or fillets on this extrude group.
filletOrChamfers: [{
// The engine id of the edge to fillet.
edge_id: uuid,
// The id of the engine command that called this fillet.
id: uuid,
radius: number,
type: "fillet",
} |
{
// The engine id of the edge to chamfer.
edge_id: uuid,
// The id of the engine command that called this chamfer.
id: uuid,
length: number,
tag: {
digest: [number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number],
2024-06-27 22:20:51 -05:00
end: number,
start: number,
value: string,
},
type: "chamfer",
}],
// The height of the extrude group.
height: number,
// The id of the extrude group.
id: uuid,
// The sketch group.
sketchGroup: {
// The id of the sketch group.
id: uuid,
// What the sketch is on (can be a plane or a face).
on: {
// The id of the plane.
id: uuid,
// Origin of the plane.
origin: {
x: number,
y: number,
z: number,
},
type: "plane",
// Type for a plane.
value: "XY" | "XZ" | "YZ" | "Custom",
// What should the planes X axis be?
xAxis: {
x: number,
y: number,
z: number,
},
// What should the planes Y axis be?
yAxis: {
x: number,
y: number,
z: number,
},
// The z-axis (normal).
zAxis: {
x: number,
y: number,
z: number,
},
} |
{
// The extrude group the face is on.
extrudeGroup: {
// The id of the extrusion end cap
endCapId: uuid,
// Chamfers or fillets on this extrude group.
filletOrChamfers: [{
// The engine id of the edge to fillet.
edge_id: uuid,
// The id of the engine command that called this fillet.
id: uuid,
radius: number,
type: "fillet",
} |
{
// The engine id of the edge to chamfer.
edge_id: uuid,
// The id of the engine command that called this chamfer.
id: uuid,
length: number,
tag: {
digest: [number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number],
2024-06-27 22:20:51 -05:00
end: number,
start: number,
value: string,
},
type: "chamfer",
}],
// The height of the extrude group.
height: number,
// The id of the extrude group.
id: uuid,
// The sketch group.
sketchGroup: SketchGroup,
// The id of the extrusion start cap
startCapId: uuid,
// The extrude surfaces.
value: [{
// The face id for the extrude plane.
faceId: uuid,
// The id of the geometry.
id: uuid,
// The source range.
sourceRange: [number, number],
// The tag.
tag: {
digest: [number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number],
2024-06-27 22:20:51 -05:00
end: number,
start: number,
value: string,
},
type: "extrudePlane",
} |
{
// The face id for the extrude plane.
faceId: uuid,
// The id of the geometry.
id: uuid,
// The source range.
sourceRange: [number, number],
// The tag.
tag: {
digest: [number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number],
2024-06-27 22:20:51 -05:00
end: number,
start: number,
value: string,
},
type: "extrudeArc",
}],
},
// The id of the face.
id: uuid,
type: "face",
// The tag of the face.
value: string,
// What should the faces X axis be?
xAxis: {
x: number,
y: number,
z: number,
},
// What should the faces Y axis be?
yAxis: {
x: number,
y: number,
z: number,
},
// The z-axis (normal).
zAxis: {
x: number,
y: number,
z: number,
},
},
// The starting path.
start: {
// The from point.
from: [number, number],
// The tag of the path.
tag: {
digest: [number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number],
2024-06-27 22:20:51 -05:00
end: number,
start: number,
value: string,
},
// The to point.
to: [number, number],
},
// Tag identifiers that have been declared in this sketch group.
tags: {
2024-06-27 22:20:51 -05:00
},
// The paths in the sketch group.
value: [{
// The from point.
from: [number, number],
// The tag of the path.
tag: {
digest: [number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number],
2024-06-27 22:20:51 -05:00
end: number,
start: number,
value: string,
},
// The to point.
to: [number, number],
type: "ToPoint",
} |
{
// arc's direction
ccw: string,
// the arc's center
center: [number, number],
// The from point.
from: [number, number],
// The tag of the path.
tag: {
digest: [number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number],
2024-06-27 22:20:51 -05:00
end: number,
start: number,
value: string,
},
// The to point.
to: [number, number],
type: "TangentialArcTo",
} |
{
// The from point.
from: [number, number],
// The tag of the path.
tag: {
digest: [number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number],
2024-06-27 22:20:51 -05:00
end: number,
start: number,
value: string,
},
// The to point.
to: [number, number],
type: "TangentialArc",
} |
{
// The from point.
from: [number, number],
// The tag of the path.
tag: {
digest: [number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number],
2024-06-27 22:20:51 -05:00
end: number,
start: number,
value: string,
},
// The to point.
to: [number, number],
type: "Horizontal",
// The x coordinate.
x: number,
} |
{
// The from point.
from: [number, number],
// The tag of the path.
tag: {
digest: [number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number],
2024-06-27 22:20:51 -05:00
end: number,
start: number,
value: string,
},
// The to point.
to: [number, number],
type: "AngledLineTo",
// The x coordinate.
x: number,
// The y coordinate.
y: number,
} |
{
// The from point.
from: [number, number],
// The tag of the path.
tag: {
digest: [number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number],
2024-06-27 22:20:51 -05:00
end: number,
start: number,
value: string,
},
// The to point.
to: [number, number],
type: "Base",
}],
},
// The id of the extrusion start cap
startCapId: uuid,
type: "extrudeGroup",
// The extrude surfaces.
value: [{
// The face id for the extrude plane.
faceId: uuid,
// The id of the geometry.
id: uuid,
// The source range.
sourceRange: [number, number],
// The tag.
tag: {
digest: [number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number],
2024-06-27 22:20:51 -05:00
end: number,
start: number,
value: string,
},
type: "extrudePlane",
} |
{
// The face id for the extrude plane.
faceId: uuid,
// The id of the geometry.
id: uuid,
// The source range.
sourceRange: [number, number],
// The tag.
tag: {
digest: [number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number],
2024-06-27 22:20:51 -05:00
end: number,
start: number,
value: string,
},
type: "extrudeArc",
}],
} |
{
type: "extrudeGroups",
}
```
### Returns
`[ExtrudeGroup]`