brepjs API Reference
    Preparing search index...

    Interface VertexFinderFn

    interface VertexFinderFn {
        _filters: readonly Predicate<Vertex>[];
        _topoKind: TopoKind;
        and: (other: ShapeFinder<Vertex>) => ShapeFinder<Vertex>;
        atDistance: (
            distance: number,
            point?: Vec3,
            tolerance?: number,
        ) => VertexFinderFn;
        atPosition: (point: Vec3, tolerance?: number) => VertexFinderFn;
        either: (
            fns: ((f: ShapeFinder<Vertex>) => ShapeFinder<Vertex>)[],
        ) => ShapeFinder<Vertex>;
        findAll: (shape: AnyShape<Dimension>) => Vertex[];
        findUnique: (shape: AnyShape<Dimension>) => Result<Vertex>;
        inList: (elements: Vertex[]) => ShapeFinder<Vertex>;
        nearestTo: (point: Vec3) => VertexFinderFn;
        negate: () => ShapeFinder<Vertex>;
        not: (
            builderFn: (f: ShapeFinder<Vertex>) => ShapeFinder<Vertex>,
        ) => ShapeFinder<Vertex>;
        or: (other: ShapeFinder<Vertex>) => ShapeFinder<Vertex>;
        shouldKeep: (element: Vertex) => boolean;
        when: (predicate: Predicate<Vertex>) => ShapeFinder<Vertex>;
        withinBox: (min: Vec3, max: Vec3) => VertexFinderFn;
    }

    Hierarchy (View Summary)

    Index

    Properties

    _filters _topoKind and atDistance atPosition either findAll findUnique inList nearestTo negate not or shouldKeep when withinBox

    Properties

    Readonly_filters

    _filters: readonly Predicate<Vertex>[]

    Readonly_topoKind

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

    Intersect: element must match both this finder AND other.

    atDistance: (
        distance: number,
        point?: Vec3,
        tolerance?: number,
    ) => VertexFinderFn

    Filter vertices at a given distance from a point.

    atPosition: (point: Vec3, tolerance?: number) => VertexFinderFn

    Filter vertices at an exact position (within tolerance).

    either: (
        fns: ((f: ShapeFinder<Vertex>) => ShapeFinder<Vertex>)[],
    ) => ShapeFinder<Vertex>

    Combine filters with OR. Returns new finder.

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

    Find all matching elements from a shape.

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

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

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

    Filter to elements in a list. Returns new finder.

    nearestTo: (point: Vec3) => VertexFinderFn

    Filter vertices nearest to a reference point. Returns a new finder that keeps only the closest vertex.

    negate: () => ShapeFinder<Vertex>

    Negate: invert all filters on this finder.

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

    Invert a filter. Returns new finder.

    or: (other: ShapeFinder<Vertex>) => ShapeFinder<Vertex>

    Union: element must match this finder OR other.

    shouldKeep: (element: Vertex) => boolean

    Check if an element passes all filters.

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

    Add a custom predicate filter. Returns new finder.

    withinBox: (min: Vec3, max: Vec3) => VertexFinderFn

    Filter vertices within an axis-aligned bounding box.

    Settings

    Member Visibility

    On This Page

    Properties