LinearSweep Class

A LinearSweep is a SolidPrimitive defined by

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



Name Description
constructor(capped: boolean): LinearSweep Protected    
clone(): LinearSweep Return a deep clone  
cloneSweepVector(): Vector3d return a clone of the sweep vector  
cloneTransformed(transform: Transform): LinearSweep Return a transformed clone  
constantVSection(vFraction: number): CurveCollection | undefined Return the curves at a fraction along the sweep direction.  
dispatchToGeometryHandler(handler: GeometryHandler): any Invoke strongly typed handler.handleLinearSweep(this)  
extendRange(rangeToExtend: Range3d.createNull, 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: CurveCollection, direction: Vector3d, capped: boolean): LinearSweep | undefined Static Create a sweep of a starting contour.  
createZSweep(xyPoints: XAndY[], 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.createNull): Range3d.createNull GeometryQuery return the range of the entire (tree) GeometryQuery
tryTranslateInPlace(dx: number, dy: number = 0, dz: number = 0): boolean GeometryQuery try to move the geometry by dx,dy,dz
areAlmostEqual(a: GeometryQuery | undefined, b: GeometryQuery | undefined): boolean Static GeometryQuery apply instance method isAlmostEqual if both are defined.


Name Type Description
isClosedVolume Accessor ReadOnly boolean    
solidPrimitiveType "linearSweep" = "linearSweep" String name for schema properties  

Inherited properties

Name Type Inherited from Description
_capped Protected boolean SolidPrimitive flag indicating whether cap region is considered closed (i.e.
capped Accessor boolean SolidPrimitive Whether this is a capped solid
children Accessor ReadOnly GeometryQuery[] | undefined GeometryQuery return GeometryQuery children for recursive queries.

* leaf classes do not need to implement.
geometryCategory "solid" = "solid" SolidPrimitive String name for schema properties

Defined in

Last Updated: 06 October, 2021