Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix WGLMakie nan error #4772

Merged
merged 4 commits into from
Feb 14, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
- Fixed issue with `WGLMakie.voxels` not rendering on linux with firefox [#4756](https://github.com/MakieOrg/Makie.jl/pull/4756)
- Cleaned up surface handling in GLMakie: Surface cells are now discarded when there is a nan in x, y or z. Fixed incorrect normal if x or y is nan [#4735](https://github.com/MakieOrg/Makie.jl/pull/4735)
- Cleaned up `volume` plots: Added `:indexedabsorption` and `:additive` to WGLMakie, generalized `:mip` to include negative values, fixed missing conversions for rgba algorithms (`:additive`, `:absorptionrgba`), fixed missing conversion for `absorption` attribute & extended it to `:indexedabsorption` and `absorptionrgba`, added tests and improved docs. [#4726](https://github.com/MakieOrg/Makie.jl/pull/4726)
- Fixed `Plane(Vec{N, T}(0), dist)` producing a `NaN` normal, which caused WGLMakie to break. (E.g. when rotating Axis3) [#4772](https://github.com/MakieOrg/Makie.jl/pull/4772)

## [0.22.1] - 2025-01-17

Expand Down
10 changes: 8 additions & 2 deletions src/utilities/Plane.jl
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,13 @@ struct Plane{N, T}
distance::T

function Plane{N, T}(normal::Vec{N, T}, distance::T) where {N, T <: Real}
return new{N, T}(normalize(normal), distance)
# Functions using Plane assume `normal` to be normalized.
# `normalize()` turns 0 vectors into NaN vectors which we don't want,
# so we explicitly handle normalization here
n = norm(normal)
ffreyer marked this conversation as resolved.
Show resolved Hide resolved
ϵ = 100 * max(eps.(normal)...)
normalized = ifelse(n > ϵ, normal / n, Vec{N, T}(0))
return new{N, T}(normalized, distance)
end
end

Expand Down Expand Up @@ -329,4 +335,4 @@ function to_clip_space(pv::Mat4, ipv::Mat4, plane::Plane3)

return Plane(origin, normal)
end
end
end
17 changes: 11 additions & 6 deletions test/isolated/Plane.jl
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ using Makie: Plane, Plane3f, Point3d, Rect3d, Vec3d
plane = Plane(Point3{T}(1), Vec3{T}(1, 1, 0))
@test plane isa Plane{3, T}
@test plane.normal normalize(Vec3{T}(1, 1, 0))
@test plane.distance T(sqrt(2.0))
@test plane.distance T(sqrt(2.0))

plane = Plane(Point2{T}(1), Vec2{T}(0, 1))
@test plane isa Plane{2, T}
Expand All @@ -16,7 +16,7 @@ using Makie: Plane, Plane3f, Point3d, Rect3d, Vec3d
plane = Plane(Vec3{T}(1), 2.0)
@test plane isa Plane{3, T}
@test plane.normal normalize(Vec3{T}(1))
@test plane.distance T(2)
@test plane.distance T(2)

clip_box = Rect3f(Point3f(0), Vec3f(1))
planes = Makie.planes(clip_box)
Expand All @@ -28,6 +28,11 @@ using Makie: Plane, Plane3f, Point3d, Rect3d, Vec3d
Plane3f(Vec3f( 0, -1, 0), -1f0),
Plane3f(Vec3f( 0, 0, -1), -1f0)
]

plane = Plane(Vec3{T}(0), 2.0)
@test plane isa Plane{3, T}
@test plane.normal Vec3{T}(0)
@test plane.distance T(2)
end
end

Expand Down Expand Up @@ -107,7 +112,7 @@ using Makie: Plane, Plane3f, Point3d, Rect3d, Vec3d
plane = Plane3f(Point3f(0.5), Vec3f(0,0,1))

# transform points
ds = let
ds = let
transformed = map(p -> Point3f(model * to_ndim(Point4f, p, 1)), ps)
Makie.distance.((plane,), transformed)
end
Expand All @@ -120,10 +125,10 @@ using Makie: Plane, Plane3f, Point3d, Rect3d, Vec3d
bbox = Rect3d(Point3d(-1), Vec3d(2))
planes = [Plane3f(Point3f(0.5), Vec3f(-0.5))]
@test Makie.apply_clipping_planes(planes, bbox) == bbox

planes = [Plane3f(Point3f(0, 0, 0.5), Vec3f(-0.0, -0.0, -0.5))]
@test Makie.apply_clipping_planes(planes, bbox) == Rect3d(Point3d(-1), Vec3d(2,2,1.5))

planes = Makie.planes(Rect3f(Point3f(-0.5), Vec3f(1)))
bb = Makie.apply_clipping_planes(planes, bbox)
@test minimum(bb) Vec3f(-0.5)
Expand All @@ -138,7 +143,7 @@ using Makie: Plane, Plane3f, Point3d, Rect3d, Vec3d
ps = [2f0 .* rand(Point3f) .- 1f0 for _ in 1:1000]
planes = Makie.planes(Rect3f(Point3f(-0.5), Vec3f(1)))
inside = sum(Makie.is_visible.((planes,), ps))

# COV_EXCL_START
f, a, p = scatter(ps)
Makie.update_state_before_display!(f)
Expand Down
Loading