Merge remote-tracking branch 'origin/main' into glasscat-tests

README.md

@@ -49,6 +49,8 @@ Before you can use the software you will need to download glass files. See the d
 
 ## Contributing
 
+[![ColPrac: Contributor's Guide on Collaborative Practices for Community Packages](https://img.shields.io/badge/ColPrac-Contributor's%20Guide-blueviolet)](https://github.com/SciML/ColPrac)
+
 This project welcomes contributions and suggestions.  Most contributions require you to agree to a
 Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us
 the rights to use your contribution. For details, visit <https://cla.opensource.microsoft.com>.

docs/src/basic_types.md

@@ -15,8 +15,6 @@ OpticSim.Geometry.Vec3
 OpticSim.Geometry.unitX3
 OpticSim.Geometry.unitY3
 OpticSim.Geometry.unitZ3
-OpticSim.Geometry.zero3
-OpticSim.Geometry.one3
 ```
 
 ## Vec4
@@ -29,8 +27,6 @@ OpticSim.Geometry.unitX4
 OpticSim.Geometry.unitY4
 OpticSim.Geometry.unitZ4
 OpticSim.Geometry.unitW4
-OpticSim.Geometry.zero4
-OpticSim.Geometry.one4
 ```
 
 ## Transform

src/Geometry/Transform.jl

@@ -38,16 +38,8 @@ unitY3(::Type{T} = Float64) where {T<:Real} = Vec3{T}(zero(T), one(T), zero(T))
 returns the unit vector `[0, 0, 1]`
 """
 unitZ3(::Type{T} = Float64) where {T<:Real} = Vec3{T}(zero(T), zero(T), one(T))
-"""
-returns the unit vector `[0, 0, 0]`
-"""
-zero3(::Type{T} = Float64) where {T<:Real} = zeros(Vec3{T})
-"""
-returns the unit vector `[1, 1, 1]`
-"""
-one3(::Type{T} = Float64) where {T<:Real} = Vec3{T}(one(T), one(T), one(T))
 
-export unitX3, unitY3, unitZ3, zero3, one3
+export unitX3, unitY3, unitZ3
 
 #endregion Vec3
 
@@ -105,16 +97,8 @@ unitZ4(::Type{T} = Float64) where {T<:Real} = Vec4{T}(zero(T), zero(T), one(T),
 returns the unit vector `[0, 0, 0, 1]`
 """
 unitW4(::Type{T} = Float64) where {T<:Real} = Vec4{T}(zero(T), zero(T), zero(T), one(T))
-"""
-returns the unit vector `[0, 0, 0, 0]`
-"""
-zero4(::Type{T} = Float64) where {T<:Real} = zeros(Vec4{T})
-"""
-returns the unit vector `[1, 1, 1, 1]`
-"""
-one4(::Type{T} = Float64) where {T<:Real} = Vec4{T}(one(T), one(T), one(T), one(T))
 
-export unitX4, unitY4, unitZ4, unitW4, zero4, one4
+export unitX4, unitY4, unitZ4, unitW4
 #endregion Vec4
 
 
@@ -163,7 +147,6 @@ Transform(rotation::AbstractArray{S,2}, translation::AbstractArray{S,1})
 Transform{T} = SMatrix{4,4,T,16}
 export Transform
 
-
 # for compatability ith the "old" RigidBodyTransform
 """
 identitytransform([S::Type]) -> Transform{S}
@@ -193,27 +176,18 @@ end
 
 Costruct a transform from the input columns.     
 """
-function Transform(colx::Vec3{T}, coly::Vec3{T}, colz::Vec3{T}, colw::Vec3{T} = zero3(T)) where {T<:Real}
-    return Transform{T}(
-        colx[1], colx[2], colx[3], zero(T), 
-        coly[1], coly[2], coly[3], zero(T), 
-        colz[1], colz[2], colz[3], zero(T), 
-        colw[1], colw[2], colw[3], one(T)
-    )
+function Transform(colx::Vec3{T}, coly::Vec3{T}, colz::Vec3{T}, colw::Vec3{T} = zero(Vec3{T})) where {T<:Real}
+    return vcat(hcat(colx,coly,colz,colw),SMatrix{1,4,T}(zero(T),zero(T),zero(T),one(T)) )
 end
 
+
 """
     Transform(colx::Vec3{T}, coly::Vec3{T},colz::Vec3{T}, colw::Vec3{T}, ::Type{T} = Float64) where {T<:Real}
 
 Costruct a transform from the input columns.     
 """
 function Transform(colx::Vec4{T}, coly::Vec4{T}, colz::Vec4{T}, colw::Vec4{T}) where {T<:Real}
-    return Transform{T}(
-        colx[1], colx[2], colx[3], colx[4], 
-        coly[1], coly[2], coly[3], coly[4], 
-        colz[1], colz[2], colz[3], colz[4], 
-        colw[1], colw[2], colw[3], colw[4]
-    )
+    return hcat(colx,coly,colz,colw)
 end
 
 """
@@ -259,7 +233,6 @@ function Transform(rotation::AbstractArray{T,2}, translation::AbstractArray{T,1}
         translation[1], translation[2], translation[3], one(T))
 end
 
-
 """
     rotationX(angle::T) where {T<:Real} -> Transform
 
@@ -333,7 +306,7 @@ function rotation(t::Transform{T}) where {T<:Real}
         t[1, 1], t[2, 1], t[3, 1], 
         t[1, 2], t[2, 2], t[3, 2],
         t[1, 3], t[2, 3], t[3, 3])
-    return Transform(rot, zero3(T))
+    return Transform(rot, zero(Vec3{T}))
 end
 
 """

src/OpticSim.jl

@@ -12,6 +12,9 @@ using Images
 using Base: @.
 using ForwardDiff
 using StringEncodings
+
+# this dependency is intentional! Revise allows OpticSim to reload AGFGlassCat.jl (the glass database) after calling
+# `add_agf` (src/GlassCat/sources.jl) with `rebuild = true`
 using Revise
 
 # included here to allow a call to the activate! during the initialization

test/runtests.jl

@@ -75,6 +75,7 @@ alltestsets = [
     "Visualization",
     "Allocations",
     "GlassCat",
+    "Transform"
 ]
 
 runtestsets = ALL_TESTS ? alltestsets : intersect(alltestsets, ARGS)

test/testsets/Transform.jl

@@ -0,0 +1,24 @@
+# MIT license
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# See LICENSE in the project root for full license information.
+
+@testset "Transform" begin
+    A = [
+        1 2 3 4;
+        4 5 6 7;
+        8 9 10 11;
+        12 13 14 15
+    ]
+    x,y,z,w = Vec4.([A[:,i] for i in 1:4])
+    @test Geometry.Transform(x,y,z,w) == A
+
+    B = [
+        1 2 3 4;
+        4 5 6 7;
+        8 9 10 11;
+        0 0 0 1
+    ]
+    x,y,z,w = Vec3.([B[1:3,i] for i in 1:4])
+    @test B == Geometry.Transform(x,y,z,w)
+
+end # testset Allocations