API Reference › core-geometry› Curve › ParityRegion

ParityRegion Class

  • A ParityRegion is a collection of Loop objects.
  • The loops collectively define a planar region.
  • A point is "in" the composite region if it is "in" an odd number of the loops.

@see Curve Collections learning article.

Extends

Methods

Name Description
constructor(): ParityRegion Construct parity region with empty loop array  
addLoops(data?: Loop | Loop[] | Loop[][]): void Add loops (recursively) to this region's children  
announceToCurveProcessor(processor: RecursiveCurveProcessor, indexInParent: number-1): void Invoke processor.announceParityRegion(this, indexInParent)  
clone(): ParityRegion Return a deep copy.  
cloneEmptyPeer(): ParityRegion Create a new empty parity region.  
cloneStroked(options?: StrokeOptions): ParityRegion Stroke these curves into a new ParityRegion.  
dgnBoundaryType(): number Return the boundary type (4) of a corresponding MicroStation CurveVector  
dispatchToGeometryHandler(handler: GeometryHandler): any Second step of double dispatch: call handler.handleRegion(this)  
getChild(i: number): undefined | Loop Get child i by index.  
isSameGeometryClass(other: GeometryQuery): boolean Test if other is an instance of ParityRegion  
tryAddChild(child: AnyCurve): boolean Add child to this parity region (by capturing it).  
create(...data: Loop[]): ParityRegion Static Create a parity region by capturing the given loops as children.  
createLoops(data?: Loop | Loop[] | Loop[][]): Loop | ParityRegion Static Return a single loop or parity region with given loops.  

Inherited methods

Name Inherited from Description
checkForNonLinearPrimitives(): boolean Inherited CurveCollection Return true if the curve collection has any primitives other than LineSegment3d and LineString3d
cloneTransformed(transform: Transform): undefined | CurveCollection Inherited CurveCollection Create a deep copy of transformed curves.
cloneWithExpandedLineStrings(): CurveCollection Inherited CurveCollection Create a deep copy with all linestrings broken down into multiple LineSegment3d.
closestPoint(spacePoint: Point3d, _extend: VariantCurveExtendParameterfalse, result?: CurveLocationDetail): undefined | CurveLocationDetail Inherited CurveCollection Return the closest point on the contained curves.
collectCurvePrimitives(collectorArray?: CurvePrimitive[], smallestPossiblePrimitives: booleanfalse, explodeLineStrings: booleanfalse): CurvePrimitive[] Inherited CurveCollection Return an array containing all CurvePrimitives in the instance.
extendRange(rangeToExtend: Range3d, transform?: Transform): void Inherited CurveCollection Extend (increase) the given range as needed to encompass all curves in the curve collection.
isAlmostEqual(other: GeometryQuery): boolean Inherited CurveCollection Test for exact structure and nearly identical geometry.
isAnyRegion(): this is AnyRegion Inherited CurveCollection Type guard for AnyRegion
isLoop(): this is Loop Inherited CurveCollection Type guard for Loop
isPath(): this is Path Inherited CurveCollection Type guard for Path
maxGap(): number Inherited CurveCollection Return the max gap between adjacent primitives in Path and Loop collections.
projectedParameterRange(ray: Vector3d | Ray3d, lowHigh?: Range1d): undefined | Range1d Inherited CurveCollection Project instance geometry (via dispatch) onto the given ray, and return the extreme fractional parameters
range(transform?: Transform, result?: Range3d): Range3d Inherited CurveCollection Return the range of the entire GeometryQuery tree.
sumLengths(): number Inherited CurveCollection Return the sum of the lengths of all contained curves.
tryTransformInPlace(transform: Transform): boolean Inherited CurveCollection Apply transform recursively to children
tryTranslateInPlace(dx: number, dy: number0.0, dz: number0.0): boolean Inherited CurveCollection Try to move the geometry by dx,dy,dz.
areAlmostEqual(a: GeometryQuery, b: GeometryQuery): boolean Static Inherited CurveCollection Apply instance method isAlmostEqual if both are defined.
createCurveLocationDetailOnAnyCurvePrimitive(source: GeometryQuery, fraction: number0.5): undefined | CurveLocationDetail Static Inherited CurveCollection Find any CurvePrimitive in the source and evaluate it at the given fraction.

Properties

Name Type Description
_children Protected Loop[] Array of loops in this parity region.  
children Accessor ReadOnly Loop[] Return the array of loops in this parity region.  
curveCollectionType Readonly "parityRegion" String name for schema properties  

Inherited properties

Name Type Inherited from Description
geometryCategory Readonly Inherited "curveCollection" CurveCollection String name for schema properties
isAnyRegionType Accessor Inherited ReadOnly boolean CurveCollection Return true for planar region types:
* Loop
* ParityRegion
* UnionRegion
isClosedPath Accessor Inherited 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 Inherited boolean CurveCollection Flag for inner loop status.
isOpenPath Accessor Inherited ReadOnly boolean CurveCollection Return true for a Path, i.e. a chain of curves joined head-to-tail

Defined in

Last Updated: 17 December, 2024