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 | |
|---|---|---|
| clone(): RuledSweep | Return a deep clone | |
| cloneContours(): CurveCollection[] | Return clones of all the contours | |
| cloneSweepContours(): SweepContour[] | Return clones of all the sweep contours | |
| cloneTransformed(transform: Transform): RuledSweep | Return a cloned transform. | |
| constantVSection(vFraction: number): undefined | CurveCollection | 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(): undefined | Transform | Return a coordinate frame (right handed unit vectors) | |
| 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): undefined | RuledSweep Static | Create a ruled sweep from an array of contours. | |
| mutatePartners(collectionA: CurveCollection, collectionB: CurveCollection, primitiveMutator: CurvePrimitiveMutator): undefined | CurveCollection 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 | 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 | Return true if this is a closed volume, as observed by | |
| solidPrimitiveType Readonly | "ruledSweep" | 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
- solid/RuledSweep.ts Line 32
Last Updated: 30 November, 2023