RuledSweep Class

A ruled sweep (surface) is a collection of 2 or more contours.

  • All contours must have identical number and type of geometry. (paths, loops, parity regions, lines, arcs, other curves)

Extends

Methods

Name Description
constructor(capped: boolean): RuledSweep Protected    
clone(): RuledSweep Return a deep clone  
cloneContours(): CurveCollection[] Return clones of all the contours
* See also cloneContours, which returns the contours in their local coordinate systems
 
cloneSweepContours(): SweepContour[] Return clones of all the sweep contours
* See also cloneContours, which returns the spatial contours without their local coordinate system definitions)
 
cloneTransformed(transform: Transform): RuledSweep Return a cloned transform.  
constantVSection(vFraction: number): CurveCollection | undefined Return the section curves at a fraction of the sweep  
dispatchToGeometryHandler(handler: GeometryHandler): any dispatch to strongly typed handler.handleRuledSweep(this)  
extendRange(rangeToExtend: Range3d, transform?: Transform): void Pass each contour to extendRange  
getConstructiveFrame(): Transform | undefined Return a coordinate frame (right handed unit vectors)
origin on base contour
x, y directions from base contour.
 
isAlmostEqual(other: GeometryQuery): boolean test same contour geometry and capping.  
isSameGeometryClass(other: any): boolean Test if other is an instance of a RuledSweep  
sweepContoursRef(): SweepContour[] Return a reference to the array of SweepContour.  
tryTransformInPlace(transform: Transform): boolean Transform all contours in place.  
create(contours: CurveCollection[], capped: boolean): RuledSweep | undefined Static Create a ruled sweep from an array of contours.  
mutatePartners(collectionA: CurveCollection, collectionB: CurveCollection, primitiveMutator: CurvePrimitiveMutator): CurveCollection | undefined Static Construct a CurveCollection with the same structure as collectionA and collectionB, with primitives constructed by the caller-supplied primitiveMutator function.  

Inherited methods

Name Inherited from Description
range(transform?: Transform, result?: Range3d): Range3d 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

Properties

Name Type Description
isClosedVolume Accessor ReadOnly boolean Return true if this is a closed volume, as observed by
* cap flag
identical first and last contours.
 
solidPrimitiveType "ruledSweep" = "ruledSweep"    

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 Ask if 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  

Defined in

Last Updated: 20 September, 2019