docs

Author: cormullion

.travis.yml

@@ -25,7 +25,7 @@ env:
 jobs:
   include:
     - stage: "Documentation"
-      julia: 1.4
+      julia: 1.5
       os: osx
       script:
         - julia --project=docs/ -e 'using Pkg; Pkg.instantiate();

CHANGELOG.md

@@ -1,16 +1,16 @@
 # Changelog
 
-## [v0.5.0] - forthcoming
+## [v0.5.0] - 2020-01-31
 
 ### Added
 
 - dependency on Rotations.jl added
 
 ### Changed
 
-- Point3D are now FieldVectors from StaticArrays.jl
+- Point3Ds are now FieldVectors from StaticArrays.jl
 - rotations now calculated by Rotations.jl
-- rotateby functions modified
+- all `rotateby` functions modified
 
 ### Removed
 

docs/Project.toml

@@ -6,3 +6,4 @@ Rotations = "6038ab10-8711-5258-84ad-4b1120ba62dc"
 
 [compat]
 Documenter = "0.25"
+Rotations = "1"

docs/src/tools.md

@@ -314,7 +314,9 @@ sphericaltocartesian
 cartesiantospherical
 
 dotproduct3D
+crossproduct3D
 magnitude
 anglebetweenvectors
 surfacenormal
+pointsperpendicular
 ```

src/Point3D.jl

@@ -106,12 +106,16 @@ end
 """
     anglebetweenvectors(v1::Point3D, v2::Point3D)
 
-Calclates anglebetweenvectors
+Calclate the angle between two vectors.
 """
 function anglebetweenvectors(v1::Point3D, v2::Point3D)
     intermediate = dotproduct3D(v1, v2)/(magnitude(v1) * magnitude(v2))
     # avoid domain errors
-    return acos(min(max(-1, intermediate), 1))
+    if isnan(intermediate)
+        return 0.0
+    else
+        return acos(min(max(-1, intermediate), 1))
+    end
 end
 
 """
@@ -127,7 +131,7 @@ end
 """
     sphericaltocartesian(rho, theta, phi)
 
-Return Point3D(x, y, z) of (rho, theta, phi).
+Return `Point3D(x, y, z)` corresponding to `(rho, theta, phi)`.
 """
 function sphericaltocartesian(rho, theta, phi)
     x = rho * sin(phi) * cos(theta)

src/Thebes.jl

@@ -4,8 +4,8 @@ using Luxor
 using StaticArrays
 using Rotations
 
-include("utils.jl")
 include("Point3D.jl")
+include("utils.jl")
 include("Projection.jl")
 include("Object.jl")
 include("pin.jl")
@@ -34,7 +34,7 @@ export project, Projection, newprojection,
        scaleby!, sortfaces!,
        sphericaltocartesian, cartesiantospherical,
        dotproduct3D, magnitude, anglebetweenvectors,
-       surfacenormal, face,
+       surfacenormal, face, crossproduct3D, pointsperpendicular,
 
        text3D
 

src/text.jl

@@ -9,7 +9,7 @@ Draw text at point `pt`, lying in the plane of the x axis.
 Angles in `rotation` rotate the text about the `about` point,
 defaulting to `Point3D(0, 0, 0)`.
 
-Uses current `fontface()` and `fontsize()` settings.
+Uses Luxor's `fontface()` and `fontsize()` settings.
 
 Specify rotations using functions from Rotations.jl, such as:
 

src/utils.jl

@@ -117,3 +117,32 @@ function carpet(n=100; kind=:circular)
         end
     end
 end
+
+"""
+    crossproduct3D(A::Point3D, B::Point3D)
+
+Find one of these.
+"""
+function crossproduct3D(A::Point3D, B::Point3D)
+    x = (A.y * B.z) - (A.z * B.y)
+    y = (A.z * B.x) - (A.x * B.z)
+    z = (A.x * B.y) - (A.y * B.x)
+    return Point3D(x, y, z)
+end
+
+"""
+    pointsperpendicular(p1::Point3D, p2::Point3D, radius, angles = [0, π])
+
+Find points perpendicular to a line joining p1 and p2.
+Points are `radius` units away from the line.
+"""
+function pointsperpendicular(p1::Point3D, p2::Point3D, radius, angles = [0, π])
+    V3 = p2 - p1 # unit vector
+    V3 /= distance(Point3D(0.0, 0.0, 0.0), V3)
+    e = Point3D(0.0, 0.0, 1.0)
+    V1 = crossproduct3D(e, V3) # unit vector perpendicular to both e and V3
+    V1 /= distance(Point3D(0.0, 0.0, 0.0), V1)
+    V2 = crossproduct3D(V3, V1) # third unit vector perpendicular to both V3 and V1
+    # find points P on the circle θ radians relative to vector V1 (x-axis)
+    return [p1 + radius * (cos(θ) * V1 + sin(θ) * V2) for θ in angles]
+end