Skip to content

Commit c0900c1

Browse files
committed
descriptions tweaked following @peterjamesnugent's suggestion
1 parent 18c3bf3 commit c0900c1

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

Geometry_Engine/Compute/BooleanDifference.cs

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -37,23 +37,23 @@ public static partial class Compute
3737
/**** public Methods - Lines ****/
3838
/***************************************************/
3939

40-
[Description("Returns the parts of the first line that are _not_ overlapping with the reference line, i.e. removes that parts of the first line that _is_ overlapping with the reference line. If the lines are not colinear or within tolerance distance of each other the full first line is returned.")]
40+
[Description("Returns the parts of the first line that are not overlapping with the reference line, i.e. removes that parts of the first line that is overlapping with the reference line. If the lines are not colinear or within tolerance distance of each other the full first line is returned.")]
4141
[Input("line", "The line to remove overlaps from.")]
4242
[Input("refLine", "The reference line. Any parts of this line that are overlapping with the first line are removed from the first line.")]
4343
[Input("tolerance", "Tolerance used for checking colinearity and proximity of the two lines.", typeof(Length))]
44-
[Output("line", "The parts of the first line _not_ overlapping with the reference line.")]
44+
[Output("line", "The parts of the first line not overlapping with the reference line.")]
4545
public static List<Line> BooleanDifference(this Line line, Line refLine, double tolerance = Tolerance.Distance)
4646
{
4747
return new List<Line> { line }.BooleanDifference(new List<Line> { refLine }, tolerance);
4848
}
4949

5050
/***************************************************/
5151

52-
[Description("Returns the parts of the first lines that are _not_ overlapping with any of the reference lines, i.e. removes that parts of the first lines that _is_ overlapping with any of the reference lines. If a line and a reference line are not colinear or within distance tolerance of each other, no action will be taken for that particular pair of lines.")]
52+
[Description("Returns the parts of the first lines that are not overlapping with any of the reference lines, i.e. removes that parts of the first lines that is overlapping with any of the reference lines. If a line and a reference line are not colinear or within distance tolerance of each other, no action will be taken for that particular pair of lines.")]
5353
[Input("lines", "The lines to remove overlaps from.")]
5454
[Input("refLines", "The reference lines. Any parts of these lines that are overlapping with the first lines are removed from the first lines.")]
5555
[Input("tolerance", "Tolerance used for checking colinearity and proximity between two lines.", typeof(Length))]
56-
[Output("lines", "The parts of the first lines _not_ overlapping with the reference lines.")]
56+
[Output("lines", "The parts of the first lines not overlapping with the reference lines.")]
5757
public static List<Line> BooleanDifference(this List<Line> lines, List<Line> refLines, double tolerance = Tolerance.Distance)
5858
{
5959
double sqTol = tolerance * tolerance;
@@ -87,11 +87,11 @@ public static List<Line> BooleanDifference(this List<Line> lines, List<Line> ref
8787
/**** public Methods - Regions ****/
8888
/***************************************************/
8989

90-
[Description("Returns the areas of the closed Polyline region that are _not_ overlapping with the closed Polyline reference regions, i.e. removes that areas of the first region that _is_ overlapping with any of the reference regions. Requires the region and all reference regions to be closed. The method only considers reference regions that are co-planar with the region being evaluated.")]
90+
[Description("Returns the areas of the closed Polyline region that are not overlapping with the closed Polyline reference regions, i.e. removes that areas of the first region that is overlapping with any of the reference regions. Requires the region and all reference regions to be closed. The method only considers reference regions that are co-planar with the region being evaluated.")]
9191
[Input("region", "The line to remove overlaps from. Should be a closed planar curve.")]
9292
[Input("refRegions", "The reference regions. Any parts of these regions that are overlapping with the first region are removed from the first region. All regions required to be closed. Reference regions not coplanar with the region are not considered.")]
9393
[Input("tolerance", "Tolerance used for checking co-planarity and proximity of the regions.", typeof(Length))]
94-
[Output("regions", "The region parts of the first region _not_ overlapping with any of the reference regions.")]
94+
[Output("regions", "The region parts of the first region not overlapping with any of the reference regions.")]
9595
public static List<Polyline> BooleanDifference(this Polyline region, List<Polyline> refRegions, double tolerance = Tolerance.Distance)
9696
{
9797
if (!region.IsClosed(tolerance) || refRegions.Any(x => !x.IsClosed()))
@@ -242,11 +242,11 @@ public static List<Polyline> BooleanDifference(this Polyline region, List<Polyli
242242

243243
/***************************************************/
244244

245-
[Description("Returns the areas of the closed ICurve region that are _not_ overlapping with the closed ICurve reference regions, i.e. removes that areas of the first region that _is_ overlapping with any of the reference regions. Requires the region and all reference regions to be closed. The method only considers reference regions that are co-planar with the region being evaluated.")]
245+
[Description("Returns the areas of the closed ICurve region that are not overlapping with the closed ICurve reference regions, i.e. removes that areas of the first region that is overlapping with any of the reference regions. Requires the region and all reference regions to be closed. The method only considers reference regions that are co-planar with the region being evaluated.")]
246246
[Input("region", "The line to remove overlaps from. Should be a closed planar curve.")]
247247
[Input("refRegions", "The reference regions. Any parts of these regions that are overlapping with the first region are removed from the first region. All regions required to be closed. Reference regions not coplanar with the region are not considered.")]
248248
[Input("tolerance", "Tolerance used for checking co-planarity and proximity of the regions.", typeof(Length))]
249-
[Output("regions", "The region parts of the first region _not_ overlapping with any of the reference regions.")]
249+
[Output("regions", "The region parts of the first region not overlapping with any of the reference regions.")]
250250
public static List<PolyCurve> BooleanDifference(this ICurve region, IEnumerable<ICurve> refRegions, double tolerance = Tolerance.Distance)
251251
{
252252
List<ICurve> refRegionsList = refRegions.ToList();

0 commit comments

Comments
 (0)