API Reference › core-geometry› Solid › LinearSweep

LinearSweep Class

A LinearSweep is a SolidPrimitive defined by:

  • A set of curves (any Loop, Path, or parityRegion). If the object is "capped", the curves must be planar.
  • A sweep vector

Extends

Methods

Name Description
clone(): LinearSweep Return a deep clone  
cloneSweepVector(): Vector3d return a clone of the sweep vector  
cloneTransformed(transform: Transform): LinearSweep | undefined Return a transformed clone.  
constantVSection(vFraction: number): CurveCollection Return the curves at a fraction along the sweep direction.  
dispatchToGeometryHandler(handler: GeometryHandler): any Invoke strongly typed handler.handleLinearSweep(this)  
extendRange(rangeToExtend: Range3d, transform?: Transform): void Extend rangeToExtend to include this geometry.  
getConstructiveFrame(): Transform | undefined Return a coordinate frame (right handed unit vectors)  
getCurvesRef(): CurveCollection get a reference to the swept curves  
getSweepContourRef(): SweepContour Get a reference to the SweepContour carrying the plane of the curves  
isAlmostEqual(other: GeometryQuery): boolean Test for near-equality of coordinates in other  
isSameGeometryClass(other: any): boolean Test if other is also an instance of LinearSweep  
tryTransformInPlace(transform: Transform): boolean Apply a transform to the curves and sweep vector  
create(contour: AnyCurve, direction: Vector3d, capped: boolean): LinearSweep | undefined Static Create a sweep of a starting contour.  
createZSweep(xyPoints: Readonly<WritableXAndY>[], z: number, zSweep: number, capped: boolean): LinearSweep | undefined Static Create a z-direction sweep of the polyline or polygon given as xy linestring values.  

Inherited methods

Name Inherited from Description
range(transform?: Transform, result?: Range3d): Range3d Inherited SolidPrimitive Return the range of the entire GeometryQuery tree.
tryTranslateInPlace(dx: number, dy: number = 0.0, dz: number = 0.0): boolean Inherited SolidPrimitive Try to move the geometry by dx,dy,dz.
areAlmostEqual(a: GeometryQuery, b: GeometryQuery): boolean Static Inherited SolidPrimitive Apply instance method isAlmostEqual if both are defined.

Properties

Name Type Description
isClosedVolume Accessor ReadOnly boolean    
isSkew Accessor ReadOnly boolean Return true if the solid's local z-axis is not perpendicular to its local xy-plane.  
solidPrimitiveType Readonly "linearSweep" String name for schema properties  

Inherited properties

Name Type Inherited from Description
_capped Protected Inherited boolean SolidPrimitive Flag indicating whether cap region is considered closed (i.e.
capped Accessor Inherited boolean SolidPrimitive Whether this is a capped solid.
children Accessor Inherited ReadOnly GeometryQuery[] | undefined SolidPrimitive Return GeometryQuery children for recursive queries.
* leaf classes do not need to implement.
geometryCategory Readonly Inherited "solid" SolidPrimitive String name for schema properties.

Defined in

Last Updated: 20 May, 2026