201 lines
3.4 KiB
Markdown
201 lines
3.4 KiB
Markdown
![]() |
---
|
|||
|
title: "segEndX"
|
|||
|
excerpt: "Returns the segment end of x."
|
|||
|
layout: manual
|
|||
|
---
|
|||
|
|
|||
|
Returns the segment end of x.
|
|||
|
|
|||
|
|
|||
|
|
|||
|
```
|
|||
|
segEndX(segment_name: string, sketch_group: SketchGroup) -> number
|
|||
|
```
|
|||
|
|
|||
|
### Examples
|
|||
|
|
|||
|
```kcl
|
|||
|
startSketchOn("YZ")
|
|||
|
|> startProfileAt([0, 0], %)
|
|||
|
|> line({ to: [5, 0], tag: "thing" }, %)
|
|||
|
|> line([5, 5], %)
|
|||
|
|> line([segEndX("thing", %), 5], %)
|
|||
|
|> close(%)
|
|||
|
|> extrude(5, %)
|
|||
|
```
|
|||
|
|
|||
|
### Arguments
|
|||
|
|
|||
|
* `segment_name`: `string` (REQUIRED)
|
|||
|
* `sketch_group`: `SketchGroup` - A sketch group is a collection of paths. (REQUIRED)
|
|||
|
```
|
|||
|
{
|
|||
|
// 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,
|
|||
|
},
|
|||
|
}
|
|||
|
```
|
|||
|
|
|||
|
### Returns
|
|||
|
|
|||
|
`number`
|
|||
|
|
|||
|
|
|||
|
|