'Torus': Rename 'normal' to 'direction' (#1065)

Author: eliascarv

src/Meshes.jl

@@ -192,6 +192,7 @@ export
   sides,
   diagonal,
   focallength,
+  direction,
 
   # polytopes
   Polytope,

src/geometries/primitives/torus.jl

@@ -3,26 +3,27 @@
 # ------------------------------------------------------------------
 
 """
-    Torus(center, normal, major, minor)
+    Torus(center, direction, major, minor)
 
 A torus centered at `center` with axis of revolution directed by 
-`normal` and with radii `major` and `minor`. 
+`direction` and with radii `major` and `minor`. 
 
 """
 struct Torus{C<:CRS,Mₚ<:Manifold,V<:Vec{3},ℒ<:Len} <: Primitive{𝔼{3},C}
   center::Point{Mₚ,C}
-  normal::V
+  direction::V
   major::ℒ
   minor::ℒ
-  Torus(center::Point{Mₚ,C}, normal::V, major::ℒ, minor::ℒ) where {C<:CRS,Mₚ<:Manifold,V<:Vec{3},ℒ<:Len} =
-    new{C,Mₚ,V,float(ℒ)}(center, normal, major, minor)
+  Torus(center::Point{Mₚ,C}, direction::V, major::ℒ, minor::ℒ) where {C<:CRS,Mₚ<:Manifold,V<:Vec{3},ℒ<:Len} =
+    new{C,Mₚ,V,float(ℒ)}(center, direction, major, minor)
 end
 
-Torus(center::Point, normal::Vec, major::Len, minor::Len) = Torus(center, normal, promote(major, minor)...)
+Torus(center::Point, direction::Vec, major::Len, minor::Len) = Torus(center, direction, promote(major, minor)...)
 
-Torus(center::Point, normal::Vec, major, minor) = Torus(center, normal, addunit(major, u"m"), addunit(minor, u"m"))
+Torus(center::Point, direction::Vec, major, minor) =
+  Torus(center, direction, addunit(major, u"m"), addunit(minor, u"m"))
 
-Torus(center::Tuple, normal::Tuple, major, minor) = Torus(Point(center), Vec(normal), major, minor)
+Torus(center::Tuple, direction::Tuple, major, minor) = Torus(Point(center), Vec(direction), major, minor)
 
 """
     Torus(p1, p2, p3, minor)
@@ -44,18 +45,18 @@ paramdim(::Type{<:Torus}) = 2
 
 center(t::Torus) = t.center
 
-normal(t::Torus) = t.normal
+direction(t::Torus) = t.direction
 
 radii(t::Torus) = (t.major, t.minor)
 
-axis(t::Torus) = Line(t.center, t.center + t.normal)
+axis(t::Torus) = Line(t.center, t.center + t.direction)
 
 ==(t₁::Torus, t₂::Torus) =
-  t₁.center == t₂.center && t₁.normal == t₂.normal && t₁.major == t₂.major && t₁.minor == t₂.minor
+  t₁.center == t₂.center && t₁.direction == t₂.direction && t₁.major == t₂.major && t₁.minor == t₂.minor
 
 Base.isapprox(t₁::Torus, t₂::Torus; atol=atol(lentype(t₁)), kwargs...) =
   isapprox(t₁.center, t₂.center; atol, kwargs...) &&
-  isapprox(t₁.normal, t₂.normal; atol, kwargs...) &&
+  isapprox(t₁.direction, t₂.direction; atol, kwargs...) &&
   isapprox(t₁.major, t₂.major; atol, kwargs...) &&
   isapprox(t₁.minor, t₂.minor; atol, kwargs...)
 
@@ -65,7 +66,7 @@ function (t::Torus)(θ, φ)
   if (θ < 0 || θ > 1) || (φ < 0 || φ > 1)
     throw(DomainError((θ, φ), "t(θ, φ) is not defined for θ, φ outside [0, 1]²."))
   end
-  c, n⃗ = t.center, t.normal
+  c, n⃗ = t.center, t.direction
   R, r = t.major, t.minor
 
   Q = urotbetween(Vec(zero(ℒ), zero(ℒ), oneunit(ℒ)), n⃗)

src/predicates/in.jl

@@ -104,7 +104,7 @@ end
 function Base.in(p::Point, t::Torus)
   ℒ = lentype(p)
   R, r = radii(t)
-  c, n = center(t), normal(t)
+  c, n = center(t), direction(t)
   Q = urotbetween(n, Vec(zero(ℒ), zero(ℒ), oneunit(ℒ)))
   x, y, z = Q * (p - c)
   (R - √(x^2 + y^2))^2 + z^2 ≤ r^2

test/primitives.jl

@@ -1270,7 +1270,7 @@ end
   @test crs(t) <: Cartesian{NoDatum}
   @test Meshes.lentype(t) == ℳ
   @test center(t) == cart(1, 1, 1)
-  @test normal(t) == vector(1, 0, 0)
+  @test direction(t) == vector(1, 0, 0)
   @test radii(t) == (T(2) * u"m", T(1) * u"m")
   @test axis(t) == Line(cart(1, 1, 1), cart(2, 1, 1))
   @test measure(t) ≈ 8 * T(π)^2 * u"m^2"
@@ -1305,19 +1305,19 @@ end
 
   t = Torus(cart(1, 1, 1), vector(1, 0, 0), T(2), T(1))
   @test sprint(show, t) ==
-        "Torus(center: (x: 1.0 m, y: 1.0 m, z: 1.0 m), normal: (1.0 m, 0.0 m, 0.0 m), major: 2.0 m, minor: 1.0 m)"
+        "Torus(center: (x: 1.0 m, y: 1.0 m, z: 1.0 m), direction: (1.0 m, 0.0 m, 0.0 m), major: 2.0 m, minor: 1.0 m)"
   if T === Float32
     @test sprint(show, MIME("text/plain"), t) == """
     Torus
     ├─ center: Point(x: 1.0f0 m, y: 1.0f0 m, z: 1.0f0 m)
-    ├─ normal: Vec(1.0f0 m, 0.0f0 m, 0.0f0 m)
+    ├─ direction: Vec(1.0f0 m, 0.0f0 m, 0.0f0 m)
     ├─ major: 2.0f0 m
     └─ minor: 1.0f0 m"""
   else
     @test sprint(show, MIME("text/plain"), t) == """
     Torus
     ├─ center: Point(x: 1.0 m, y: 1.0 m, z: 1.0 m)
-    ├─ normal: Vec(1.0 m, 0.0 m, 0.0 m)
+    ├─ direction: Vec(1.0 m, 0.0 m, 0.0 m)
     ├─ major: 2.0 m
     └─ minor: 1.0 m"""
   end