API Reference > core-geometry > Solid > RotationalSweep

RotationalSweep Class

A LinearSweep is

  • A planar contour (any Loop, Path, or parityRegion)
  • An axis vector.
    • The planar contour is expected to be in the plane of the axis vector
    • The contour may have points and/or lines that are on the axis, but otherwise is entirely on one side of the axis.
  • A sweep angle.

Extends

Methods

Name Description
clone(): RotationalSweep return a deep clone  
cloneAxisRay(): Ray3d return clone of (not reference to) the axis vector.  
cloneTransformed(transform: Transform): RotationalSweep return a cloned transform.  
constantVSection(vFraction: number): undefined | CurveCollection Return the curves of a constant-v section of the solid.  
dispatchToGeometryHandler(handler: GeometryHandler): any Dispatch to strongly typed handler handler.handleRotationalSweep(this)  
extendRange(range: Range3d, transform?: Transform): void Extend range using sampled points on the surface.  
getConstructiveFrame(): undefined | Transform Return a coordinate frame (right handed unit vectors)  
getCurves(): CurveCollection Return (REFERENCE TO) the swept curves.  
getFractionalRotationTransform(vFraction: number, result?: Transform): Transform Return a transform that rotates around the rotational axis by a fraction of the total sweep.  
getSweep(): Angle Return the sweep angle.  
getSweepContourRef(): SweepContour Return (REFERENCE TO) the swept curves with containing plane markup.  
isAlmostEqual(other: GeometryQuery): boolean Test for same axis, capping, and swept geometry.  
isSameGeometryClass(other: any): boolean Test if other is a RotationalSweep  
tryTransformInPlace(transform: Transform): boolean Transform the contour and axis  
create(contour: CurveCollection, axis: Ray3d, sweepAngle: Angle, capped: boolean): undefined | RotationalSweep Static Create a rotational sweep.  

Inherited methods

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

Properties

Name Type Description
isClosedVolume Accessor ReadOnly boolean    
solidPrimitiveType Readonly "rotationalSweep" 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 undefined | GeometryQuery[] SolidPrimitive return GeometryQuery children for recursive queries.

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

Defined in

Last Updated: 30 November, 2023