Rename clip/refine methods for clarity (#1026)

Author: juliohm

docs/src/algorithms/clipping.md

@@ -10,10 +10,10 @@ clip
 ClippingMethod
 ```
 
-## SutherlandHodgman
+## Sutherland-Hodgman
 
 ```@docs
-SutherlandHodgman
+SutherlandHodgmanClipping
 ```
 
 ```@example clipping
@@ -26,7 +26,7 @@ poly = PolyArea([outer, inner])
 other = Box((0,1), (3,7))
 
 # clipped polygon
-clipped = clip(poly, other, SutherlandHodgman())
+clipped = clip(poly, other, SutherlandHodgmanClipping())
 
 viz(poly)
 viz!(other, color = :black, alpha = 0.2)

docs/src/algorithms/refinement.md

@@ -79,7 +79,7 @@ fig
 ## Catmull-Clark
 
 ```@docs
-CatmullClark
+CatmullClarkRefinement
 ```
 
 ```@example refinement
@@ -89,9 +89,9 @@ connec = connect.([(1,4,3,2),(5,6,7,8),(1,2,6,5),(3,4,8,7),(1,5,8,4),(2,3,7,6)])
 mesh   = SimpleMesh(points, connec)
 
 # refine three times
-ref1 = refine(mesh, CatmullClark())
-ref2 = refine(ref1, CatmullClark())
-ref3 = refine(ref2, CatmullClark())
+ref1 = refine(mesh, CatmullClarkRefinement())
+ref2 = refine(ref1, CatmullClarkRefinement())
+ref3 = refine(ref2, CatmullClarkRefinement())
 
 fig = Mke.Figure(size = (800, 800))
 viz(fig[1,1], mesh, showsegments = true)

src/Meshes.jl

@@ -433,7 +433,7 @@ export
 
   # clipping
   ClippingMethod,
-  SutherlandHodgman,
+  SutherlandHodgmanClipping,
   clip,
 
   # intersections
@@ -513,7 +513,7 @@ export
   TriRefinement,
   QuadRefinement,
   RegularRefinement,
-  CatmullClark,
+  CatmullClarkRefinement,
   TriSubdivision,
   refine,
 

src/clipping/sutherlandhodgman.jl

@@ -3,7 +3,7 @@
 # ------------------------------------------------------------------
 
 """
-    SutherlandHodgman()
+    SutherlandHodgmanClipping()
 
 The Sutherland-Hodgman algorithm for clipping polygons.
 
@@ -16,15 +16,15 @@ The Sutherland-Hodgman algorithm for clipping polygons.
 
 * The algorithm assumes that the clipping geometry is convex.
 """
-struct SutherlandHodgman <: ClippingMethod end
+struct SutherlandHodgmanClipping <: ClippingMethod end
 
-function clip(poly::Polygon, other::Geometry, method::SutherlandHodgman)
+function clip(poly::Polygon, other::Geometry, method::SutherlandHodgmanClipping)
   c = [clip(ring, boundary(other), method) for ring in rings(poly)]
   r = [r for r in c if !isnothing(r)]
   isempty(r) ? nothing : PolyArea(r)
 end
 
-function clip(ring::Ring, other::Ring, ::SutherlandHodgman)
+function clip(ring::Ring, other::Ring, ::SutherlandHodgmanClipping)
   # make sure other ring is CCW
   occw = orientation(other) == CCW ? other : reverse(other)
 

src/intersections/polygons.jl

@@ -5,9 +5,9 @@
 function intersection(f, poly₁::Polygon, poly₂::Polygon)
   # TODO: use Weiler-Atherton or other more general clipping method
   clipped = if isconvex(poly₂)
-    clip(poly₁, poly₂, SutherlandHodgman())
+    clip(poly₁, poly₂, SutherlandHodgmanClipping())
   elseif isconvex(poly₁)
-    clip(poly₂, poly₁, SutherlandHodgman())
+    clip(poly₂, poly₁, SutherlandHodgmanClipping())
   else
     throw(ErrorException("intersection not implemented between two non-convex polygons"))
   end

src/refinement/catmullclark.jl

@@ -3,7 +3,7 @@
 # ------------------------------------------------------------------
 
 """
-    CatmullClark()
+    CatmullClarkRefinement()
 
 Catmull-Clark refinement of polygonal meshes.
 
@@ -19,9 +19,9 @@ surface.
   B-spline surfaces on arbitrary topological meshes]
   (https://www.sciencedirect.com/science/article/abs/pii/0010448578901100)
 """
-struct CatmullClark <: RefinementMethod end
+struct CatmullClarkRefinement <: RefinementMethod end
 
-function refine(mesh, ::CatmullClark)
+function refine(mesh, ::CatmullClarkRefinement)
   # retrieve geometry and topology
   points = vertices(mesh)
   connec = topology(mesh)

test/clipping.jl

@@ -2,14 +2,14 @@
   # triangle
   poly = Triangle(cart(6, 2), cart(3, 5), cart(0, 2))
   other = Quadrangle(cart(5, 0), cart(5, 4), cart(0, 4), cart(0, 0))
-  clipped = clip(poly, other, SutherlandHodgman())
+  clipped = clip(poly, other, SutherlandHodgmanClipping())
   @test issimple(clipped)
   @test all(vertices(clipped) .≈ [cart(5, 3), cart(4, 4), cart(2, 4), cart(0, 2), cart(5, 2)])
 
   # octagon
   poly = Octagon(cart(8, -2), cart(8, 5), cart(2, 5), cart(4, 3), cart(6, 3), cart(4, 1), cart(2, 1), cart(2, -2))
   other = Quadrangle(cart(5, 0), cart(5, 4), cart(0, 4), cart(0, 0))
-  clipped = clip(poly, other, SutherlandHodgman())
+  clipped = clip(poly, other, SutherlandHodgmanClipping())
   @test !issimple(clipped)
   @test all(
     vertices(clipped) .≈
@@ -19,20 +19,20 @@
   # inside
   poly = Quadrangle(cart(1, 0), cart(1, 1), cart(0, 1), cart(0, 0))
   other = Quadrangle(cart(5, 0), cart(5, 4), cart(0, 4), cart(0, 0))
-  clipped = clip(poly, other, SutherlandHodgman())
+  clipped = clip(poly, other, SutherlandHodgmanClipping())
   @test issimple(clipped)
   @test all(vertices(clipped) .≈ vertices(poly))
 
   # outside
   poly = Quadrangle(cart(7, 6), cart(7, 7), cart(6, 7), cart(6, 6))
   other = Quadrangle(cart(5, 0), cart(5, 4), cart(0, 4), cart(0, 0))
-  clipped = clip(poly, other, SutherlandHodgman())
+  clipped = clip(poly, other, SutherlandHodgmanClipping())
   @test isnothing(clipped)
 
   # surrounded
   poly = Hexagon(cart(0, 2), cart(-2, 2), cart(-2, 0), cart(0, -2), cart(2, -2), cart(2, 0))
   other = Hexagon(cart(1, 0), cart(0, 1), cart(-1, 1), cart(-1, 0), cart(0, -1), cart(1, -1))
-  clipped = clip(poly, other, SutherlandHodgman())
+  clipped = clip(poly, other, SutherlandHodgmanClipping())
   @test issimple(clipped)
   @test all(vertices(clipped) .≈ vertices(other))
 
@@ -41,7 +41,7 @@
   inner = Ring(cart(4, 4), cart(2, 4), cart(3, 6))
   poly = PolyArea([outer, inner])
   other = Box(cart(0, 1), cart(3, 7))
-  clipped = clip(poly, other, SutherlandHodgman())
+  clipped = clip(poly, other, SutherlandHodgmanClipping())
   crings = rings(clipped)
   @test !issimple(clipped)
   @test all(
@@ -55,7 +55,7 @@
   inner = Ring(cart(1, 3), cart(3, 3), cart(3, 1), cart(1, 1))
   poly = PolyArea([outer, inner])
   other = Quadrangle(cart(4, 4), cart(0, 4), cart(0, 0), cart(4, 0))
-  clipped = clip(poly, other, SutherlandHodgman())
+  clipped = clip(poly, other, SutherlandHodgmanClipping())
   @test !issimple(clipped)
   crings = rings(clipped)
   @test all(vertices(crings[1]) .≈ vertices(other))
@@ -67,7 +67,7 @@
   inner₂ = Ring(cart(2, 5), cart(2, 6), cart(3, 5))
   poly = PolyArea([outer, inner₁, inner₂])
   other = PolyArea(Ring(cart(6, 1), cart(7, 2), cart(6, 5), cart(0, 2), cart(1, 1)))
-  clipped = clip(poly, other, SutherlandHodgman())
+  clipped = clip(poly, other, SutherlandHodgmanClipping())
   crings = rings(clipped)
   @test !issimple(clipped)
   @test length(crings) == 2

test/refinement.jl

@@ -73,9 +73,9 @@ end
   points = cart.([(0, 0), (1, 0), (0, 1), (1, 1), (0.5, 0.5)])
   connec = connect.([(1, 2, 5), (2, 4, 5), (4, 3, 5), (3, 1, 5)])
   mesh = SimpleMesh(points, connec)
-  ref1 = refine(mesh, CatmullClark())
-  ref2 = refine(ref1, CatmullClark())
-  ref3 = refine(ref2, CatmullClark())
+  ref1 = refine(mesh, CatmullClarkRefinement())
+  ref2 = refine(ref1, CatmullClarkRefinement())
+  ref3 = refine(ref2, CatmullClarkRefinement())
 
   if visualtests
     fig = Mke.Figure(size=(900, 300))
@@ -88,9 +88,9 @@ end
   points = cart.([(0, 0), (1, 0), (0, 1), (1, 1), (0.25, 0.25), (0.75, 0.25), (0.5, 0.75)])
   connec = connect.([(1, 2, 6, 5), (1, 5, 7, 3), (2, 4, 7, 6), (3, 7, 4)])
   mesh = SimpleMesh(points, connec)
-  ref1 = refine(mesh, CatmullClark())
-  ref2 = refine(ref1, CatmullClark())
-  ref3 = refine(ref2, CatmullClark())
+  ref1 = refine(mesh, CatmullClarkRefinement())
+  ref2 = refine(ref1, CatmullClarkRefinement())
+  ref3 = refine(ref2, CatmullClarkRefinement())
 
   if visualtests
     fig = Mke.Figure(size=(900, 300))
@@ -103,9 +103,9 @@ end
   points = cart.([(0, 0, 0), (1, 0, 0), (1, 1, 0), (0, 1, 0), (0, 0, 1), (1, 0, 1), (1, 1, 1), (0, 1, 1)])
   connec = connect.([(1, 4, 3, 2), (5, 6, 7, 8), (1, 2, 6, 5), (3, 4, 8, 7), (1, 5, 8, 4), (2, 3, 7, 6)])
   mesh = SimpleMesh(points, connec)
-  ref1 = refine(mesh, CatmullClark())
-  ref2 = refine(ref1, CatmullClark())
-  ref3 = refine(ref2, CatmullClark())
+  ref1 = refine(mesh, CatmullClarkRefinement())
+  ref2 = refine(ref1, CatmullClarkRefinement())
+  ref3 = refine(ref2, CatmullClarkRefinement())
 
   if visualtests
     fig = Mke.Figure(size=(900, 300))
@@ -119,7 +119,7 @@ end
   points = merc.([(0, 0), (1, 0), (0, 1), (1, 1), (0.5, 0.5)])
   connec = connect.([(1, 2, 5), (2, 4, 5), (4, 3, 5), (3, 1, 5)])
   mesh = SimpleMesh(points, connec)
-  ref = refine(mesh, CatmullClark())
+  ref = refine(mesh, CatmullClarkRefinement())
   @test crs(ref) === crs(mesh)
 end