Bitbybit Docs
    Preparing search index...

    Class FilterFacesPointsDto<T> (Inputs.OCCT)

    Faces, points and which groups to keep for shapes.face.filterFacesPoints, which sorts each point as inside, on the boundary of or outside each face.

    Type Parameters

    • T
    Index

    Constructors

    • Type Parameters

      • T

      Parameters

      • Optionalshapes: T[]
      • Optionalpoints: Point3[]
      • Optionaltolerance: number
      • OptionaluseBndBox: boolean
      • OptionalgapTolerance: number
      • OptionalkeepIn: boolean
      • OptionalkeepOn: boolean
      • OptionalkeepOut: boolean
      • OptionalkeepUnknown: boolean
      • OptionalflatPointsArray: boolean

      Returns FilterFacesPointsDto<T>

    Properties

    shapes: T[]

    The faces to test the points against.

    undefined
    
    points: Point3[]

    The points to sort.

    undefined
    
    tolerance: number

    How close to a boundary a point may be to count as on it, in model units.

    1.0e-4
    

    0

    Infinity

    0.000001

    useBndBox: boolean

    When true, a point outside the face's bounding box, grown by gapTolerance, counts as outside without the exact test; a quick reject for many points far from the face.

    false
    
    gapTolerance: number

    How far beyond the bounding box a point may lie and still get the exact test when useBndBox is on, in model units.

    0.1
    

    0

    Infinity

    0.01

    keepIn: boolean

    When true, points inside a face are kept.

    true
    
    keepOn: boolean

    When true, points on the boundary of a face are kept.

    true
    
    keepOut: boolean

    When true, points outside a face are kept.

    false
    
    keepUnknown: boolean

    When true, points the kernel cannot place inside, on or outside a face are kept.

    false
    
    flatPointsArray: boolean

    When true, the kept points of all faces come back in one list; when false, one list per face in the order given.

    true