API Reference › core-geometry› Polyface › ClippedPolyfaceBuilders

ClippedPolyfaceBuilders Class

A pair of PolyfaceBuilder objects, for use by clippers that emit inside and outside parts.

  • There are nominally 4 builders:
    • builderA collects simple "inside" clip.
    • builderB collects simple "outside" clip.
    • builderA1 collects "side" clip for inside.
    • builderB1 collets "side" clip for outside.
  • static ClippedPolyfaceBuilders.create(keepInside, keepOutside) initializes builderA and builderB (each optionally to undefined), with undefined builderA1 and builderB1
  • builders.enableSideBuilders() makes builderA1 and builderB1 match builderA and builderB.
  • construction methods aim their facets at appropriate builders if defined.

Methods

Name Description
claimPolyface(selector: "0" | "1", fixup: boolean, tolerance: numberGeometry.smallMetricDistance): undefined | IndexedPolyface    
create(keepInside: booleantrue, keepOutside: booleanfalse, buildSideFaces: booleanfalse): ClippedPolyfaceBuilders Static Simple create with default options on builder.  

Properties

Name Type Description
buildClosureFaces boolean | undefined request to construct cut faces  
builderA PolyfaceBuilder | undefined An available builder.  
builderB PolyfaceBuilder | undefined An available builder.  

Defined in

Last Updated: 13 May, 2024