API Reference › core-geometry› Polyface › PolyfaceClip › ClipPolyfaceUnderOverConvexPolyfaceIntoBuilders

clipPolyfaceUnderOverConvexPolyfaceIntoBuilders MethodStatic

  • Split facets of mesh "A" into parts that are
    • under mesh "B"
    • over mesh "B"
  • both meshes are represented by visitors rather than the meshes themselves
    • If the data in-hand is a mesh, call with mesh.createVisitor
  • The respective clip parts are fed to caller-supplied builders.
    • Caller may set either or both builders to toggle facet order (e.g. toggle the lower facets to make them "point down" in cut-fill application)
    • This step is commonly one-half of "cut fill".
      • A "cut fill" wrapper will call this twice with the visitor and builder roles reversed.
  • Both polyfaces are assumed convex with CCW orientation viewed from above.

clipPolyfaceUnderOverConvexPolyfaceIntoBuilders(visitorA: PolyfaceVisitor, visitorB: PolyfaceVisitor, builderAUnderB: PolyfaceBuilder, builderAOverB: PolyfaceBuilder): void

Parameter Type Description
visitorA PolyfaceVisitor iterator over polyface to be split.
visitorB PolyfaceVisitor iterator over polyface that acts as a splitter
builderAUnderB PolyfaceBuilder  
builderAOverB PolyfaceBuilder  

Returns - void

Defined in

Last Updated: 24 June, 2025