221f037eaa
* generate docs Signed-off-by: Jess Frazelle <github@jessfraz.com> * A snapshot a day keeps the bugs away! 📷🐛 (OS: ubuntu) --------- Signed-off-by: Jess Frazelle <github@jessfraz.com> Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
445 lines
935 KiB
Markdown
445 lines
935 KiB
Markdown
---
|
||
title: "revolve"
|
||
excerpt: "Revolve a sketch around an axis."
|
||
layout: manual
|
||
---
|
||
|
||
Revolve a sketch around an axis.
|
||
|
||
|
||
|
||
```js
|
||
revolve(data: RevolveData, sketch_group: SketchGroup) -> ExtrudeGroup
|
||
```
|
||
|
||
### Examples
|
||
|
||
```js
|
||
const part001 = startSketchOn('XY')
|
||
|> startProfileAt([4, 12], %)
|
||
|> line([2, 0], %)
|
||
|> line([0, -6], %)
|
||
|> line([4, -6], %)
|
||
|> line([0, -6], %)
|
||
|> line([-3.75, -4.5], %)
|
||
|> line([0, -5.5], %)
|
||
|> line([-2, 0], %)
|
||
|> close(%)
|
||
|> revolve({ axis: 'y' }, %) // default angle is 360
|
||
```
|
||
|
||
|
||
|
||
```js
|
||
// A donut shape.
|
||
const sketch001 = startSketchOn('XY')
|
||
|> circle([15, 0], 5, %)
|
||
|> revolve({ angle: 360, axis: 'y' }, %)
|
||
```
|
||
|
||
|
||
|
||
```js
|
||
const part001 = startSketchOn('XY')
|
||
|> startProfileAt([4, 12], %)
|
||
|> line([2, 0], %)
|
||
|> line([0, -6], %)
|
||
|> line([4, -6], %)
|
||
|> line([0, -6], %)
|
||
|> line([-3.75, -4.5], %)
|
||
|> line([0, -5.5], %)
|
||
|> line([-2, 0], %)
|
||
|> close(%)
|
||
|> revolve({ axis: 'y', angle: 180 }, %)
|
||
```
|
||
|
||
|
||
|
||
```js
|
||
const part001 = startSketchOn('XY')
|
||
|> startProfileAt([4, 12], %)
|
||
|> line([2, 0], %)
|
||
|> line([0, -6], %)
|
||
|> line([4, -6], %)
|
||
|> line([0, -6], %)
|
||
|> line([-3.75, -4.5], %)
|
||
|> line([0, -5.5], %)
|
||
|> line([-2, 0], %)
|
||
|> close(%)
|
||
|> revolve({ axis: 'y', angle: 180 }, %)
|
||
const part002 = startSketchOn(part001, 'end')
|
||
|> startProfileAt([4.5, -5], %)
|
||
|> line([0, 5], %)
|
||
|> line([5, 0], %)
|
||
|> line([0, -5], %)
|
||
|> close(%)
|
||
|> extrude(5, %)
|
||
```
|
||
|
||
|
||
|
||
```js
|
||
const box = startSketchOn('XY')
|
||
|> startProfileAt([0, 0], %)
|
||
|> line([0, 20], %)
|
||
|> line([20, 0], %)
|
||
|> line([0, -20], %)
|
||
|> close(%)
|
||
|> extrude(20, %)
|
||
|
||
const sketch001 = startSketchOn(box, "END")
|
||
|> circle([10, 10], 4, %)
|
||
|> revolve({ angle: -90, axis: 'y' }, %)
|
||
```
|
||
|
||
|
||
|
||
```js
|
||
const box = startSketchOn('XY')
|
||
|> startProfileAt([0, 0], %)
|
||
|> line([0, 20], %)
|
||
|> line([20, 0], %)
|
||
|> line([0, -20], %, 'revolveAxis')
|
||
|> close(%)
|
||
|> extrude(20, %)
|
||
|
||
const sketch001 = startSketchOn(box, "END")
|
||
|> circle([10, 10], 4, %)
|
||
|> revolve({
|
||
angle: 90,
|
||
axis: getOppositeEdge('revolveAxis', box)
|
||
}, %)
|
||
```
|
||
|
||
|
||
|
||
### Arguments
|
||
|
||
* `data`: `RevolveData` - Data for revolution surfaces. (REQUIRED)
|
||
```js
|
||
{
|
||
// Angle to revolve (in degrees). Default is 360.
|
||
angle: number,
|
||
// Axis of revolution.
|
||
axis: "x" |
|
||
"y" |
|
||
"z" |
|
||
"-X" |
|
||
"-Y" |
|
||
"-Z" |
|
||
{
|
||
custom: {
|
||
// The axis.
|
||
axis: [number, number, number],
|
||
// The origin.
|
||
origin: [number, number, number],
|
||
},
|
||
} |
|
||
uuid |
|
||
string,
|
||
}
|
||
```
|
||
* `sketch_group`: `SketchGroup` - A sketch group is a collection of paths. (REQUIRED)
|
||
```js
|
||
{
|
||
// The plane id or face id of the sketch group.
|
||
entityId: uuid,
|
||
// 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 plane’s X axis be?
|
||
xAxis: {
|
||
x: number,
|
||
y: number,
|
||
z: number,
|
||
},
|
||
// What should the plane’s Y axis be?
|
||
yAxis: {
|
||
x: number,
|
||
y: number,
|
||
z: number,
|
||
},
|
||
// The z-axis (normal).
|
||
zAxis: {
|
||
x: number,
|
||
y: number,
|
||
z: number,
|
||
},
|
||
} |
|
||
{
|
||
// the face id the sketch is on
|
||
faceId: uuid,
|
||
// The id of the face.
|
||
id: uuid,
|
||
// The original sketch group id of the object we are sketching on.
|
||
sketchGroupId: uuid,
|
||
type: "face",
|
||
// The tag of the face.
|
||
value: string,
|
||
// What should the face’s X axis be?
|
||
xAxis: {
|
||
x: number,
|
||
y: number,
|
||
z: number,
|
||
},
|
||
// What should the face’s Y axis be?
|
||
yAxis: {
|
||
x: number,
|
||
y: number,
|
||
z: number,
|
||
},
|
||
// The z-axis (normal).
|
||
zAxis: {
|
||
x: number,
|
||
y: number,
|
||
z: number,
|
||
},
|
||
},
|
||
// The position of the sketch group.
|
||
position: [number, number, number],
|
||
// The rotation of the sketch group base plane.
|
||
rotation: [number, number, number, number],
|
||
// The starting path.
|
||
start: {
|
||
// The from point.
|
||
from: [number, number],
|
||
// The name of the path.
|
||
name: string,
|
||
// The to point.
|
||
to: [number, number],
|
||
},
|
||
// The paths in the sketch group.
|
||
value: [{
|
||
// 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 x-axis of the sketch group base plane in the 3D space
|
||
xAxis: {
|
||
x: number,
|
||
y: number,
|
||
z: number,
|
||
},
|
||
// The y-axis of the sketch group base plane in the 3D space
|
||
yAxis: {
|
||
x: number,
|
||
y: number,
|
||
z: number,
|
||
},
|
||
// The z-axis of the sketch group base plane in the 3D space
|
||
zAxis: {
|
||
x: number,
|
||
y: number,
|
||
z: number,
|
||
},
|
||
}
|
||
```
|
||
|
||
### Returns
|
||
|
||
`ExtrudeGroup` - An extrude group is a collection of extrude surfaces.
|
||
```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,
|
||
},
|
||
}
|
||
```
|
||
|
||
|
||
|