edge.md

title	edge / edges
description	Select finite edge references for topology, measurement and relations.
sourceReview	packageVersion sources 0.0.1-alpha.16 path sha256 packages/core/src/library/runtime.ts dcee3d2388a9b7b3819bb4897edd894463daa0e5b519e832a3349fac98c3bff8 path sha256 commit packages/core/src/library/topology.ts f9f0d048fe30cc80046a25123aa8101ca51e85cdb5b2e66260c6a68f43f84715 67228dd8559d584852df7bfbd47ed89f1d8003e9 path sha256 commit packages/core/src/library/topology-id.ts 49b2812aa89e5a886759166c89e32cf01a629fe888bcc57452ede2feeba7dc01 904463d8c4405f4a2b1c073ba9a5edc997732e23 path sha256 commit packages/core/src/library/spatial.ts 810c4fa69352c26c32fb04a0e7867f6327698e02f3212669f17d777784322a78 69d231fb775befdb3cd098291b4097ccd52d8966
sidebar	hidden true
head	tag content title edge / edges — Code3D TypeScript API reference

Select finite edge references for topology, measurement and relations.

Example

import {box} from '@code3d/core';

export const bodyE = box(20, 10, 14);
export const upright = bodyE.edge(2);
export const selectedEdges = bodyE.edges([2, 4]);

Complete example: topology and references.

Signature

receiver.edge(id: EdgeId): Edge;
receiver.edges(ids?: readonly EdgeId[]): readonly Edge[];

Import the functions and named types from @code3d/core.

Receivers and result

Solid, face and edge models provide edge selection. Solid, Surface and Edge references provide their contained edges. Vertex models and groups do not have aggregate edge selection; choose a geometric member where appropriate.

An Edge is a finite reference to existing geometry, not a new EdgeModel. It can be used in relations and measurement, but has no modeling operations such as scaling or placement. The example's E2 is a straight edge parallel to Y with length 10. Use its id in the input solid's fillet or chamfer selection, or the reference in axisLine.

Edge properties

Member	Meaning
kind, id	Literal edge and its EdgeId
center	A bounding-box center reference carried through transformations
start, midpoint, end	Points at curve parameters 0, 0.5 and 1
length	Actual finite arc length in model units
reverse()	A reference with the opposite direction sense
vertex(s), edge(s)	Contained topology using the original namespace
up/down/left/right/front/back	Finite directional bounds

The parameter midpoint need not be half the arc length or the bounding-box center. A closed curve's start and end may coincide. reverse() changes direction metadata without swapping these parameter point properties, changing length or changing the reference axes. See flip and reverse.

An Edge extends LineAnchor, but it may be curved. align examines its supporting curve; axisLine accepts only a straight one.

IDs and selection order

IDs belong to the original geometry's topology namespace, not to an array index or the entire application. A valid ID is a positive integer or a readonly path of at least two positive integers. [1, 4] as a plural selection requests two IDs; [[1, 4]] requests one inherited path. Display labels such as E2 or S[1,4] are not accepted as string IDs.

Omitting the plural argument returns all available elements in topology order. An explicit ID array preserves authored order and duplicates. An empty array returns []. Malformed, unknown or retired IDs throw. Selecting through a child reference also checks membership: an ID elsewhere on the body cannot be selected through an unrelated surface or edge.

Child queries retain the original namespace rather than renumbering from one. Booleans and other construction operations may prefix inherited IDs with their input position; local edits preserve surviving IDs and retire replaced ones. Use the current result's topology after an edit. See topology lineage.