API Reference > geometry-core > Curve > UnionRegion UnionRegion Class A UnionRegion is a collection of other planar region types -- Loop and ParityRegion. The composite is the union of the contained regions. A point is "in" the composite if it is "in" one or more of the contained regions. see Curve Collections learning article. Extends CurveCollection Methods Name Description constructor(): UnionRegion Constructor -- initialize with no children announceToCurveProcessor(processor: RecursiveCurveProcessor, indexInParent: number = -1): void dispatch to more strongly typed processor.announceUnionRegion(this, indexInParent) cloneEmptyPeer(): UnionRegion Return new empty UnionRegion cloneStroked(options?: StrokeOptions): UnionRegion Return structural clone with stroked primitives. dgnBoundaryType(): number Return the boundary type (5) of a corresponding MicroStation CurveVector dispatchToGeometryHandler(handler: GeometryHandler): any Second step of double dispatch: call handler.handleUnionRegion(this) getChild(i: number): undefined | Loop | ParityRegion Return a child identified by index. isSameGeometryClass(other: GeometryQuery): boolean test if other is a UnionRegion tryAddChild(child: AnyCurve): boolean add a child. create(...data: Loop | ParityRegion[]): UnionRegion Static Create a UnionRegion with given region children Inherited methods Name Inherited from Description checkForNonLinearPrimitives(): boolean CurveCollection return true if the curve collection has any primitives other than LineSegment3d and LineString3d clone(): undefined | CurveCollection CurveCollection Return a deep copy. cloneTransformed(transform: Transform): undefined | CurveCollection CurveCollection Create a deep copy of transformed curves. cloneWithExpandedLineStrings(): undefined | CurveCollection CurveCollection Create a deep copy with all linestrings expanded to 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 only the curve primitives. extendRange(rangeToExtend: Range3d, transform?: Transform): void CurveCollection Extend (increase) rangeToExtend as needed to include these curves (optionally transformed) isAlmostEqual(other: GeometryQuery): boolean CurveCollection test for exact structure and nearly identical geometry. maxGap(): number CurveCollection return the max gap between adjacent primitives in Path and Loop collections. range(transform?: Transform, result?: Range3d): Range3d CurveCollection return the range of the entire (tree) GeometryQuery 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 isAlmostEqual if both are defined. createCurveLocationDetailOnAnyCurvePrimitive(source: undefined | GeometryQuery, fraction: number = 0.5): undefined | CurveLocationDetail Static CurveCollection * Find any curve primitive in the source. Properties Name Type Description _children Protected Loop | ParityRegion[] collection of Loop and ParityRegion children. children Accessor ReadOnly Loop | ParityRegion[] Return the array of regions curveCollectionType Readonly "unionRegion" String name for schema properties Inherited properties Name Type Inherited from Description 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 curve/UnionRegion.ts Line 25 Last Updated: 11 June, 2024