API Reference > geometry-core > 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
constructor(capped: boolean): RotationalSweep Protected    
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): CurveCollection | undefined 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(): Transform | undefined 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): RotationalSweep | undefined Static Create a rotational sweep.  

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    
solidPrimitiveType "rotationalSweep" = "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 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: 13 June, 2024