brepjs API Reference
    Preparing search index...

    Interface EdgeFinderFn

    interface EdgeFinderFn {
        _filters: readonly Predicate<Edge>[];
        _topoKind: TopoKind;
        and: (other: ShapeFinder<Edge>) => ShapeFinder<Edge>;
        atDistance: (distance: number, point?: Vec3) => EdgeFinderFn;
        either: (
            fns: ((f: ShapeFinder<Edge>) => ShapeFinder<Edge>)[],
        ) => ShapeFinder<Edge>;
        findAll: (shape: AnyShape<Dimension>) => Edge[];
        findUnique: (shape: AnyShape<Dimension>) => Result<Edge>;
        inDirection: (dir?: DirectionInput, angle?: number) => EdgeFinderFn;
        inList: (elements: Edge[]) => ShapeFinder<Edge>;
        negate: () => ShapeFinder<Edge>;
        not: (
            builderFn: (f: ShapeFinder<Edge>) => ShapeFinder<Edge>,
        ) => ShapeFinder<Edge>;
        ofCurveType: (curveType: CurveType) => EdgeFinderFn;
        ofLength: (length: number, tolerance?: number) => EdgeFinderFn;
        or: (other: ShapeFinder<Edge>) => ShapeFinder<Edge>;
        parallelTo: (dir?: DirectionInput) => EdgeFinderFn;
        shouldKeep: (element: Edge) => boolean;
        when: (predicate: Predicate<Edge>) => ShapeFinder<Edge>;
    }

    Hierarchy (View Summary)

    Index

    Properties

    _filters _topoKind and atDistance either findAll findUnique inDirection inList negate not ofCurveType ofLength or parallelTo shouldKeep when

    Properties

    Readonly_filters

    _filters: readonly Predicate<Edge>[]

    Readonly_topoKind

    _topoKind: TopoKind
    and: (other: ShapeFinder<Edge>) => ShapeFinder<Edge>

    Intersect: element must match both this finder AND other.

    atDistance: (distance: number, point?: Vec3) => EdgeFinderFn
    either: (
        fns: ((f: ShapeFinder<Edge>) => ShapeFinder<Edge>)[],
    ) => ShapeFinder<Edge>

    Combine filters with OR. Returns new finder.

    findAll: (shape: AnyShape<Dimension>) => Edge[]

    Find all matching elements from a shape.

    findUnique: (shape: AnyShape<Dimension>) => Result<Edge>

    Find exactly one matching element. Returns error if 0 or more than 1 match.

    inDirection: (dir?: DirectionInput, angle?: number) => EdgeFinderFn
    inList: (elements: Edge[]) => ShapeFinder<Edge>

    Filter to elements in a list. Returns new finder.

    negate: () => ShapeFinder<Edge>

    Negate: invert all filters on this finder.

    not: (
        builderFn: (f: ShapeFinder<Edge>) => ShapeFinder<Edge>,
    ) => ShapeFinder<Edge>

    Invert a filter. Returns new finder.

    ofCurveType: (curveType: CurveType) => EdgeFinderFn
    ofLength: (length: number, tolerance?: number) => EdgeFinderFn
    or: (other: ShapeFinder<Edge>) => ShapeFinder<Edge>

    Union: element must match this finder OR other.

    parallelTo: (dir?: DirectionInput) => EdgeFinderFn
    shouldKeep: (element: Edge) => boolean

    Check if an element passes all filters.

    when: (predicate: Predicate<Edge>) => ShapeFinder<Edge>

    Add a custom predicate filter. Returns new finder.

    Settings

    Member Visibility

    On This Page

    Properties