Creates a new edge filter builder for selecting edges by geometric properties.
import { edge } from 'fluidcad/filters';
Methods
.atIndex()
.atIndex(index: number): this
Selects the edge at the given index.
| Parameter | Type | Description |
|---|
index | number | Zero-based edge index. |
.notAtIndex()
.notAtIndex(index: number): this
Excludes the edge at the given index.
| Parameter | Type | Description |
|---|
index | number | Zero-based edge index to exclude. |
.onPlane()
.onPlane(plane: PlaneLike, offset?: number, bothDirections?: boolean): this
Selects edges that lie on the given plane.
| Parameter | Type | Description |
|---|
plane | PlaneLike | The reference plane. |
offset | number | Optional distance to offset the plane before matching. (optional) |
bothDirections | boolean | When true, also matches the plane offset in the opposite direction. (optional) |
.notOnPlane()
.notOnPlane(plane: PlaneLike, offset?: number, bothDirections?: boolean): this
Excludes edges that lie on the given plane.
| Parameter | Type | Description |
|---|
plane | PlaneLike | The reference plane. |
offset | number | Optional distance to offset the plane before matching. (optional) |
bothDirections | boolean | When true, also excludes the plane offset in the opposite direction. (optional) |
.parallelTo()
.parallelTo(plane: PlaneLike): this
Selects edges that are parallel to the given plane.
| Parameter | Type | Description |
|---|
plane | PlaneLike | The reference plane. |
.notParallelTo()
.notParallelTo(plane: PlaneLike): this
Excludes edges that are parallel to the given plane.
| Parameter | Type | Description |
|---|
plane | PlaneLike | The reference plane. |
.verticalTo()
.verticalTo(plane: PlaneLike): this
Selects edges that are perpendicular (vertical) to the given plane.
| Parameter | Type | Description |
|---|
plane | PlaneLike | The reference plane. |
.notVerticalTo()
.notVerticalTo(plane: PlaneLike): this
Excludes edges that are perpendicular (vertical) to the given plane.
| Parameter | Type | Description |
|---|
plane | PlaneLike | The reference plane. |
.circle()
.circle(diameter?: number): this
Selects circular edges, optionally matching a specific diameter.
| Parameter | Type | Description |
|---|
diameter | number | Optional diameter to match. (optional) |
.notCircle()
.notCircle(diameter?: number): this
Excludes circular edges, optionally matching a specific diameter.
| Parameter | Type | Description |
|---|
diameter | number | Optional diameter to exclude. (optional) |
.arc()
.arc(radius?: number): this
Selects arc edges, optionally matching a specific radius.
| Parameter | Type | Description |
|---|
radius | number | Optional radius to match. (optional) |
.notArc()
.notArc(radius?: number): this
Excludes arc edges, optionally matching a specific radius.
| Parameter | Type | Description |
|---|
radius | number | Optional radius to exclude. (optional) |
.line()
.line(length?: number): this
Selects straight-line edges, optionally matching a specific length.
| Parameter | Type | Description |
|---|
length | number | Optional length to match. (optional) |
.notLine()
.notLine(length?: number): this
Excludes straight-line edges, optionally matching a specific length.
| Parameter | Type | Description |
|---|
length | number | Optional length to exclude. (optional) |
.belongsToFace()
.belongsToFace(...args: any[][]): this
| Parameter | Type | Description |
|---|
...args | any[] | (optional) |
.notBelongsToFace()
.notBelongsToFace(...args: any[][]): this
| Parameter | Type | Description |
|---|
...args | any[] | (optional) |