Offset
Extends ExtrudableGeometry
Inherited from Geometry
guide()
guide(): this
Marks this sketch geometry as construction geometry. Guide geometries are excluded from the final sketch output (e.g., extrude, revolve) unless explicitly included.
edge()
edge(roleOrIndex: string | number, roleIndex?: number): ISelection
Uniform edge accessor. edge('body') selects this feature's edges by
role (optionally disambiguated by role index); edge(1) selects by
build-order index over the feature's real edges. Roles: solver lines and
arcs stamp body; circles and ellipses perimeter; derived-op outputs
carry provenance-specific roles (e.g. fillet arcs).
Returns: ISelection
| Parameter | Type | Description |
|---|---|---|
roleOrIndex | string | number | A role name, or a build-order edge index. |
roleIndex | number | Disambiguates roles that repeat. (optional) |
start()
start(): Vertex
Returns a lazy-evaluated vertex at the start point of this geometry element.
Returns: Vertex
end()
end(): Vertex
Returns a lazy-evaluated vertex at the end point of this geometry element.
Returns: Vertex
Inherited from SceneObject
name()
name(value: string): this
Sets a custom display name for this object, overriding the default type-based name.
| Parameter | Type | Description |
|---|---|---|
value | string | The display name to assign. |
Methods
close()
close(): this
Closes an open offset by joining it back to the source wire with straight cap edges at each endpoint. Has no effect when the offset is already closed.
edge()
edge(index: number): OffsetEdge
One edge of the result by index, with point accessors for references
from outside the sketch (a.geometries.o.edge(2).start() in a loft
connection). Indices walk the result: index 0 is the offset of the
first source edge in statement order (for an open offset, the offset of
the chain's first edge), the walk continues in that edge's own
direction, and the arcs an outward offset rounds corners with are
ordinary steps of it. Several separate sources offset to several wires,
numbered wire after wire in statement order; .close() appends the cap
at the walk's end, then the cap at its start. Because the indices are
positional, an edit that changes which corners are rounded — flipping
the sign, for one — shifts them, and a reference then resolves to a
different vertex, as any index-based reference does.
Returns: OffsetEdge
| Parameter | Type | Description |
|---|---|---|
index | number | The 0-based edge index along the offset walk. |