CurveChain Class

Shared base class for use by both open and closed paths.

  • A CurveChain contains only CurvePrimitives. No other paths, loops, or regions allowed.
  • The specific derived classes are Path and Loop.
  • CurveChain is an intermediate class. It is not instantiable on its own.
  • The related class CurveChainWithDistanceIndex is a CurvePrimitive whose API presents well-defined mappings from fraction to xyz over the entire chain, but in fact does all the calculations over multiple primitives.

@see Curve Collections learning article.

Extends

Extended by

Methods

Name Description
constructor(): CurveChain Protected Constructor  
childIndex(target: undefined | CurvePrimitive, alsoSearchProxies?: boolean): undefined | number Return the index where target is found in the array of children.  
cloneStroked(options?: StrokeOptions): CurveChain Abstract Return a structural clone, with CurvePrimitive objects stroked.  
cyclicCurvePrimitive(index: number, cyclic: boolean = true): undefined | CurvePrimitive Return the curve primitive at the given index, optionally using modulo to map index to the cyclic indexing.  
extendRange(range: Range3d, transform?: Transform): void Invoke curve.extendRange(range, transform) for each child  
getChild(i: number): undefined | CurvePrimitive Return a child by index  
getPackedStrokes(options?: StrokeOptions): undefined | GrowableXYZArray Stroke the chain into a simple xyz array.  
primitiveIndexAndFractionToCurveLocationDetailPointAndDerivative(index: number, fraction: number, cyclic: boolean = false, result?: CurveLocationDetail): undefined | CurveLocationDetail Evaluate an indexed curve at a fraction.  
reverseChildrenInPlace(): void Reverse each child curve (in place)  
tryAddChild(child: undefined | AnyCurve): boolean Add a child curve.  

Inherited methods

Name Inherited from Description
announceToCurveProcessor(processor: RecursiveCurveProcessor): void Abstract CurveCollection Support method for ICurvePrimitive ...
checkForNonLinearPrimitives(): boolean CurveCollection Return true if the curve collection has any primitives other than LineSegment3d and LineString3d
clone(): CurveCollection CurveCollection Return a deep copy.
cloneEmptyPeer(): CurveCollection Abstract CurveCollection Clone an empty collection.
cloneTransformed(transform: Transform): undefined | CurveCollection CurveCollection Create a deep copy of transformed curves.
cloneWithExpandedLineStrings(): CurveCollection CurveCollection Create a deep copy with all linestrings broken down into multiple LineSegment3d.
closestPoint(spacePoint: Point3d): undefined | CurveLocationDetail CurveCollection Return the closest point on the contained curves
collectCurvePrimitives(collectorArray?: CurvePrimitive[], smallestPossiblePrimitives: boolean = false, explodeLineStrings: boolean = false): CurvePrimitive[] CurveCollection Return an array containing all CurvePrimitives in the instance.
dgnBoundaryType(): number Abstract CurveCollection Return the boundary type of a corresponding MicroStation CurveVector.
dispatchToGeometryHandler(handler: GeometryHandler): any Abstract CurveCollection * "double dispatch" call pattern.
isAlmostEqual(other: GeometryQuery): boolean CurveCollection Test for exact structure and nearly identical geometry.
isAnyRegion(): this is AnyRegion CurveCollection Type guard for AnyRegion
isLoop(): this is Loop CurveCollection Type guard for Loop
isPath(): this is Path CurveCollection Type guard for Path
isSameGeometryClass(other: GeometryQuery): boolean Abstract CurveCollection Test if (other instanceof this.Type).
maxGap(): number CurveCollection Return the max gap between adjacent primitives in Path and Loop collections.
projectedParameterRange(ray: Vector3d | Ray3d, lowHigh?: Range1d): undefined | Range1d CurveCollection Project instance geometry (via dispatch) onto the given ray, and return the extreme fractional parameters
range(transform?: Transform, result?: Range3d): Range3d CurveCollection Return the range of the entire GeometryQuery tree
sumLengths(): number CurveCollection Return the sum of the lengths of all contained curves.
tryTransformInPlace(transform: Transform): boolean CurveCollection Apply transform recursively to children
tryTranslateInPlace(dx: number, dy: number = 0.0, dz: number = 0.0): boolean CurveCollection Try to move the geometry by dx,dy,dz
areAlmostEqual(a: undefined | GeometryQuery, b: undefined | GeometryQuery): boolean Static CurveCollection Apply instance method CurveCollection.isAlmostEqual if both are defined.
createCurveLocationDetailOnAnyCurvePrimitive(source: undefined | GeometryQuery, fraction: number = 0.5): undefined | CurveLocationDetail Static CurveCollection Find any CurvePrimitive in the source and evaluate it at the given fraction.

Properties

Name Type Description
_curves Protected CurvePrimitive[] The curve primitives in the chain.  
children Accessor ReadOnly CurvePrimitive[] Return the array of CurvePrimitive  

Inherited properties

Name Type Inherited from Description
curveCollectionType AbstractReadonly CurveCollectionType CurveCollection Type discriminator.
geometryCategory Readonly "curveCollection" CurveCollection String name for schema properties
isAnyRegionType Accessor ReadOnly boolean CurveCollection Return true for planar region types:
* Loop
* ParityRegion
* UnionRegion
isClosedPath Accessor ReadOnly boolean CurveCollection Return true for a single-loop planar region type, i.e. Loop.
* This is NOT a test for physical closure of a Path.
isInner boolean CurveCollection Flag for inner loop status.
isOpenPath Accessor ReadOnly boolean CurveCollection Return true for a Path, i.e. a chain of curves joined head-to-tail

Defined in

Last Updated: 15 March, 2024