CurveBooleanRegions

References
[Serializable] public class CurveBooleanRegions : IDisposable
Represents the results of a Curve.CreateBooleanRegions calculation.

Constructors

CurveBooleanRegions

#
protected CurveBooleanRegions(SerializationInfo info, StreamingContext context)
Protected constructor used in serialization.
Parameters:
info (SerializationInfo)Serialization data.
context (StreamingContext)Serialization stream.

Properties

PlanarCurveCount

#Since v7.0
public int PlanarCurveCount { get; }
Returns number of planar curves that were calculated by Curve.CreateBooleanRegions.

PointCount

#Since v7.0
public int PointCount { get; }
If this object were created using the Curve.CreateBooleanRegions override that accepts a collection of points as input, then this value will be equal to the length of the points collection.

RegionCount

#Since v7.0
public int RegionCount { get; }
Returns the number of curve regions. A curve region is a collection of curves that bound a single connected region of the plane.

Methods

BoundaryCount

#Since v7.0
[ConstOperation] public int BoundaryCount(int regionIndex)
Returns the number of boundary curves in a curve region.
Parameters:
regionIndex (int)The curve region index.
Returns: The number of boundary curves in the curve region.

Dispose

#Since v7.0
public void Dispose()
Actively reclaims unmanaged resources that this instance uses.

Dispose

#
protected virtual void Dispose(bool disposing)
This method is called with argument true when class user calls Dispose(), while with argument false when the Garbage Collector invokes the finalizer, or Finalize() method. You must reclaim all used unmanaged resources in both cases, and can use this chance to call Dispose on disposable fields if the argument is true. Also, you must call the base virtual method within your overriding method.
Parameters:
disposing (bool)

PlanarCurve

#Since v7.0
[ConstOperation] public Curve PlanarCurve(int planarCurveIndex)
Returns a planar curve that was calculated by Curve.CreateBooleanRegions.
Parameters:
planarCurveIndex (int)
Returns: The planar curve if successful, null if not successful.

RegionCurves

#Since v7.0
[ConstOperation] public Curve[] RegionCurves(int regionIndex)
Returns the boundary curves in a curve region. A curve region is a collection of curves that bound a single connected region of the plane. Note, the first curve is always the outer boundary.
Parameters:
regionIndex (int)The curve region index.
Returns: An array of boundary curves if successful, an empty array if not successful.

RegionPointIndex

#Since v7.0
[ConstOperation] public int RegionPointIndex(int pointIndex)
If this object were created using the Curve.CreateBooleanRegions override that accepts a collection of points as input, then you this method to retrieve the index of the point contained in a curve region. If this.RegionPointIndex(i) = n, then points[i] is contained in this.RegionCurves(n). If points[i] is not in any region, then this.RegionPointIndex(i) = -1.
Parameters:
pointIndex (int)The point index.
Returns: The index of the input point contained in the specified region if successful, or -1 if points[i] was not used in any region or if not successful.

SegmentCount

#Since v7.0
[ConstOperation] public int SegmentCount(int regionIndex, int boundaryIndex)
Returns the number of segments in a boundary curve in a curve region.
Parameters:
regionIndex (int)The curve region index.
boundaryIndex (int)The boundary curve index.
Returns: The number of curve segments in th boundary curves.

SegmentDetails

#Since v7.0
[ConstOperation] public int SegmentDetails(int regionIndex, int boundaryIndex, int segmmentIndex, out Interval subDomain, out bool reversed)
Returns the details of a segment in a boundary curve in a curve region.
Parameters:
regionIndex (int)The curve region index.
boundaryIndex (int)The boundary curve index.
segmmentIndex (int)The segment index.
subDomain (out Interval)The sub-domain of the planar curve used by the segment.
reversed (out bool)true if the piece of the planar curve should be reversed.
Returns: The index of the planar curve used by the specified segment if successful, -1 if not successful.