181 lines
143 KiB
Markdown
181 lines
143 KiB
Markdown
---
|
|
title: "getEdge"
|
|
excerpt: "Get an edge on a 3D solid."
|
|
layout: manual
|
|
---
|
|
|
|
Get an edge on a 3D solid.
|
|
|
|
|
|
|
|
```js
|
|
getEdge(tag: String, extrude_group: ExtrudeGroup) -> Uuid
|
|
```
|
|
|
|
### Examples
|
|
|
|
```js
|
|
const box = startSketchOn('XY')
|
|
|> startProfileAt([0, 0], %)
|
|
|> line([0, 10], %)
|
|
|> line([10, 0], %)
|
|
|> line([0, -10], %, 'revolveAxis')
|
|
|> close(%)
|
|
|> extrude(10, %)
|
|
|
|
const sketch001 = startSketchOn(box, "revolveAxis")
|
|
|> startProfileAt([5, 10], %)
|
|
|> line([0, -10], %)
|
|
|> line([2, 0], %)
|
|
|> line([0, 10], %)
|
|
|> close(%)
|
|
|> revolve({
|
|
axis: getEdge('revolveAxis', box),
|
|
angle: 90
|
|
}, %)
|
|
```
|
|
|
|
|
|
|
|
### Arguments
|
|
|
|
* `tag`: `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
|
|
|
|
`Uuid`
|
|
|
|
|
|
|