brepjs API Reference
    Preparing search index...

    Interface WireFinderFn

    interface WireFinderFn {
        _filters: readonly Predicate<Wire>[];
        _topoKind: "vertex" | "edge" | "wire" | "face";
        either: (
            fns: ((f: ShapeFinder<Wire>) => ShapeFinder<Wire>)[],
        ) => ShapeFinder<Wire>;
        findAll: (shape: AnyShape) => Wire[];
        findUnique: (shape: AnyShape) => Result<Wire>;
        inList: (elements: Wire[]) => ShapeFinder<Wire>;
        isClosed: () => WireFinderFn;
        isOpen: () => WireFinderFn;
        not: (
            builderFn: (f: ShapeFinder<Wire>) => ShapeFinder<Wire>,
        ) => ShapeFinder<Wire>;
        ofEdgeCount: (count: number) => WireFinderFn;
        shouldKeep: (element: Wire) => boolean;
        when: (predicate: Predicate<Wire>) => ShapeFinder<Wire>;
    }

    Hierarchy (View Summary)

    Index

    Properties

    _filters _topoKind either findAll findUnique inList isClosed isOpen not ofEdgeCount shouldKeep when

    Properties

    Readonly_filters

    _filters: readonly Predicate<Wire>[]

    Readonly_topoKind

    _topoKind: "vertex" | "edge" | "wire" | "face"
    either: (
        fns: ((f: ShapeFinder<Wire>) => ShapeFinder<Wire>)[],
    ) => ShapeFinder<Wire>

    Combine filters with OR. Returns new finder.

    findAll: (shape: AnyShape) => Wire[]

    Find all matching elements from a shape.

    findUnique: (shape: AnyShape) => Result<Wire>

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

    inList: (elements: Wire[]) => ShapeFinder<Wire>

    Filter to elements in a list. Returns new finder.

    isClosed: () => WireFinderFn
    isOpen: () => WireFinderFn
    not: (
        builderFn: (f: ShapeFinder<Wire>) => ShapeFinder<Wire>,
    ) => ShapeFinder<Wire>

    Invert a filter. Returns new finder.

    ofEdgeCount: (count: number) => WireFinderFn
    shouldKeep: (element: Wire) => boolean

    Check if an element passes all filters.

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

    Add a custom predicate filter. Returns new finder.

    Settings

    Member Visibility

    On This Page

    Properties