594e888c12
* Rename cargo-criterion to cargo-bench * Use iai not criterion in CI We want to benchmark the KCL parser and tokenizer to make sure we don't accidentally slow them down. Generally Rust projects use Criterion to benchmark code. Criterion runs your functions a few thousand times to get reliable wall-clock measurements. This is good for locally benchmarking but bad for benchmarking in CI. Why? Because in CI, you're running a container on some shared VM, so wall-clock time might have a lot of interference from noisy neighbours. Also, your benchmarks take a long time to run and eat up paid CI minutes. A better approach for benchmarking in CI is to just count the number of CPU instructions executed. This correlates with wall-clock time, but it only needs to run the function once, so it takes much less time. It also isn't changed by any noisy neighbours running on the same VM or hardware. This PR adds a new benchmark suite which counts instructions using `iai`, from the creator of criterion. He says iai and criterion complement each other nicely. We can run criterion locally and run iai in CI. * Update image in markdown docs
178 lines
131 KiB
Markdown
178 lines
131 KiB
Markdown
---
|
|
title: "getExtrudeWallTransform"
|
|
excerpt: "Returns the extrude wall transform."
|
|
layout: manual
|
|
---
|
|
|
|
Returns the extrude wall transform.
|
|
|
|
|
|
|
|
```js
|
|
getExtrudeWallTransform(surface_name: string, extrude_group: ExtrudeGroup) -> ExtrudeTransform
|
|
```
|
|
|
|
### Examples
|
|
|
|
```js
|
|
const box = startSketchOn('XY')
|
|
|> startProfileAt([0, 0], %)
|
|
|> line([0, 10], %)
|
|
|> line([10, 0], %)
|
|
|> line([0, -10], %, "surface")
|
|
|> close(%)
|
|
|> extrude(5, %)
|
|
|
|
const transform = getExtrudeWallTransform('surface', box)
|
|
```
|
|
|
|
|
|
|
|
### Arguments
|
|
|
|
* `surface_name`: `string` (REQUIRED)
|
|
* `extrude_group`: `ExtrudeGroup` - An extrude group is a collection of extrude surfaces. (REQUIRED)
|
|
```js
|
|
{
|
|
// The id of the extrusion end cap
|
|
endCapId: uuid,
|
|
// The height of the extrude group.
|
|
height: number,
|
|
// The id of the extrude group.
|
|
id: uuid,
|
|
// The position of the extrude group.
|
|
position: [number, number, number],
|
|
// The rotation of the extrude group.
|
|
rotation: [number, number, number, number],
|
|
// The sketch group paths.
|
|
sketchGroupValues: [{
|
|
// The from point.
|
|
from: [number, number],
|
|
// The name of the path.
|
|
name: 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 name of the path.
|
|
name: string,
|
|
// The to point.
|
|
to: [number, number],
|
|
type: "TangentialArcTo",
|
|
} |
|
|
{
|
|
// The from point.
|
|
from: [number, number],
|
|
// The name of the path.
|
|
name: string,
|
|
// The to point.
|
|
to: [number, number],
|
|
type: "TangentialArc",
|
|
} |
|
|
{
|
|
// The from point.
|
|
from: [number, number],
|
|
// The name of the path.
|
|
name: string,
|
|
// The to point.
|
|
to: [number, number],
|
|
type: "Horizontal",
|
|
// The x coordinate.
|
|
x: number,
|
|
} |
|
|
{
|
|
// The from point.
|
|
from: [number, number],
|
|
// The name of the path.
|
|
name: 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 name of the path.
|
|
name: string,
|
|
// The to point.
|
|
to: [number, number],
|
|
type: "Base",
|
|
}],
|
|
// 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 name.
|
|
name: string,
|
|
// The position.
|
|
position: [number, number, number],
|
|
// The rotation.
|
|
rotation: [number, number, number, number],
|
|
// The source range.
|
|
sourceRange: [number, number],
|
|
type: "extrudePlane",
|
|
} |
|
|
{
|
|
// The face id for the extrude plane.
|
|
faceId: uuid,
|
|
// The id of the geometry.
|
|
id: uuid,
|
|
// The name.
|
|
name: string,
|
|
// The position.
|
|
position: [number, number, number],
|
|
// The rotation.
|
|
rotation: [number, number, number, number],
|
|
// The source range.
|
|
sourceRange: [number, number],
|
|
type: "extrudeArc",
|
|
}],
|
|
// The x-axis of the extrude group base plane in the 3D space
|
|
xAxis: {
|
|
x: number,
|
|
y: number,
|
|
z: number,
|
|
},
|
|
// The y-axis of the extrude group base plane in the 3D space
|
|
yAxis: {
|
|
x: number,
|
|
y: number,
|
|
z: number,
|
|
},
|
|
// The z-axis of the extrude group base plane in the 3D space
|
|
zAxis: {
|
|
x: number,
|
|
y: number,
|
|
z: number,
|
|
},
|
|
}
|
|
```
|
|
|
|
### Returns
|
|
|
|
`ExtrudeTransform`
|
|
```js
|
|
{
|
|
position: [number, number, number],
|
|
rotation: [number, number, number, number],
|
|
}
|
|
```
|
|
|
|
|
|
|