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

drapeRegion MethodStatic

Drape the region onto the mesh.

  • This method computes the portion of the input mesh that lies inside the clipper generated from sweeping the input region in the given direction.

drapeRegion(mesh: Polyface | PolyfaceVisitor, region: AnyRegion, sweepVector?: Vector3d, options?: StrokeOptions): undefined | IndexedPolyface

@returns clipped facets. No other mesh data but vertices appear in output.

Parameter Type Description
mesh Polyface | PolyfaceVisitor input mesh, untouched
region AnyRegion planar region to drape onto mesh
sweepVector Vector3d optional sweep direction for region, magnitude unused. If undefined, sweep is along the region normal.
options StrokeOptions how to stroke the region boundary

Returns - undefined | IndexedPolyface

clipped facets. No other mesh data but vertices appear in output.

Defined in

Last Updated: 13 May, 2024