2024-03-13 14:22:22 -07:00
|
|
|
|
---
|
|
|
|
|
title: "angledLineThatIntersects"
|
|
|
|
|
excerpt: "Draw an angled line that intersects with a given line."
|
|
|
|
|
layout: manual
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
Draw an angled line that intersects with a given line.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
2024-03-13 15:43:42 -07:00
|
|
|
|
```js
|
2024-03-15 17:03:42 -04:00
|
|
|
|
angledLineThatIntersects(data: AngledLineThatIntersectsData, sketch_group: SketchGroup, tag?: String) -> SketchGroup
|
2024-03-13 14:22:22 -07:00
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### Examples
|
|
|
|
|
|
2024-03-13 15:43:42 -07:00
|
|
|
|
```js
|
2024-03-13 14:22:22 -07:00
|
|
|
|
const part001 = startSketchOn('XY')
|
|
|
|
|
|> startProfileAt([0, 0], %)
|
2024-03-15 17:03:42 -04:00
|
|
|
|
|> lineTo([2, 2], %, "yo")
|
2024-03-13 14:22:22 -07:00
|
|
|
|
|> lineTo([3, 1], %)
|
|
|
|
|
|> angledLineThatIntersects({
|
|
|
|
|
angle: 180,
|
|
|
|
|
intersectTag: 'yo',
|
2024-03-15 17:03:42 -04:00
|
|
|
|
offset: 12
|
|
|
|
|
}, %, "yo2")
|
2024-03-13 14:22:22 -07:00
|
|
|
|
|> line([4, 0], %)
|
|
|
|
|
|> close(%, "yo3")
|
|
|
|
|
|> extrude(10, %)
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### Arguments
|
|
|
|
|
|
|
|
|
|
* `data`: `AngledLineThatIntersectsData` - Data for drawing an angled line that intersects with a given line. (REQUIRED)
|
2024-03-13 15:43:42 -07:00
|
|
|
|
```js
|
2024-03-13 14:22:22 -07:00
|
|
|
|
{
|
|
|
|
|
// The angle of the line.
|
|
|
|
|
angle: number,
|
|
|
|
|
// The tag of the line to intersect with.
|
|
|
|
|
intersectTag: string,
|
|
|
|
|
// The offset from the intersecting line.
|
|
|
|
|
offset: number,
|
|
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
* `sketch_group`: `SketchGroup` - A sketch group is a collection of paths. (REQUIRED)
|
2024-03-13 15:43:42 -07:00
|
|
|
|
```js
|
2024-03-13 14:22:22 -07:00
|
|
|
|
{
|
|
|
|
|
// 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 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,
|
|
|
|
|
},
|
|
|
|
|
}
|
|
|
|
|
```
|
2024-03-15 17:03:42 -04:00
|
|
|
|
* `tag`: `String` (OPTIONAL)
|
2024-03-13 14:22:22 -07:00
|
|
|
|
|
|
|
|
|
### Returns
|
|
|
|
|
|
|
|
|
|
`SketchGroup` - A sketch group is a collection of paths.
|
2024-03-13 15:43:42 -07:00
|
|
|
|
```js
|
2024-03-13 14:22:22 -07:00
|
|
|
|
{
|
|
|
|
|
// 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 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,
|
|
|
|
|
},
|
|
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|