Add zooming & translation controls to Axis3

CHANGELOG.md

@@ -13,7 +13,8 @@
   - Renamed `Tesselation/tesselation` to `Tessellation/tessellation` [GeometryBasics#227](https://github.com/JuliaGeometry/GeometryBasics.jl/pull/227) [#4564](https://github.com/MakieOrg/Makie.jl/pull/4564)
 - Added `Makie.mesh` option for `MetaMesh` which applies some of the bundled information [#4368](https://github.com/MakieOrg/Makie.jl/pull/4368), [#4496](https://github.com/MakieOrg/Makie.jl/pull/4496)
 - `Voronoiplot`s automatic colors are now defined based on the underlying point set instead of only those generators appearing in the tessellation. This makes the selected colors consistent between tessellations when generators might have been deleted or added. [#4357](https://github.com/MakieOrg/Makie.jl/pull/4357)
-- Split `marker_offset` handling from marker centering and fix various bugs with it [#4594](https://github.com/MakieOrg/Makie.jl/pull/4594).
+- Added `viewmode = :free` and translation, zoom, limit reset and cursor-focus interactions to Axis3. [4131](https://github.com/MakieOrg/Makie.jl/pull/4131)
+- Split `marker_offset` handling from marker centering and fix various bugs with it [#4594](https://github.com/MakieOrg/Makie.jl/pull/4594)
 - Added `transform_marker` attribute to meshscatter and changed the default behavior to not transform marker/mesh vertices [#4606](https://github.com/MakieOrg/Makie.jl/pull/4606)
 - Fixed some issues with meshscatter not correctly transforming with transform functions and float32 rescaling [#4606](https://github.com/MakieOrg/Makie.jl/pull/4606)
 

CairoMakie/src/primitives.jl

@@ -579,15 +579,15 @@ function draw_glyph_collection(
         # TODO: f32convert may run into issues here if markerspace is :data or
         #       :transformed (repeated application in glyphpos etc)
         transform_func = transformation.transform_func[]
-        p = apply_transform(transform_func, position, space)
+        transformed = apply_transform(transform_func, position, space)
+        p = model * to_ndim(Point4d, to_ndim(Point3d, transformed, 0), 1)
 
         Makie.is_data_space(space) && is_clipped(clip_planes, p) && return
 
         Makie.clip_to_space(scene.camera, markerspace) *
         Makie.space_to_clip(scene.camera, space) *
         Makie.f32_convert_matrix(scene.float32convert, space) *
-        model *
-        to_ndim(Point4d, to_ndim(Point3d, p, 0), 1)
+        p
     end
 
     Cairo.save(ctx)

ReferenceTests/src/tests/figures_and_makielayout.jl

@@ -306,6 +306,48 @@ end
     f
 end
 
+@reference_test "Axis3 viewmodes, xreversed, aspect, perspectiveness" begin
+    fig = Figure(size = (800, 1200))
+
+    protrusions = (40, 30, 20, 10)
+    perspectiveness = Observable(0.0)
+    cat = GeometryBasics.expand_faceviews(load(Makie.assetpath("cat.obj")))
+    cs = 1:length(Makie.coordinates(cat))
+
+    for (bx, by, viewmode) in [(1,1,:fit), (1,2,:fitzoom), (2,1,:free), (2,2,:stretch)]
+        gl = GridLayout(fig[by, bx])
+        Label(gl[0, 1:2], "viewmode = :$viewmode")
+        for (x, rev) in enumerate((true, false))
+            for (y, aspect) in enumerate((:data, :equal, (1.2, 0.8, 1.0)))
+                ax = Axis3(gl[y, x], viewmode = viewmode, xreversed = rev, aspect = aspect,
+                    protrusions = protrusions, perspectiveness = perspectiveness)
+                mesh!(ax, cat, color = cs)
+
+                # for debug purposes
+                # layout area
+                fullarea = lift(ax.layoutobservables.computedbbox, ax.layoutobservables.protrusions) do bbox, prot
+                    mini = minimum(bbox) - Vec2(prot.left, prot.bottom)
+                    maxi = maximum(bbox) + Vec2(prot.right, prot.top)
+                    return Rect2f(mini, maxi - mini)
+                end
+                p = poly!(fig.scene, fullarea, color = RGBf(1, 0.8, 0.6), strokecolor = :red, strokewidth = 1.5)
+                translate!(p, 0, 0, -10_000)
+                # axis area = layout area - protrusions
+                p = poly!(fig.scene, ax.layoutobservables.computedbbox, color = RGBf(0.8, 0.9, 1), strokecolor = :blue, strokewidth = 1.5, linestyle = :dash)
+                translate!(p, 0, 0, -10_000)
+            end
+        end
+    end
+
+    fig
+
+    st = Stepper(fig)
+    Makie.step!(st)
+
+    perspectiveness[] = 1.0
+    Makie.step!(st)
+end
+
 @reference_test "Colorbar for recipes" begin
     fig, ax, pl = barplot(1:3; color=1:3, colormap=Makie.Categorical(:viridis), figure=(;size=(800, 800)))
     Colorbar(fig[1, 2], pl; size=100)
@@ -459,31 +501,31 @@ end
 @reference_test "Button - Slider - Toggle - Textbox" begin
     f = Figure(size = (500, 250))
     Makie.Button(f[1, 1:2])
-    Makie.Button(f[2, 1:2], buttoncolor = :orange, cornerradius = 20, 
+    Makie.Button(f[2, 1:2], buttoncolor = :orange, cornerradius = 20,
         strokecolor = :red, strokewidth = 2, # TODO: allocate space for this
         fontsize = 16, labelcolor = :blue)
 
     IntervalSlider(f[1, 3])
-    sl = IntervalSlider(f[2, 3], range = 0:100, linewidth = 20, 
+    sl = IntervalSlider(f[2, 3], range = 0:100, linewidth = 20,
         color_inactive = :orange, color_active_dimmed = :lightgreen)
     Makie.set_close_to!(sl, 30, 70)
 
     Toggle(f[3, 1])
     Toggle(f[4, 1], framecolor_inactive = :lightblue, rimfraction = 0.6)
     Toggle(f[3, 2], active = true)
-    Toggle(f[4, 2], active = true, framecolor_inactive = :lightblue, 
+    Toggle(f[4, 2], active = true, framecolor_inactive = :lightblue,
         framecolor_active = :yellow, rimfraction = 0.6)
 
     Makie.Slider(f[3, 3])
-    sl = Makie.Slider(f[4, 3], range = 0:100, linewidth = 20, color_inactive = :cyan, 
+    sl = Makie.Slider(f[4, 3], range = 0:100, linewidth = 20, color_inactive = :cyan,
         color_active_dimmed = :lightgreen)
     Makie.set_close_to!(sl, 30)
 
     gl = GridLayout(f[5, 1:3])
     Textbox(gl[1, 1])
-    Textbox(gl[1, 2], bordercolor = :red, cornerradius = 0, 
+    Textbox(gl[1, 2], bordercolor = :red, cornerradius = 0,
         placeholder = "test string", fontsize = 16, textcolor_placeholder = :blue)
-    tb = Textbox(gl[1, 3], bordercolor = :black, cornerradius = 20, 
+    tb = Textbox(gl[1, 3], bordercolor = :black, cornerradius = 20,
         fontsize =10, textcolor = :red, boxcolor = :lightblue)
     Makie.set!(tb, "some string")
 

docs/src/reference/blocks/axis3.md

@@ -1,5 +1,64 @@
 # Axis3
 
+## Axis3 interactions
+
+Like Axis, Axis3 has a few predefined interactions enabled.
+
+### Rotation
+
+You can rotate the view by left-clicking and dragging.
+This interaction is registered as `:dragrotate` and uses the `DragRotate` type.
+
+### Zoom
+
+You can zoom in an axis by scrolling in and out.
+By default, the zoom is focused on the center of the Axis.
+You can set `zoommode = :cursor` to focus the zoom on the cursor instead.
+If you press `x`, `y` or `z` while scrolling, the zoom is restricted to that dimension.
+If you press two keys simultaneously, the zoom will be restricted to the corresponding plane instead.
+These keys can be changed with the attributes `xzoomkey`, `yzoomkey` and `zzoomkey`.
+You can also restrict the zoom dimensions all the time by setting the axis attributes `xzoomlock`, `yzoomlock` or `zzoomlock` to `true`.
+
+With `viewmode = :free` the behavior of the zoom changes.
+Instead of affecting just the content of the axis, zooming affects the axis as a whole.
+It also disables `zoommode = :cursor`.
+This interaction is registered as `:scrollzoom` and uses the `ScrollZoom` type.
+
+### Translation
+
+You can translate the view of the Axis3 by right-clicking and dragging.
+If you press `x`, `y` or `z` while translating, the translation is restricted to that dimension.
+If you press two keys simultaneously, the translation will be restricted to the corresponding plane instead.
+These keys can be changed with the attributes `xtranslationkey`, `ytranslationkey` and `ztranslationkey`.
+You can also restrict the translation all the time by setting the axis attributes `xtranslationlock`, `ytranslationlock` or `ztranslationlock` to `true`.
+
+With `viewmode = :free` another option for translation is added.
+By pressing `control` while right-click dragging, the translation will affect the placement of the axis in the window instead of the content within the axis.
+This interaction is registered as `:translation` and uses the `DragPan` type.
+
+### Limit reset
+
+You can reset the limits, i.e. zoom and translation with `ctrl + left click`.
+This is the same as calling `reset_limits!(ax)`.
+It sets the limits back to the values stored in `ax.limits`.
+If they are `nothing` this computes automatic limits.
+If you have previously called `limits!`, `xlims!`, `ylims!` or `zlims!` then `ax.limits` will be set and kept by this interaction.
+You can reset the rotation of the axis with `shift + left click`.
+If `viewmode = :free` this will also reset the translation of the axis (not just of the content).
+If you trigger both simultaneously, i.e. press `ctrl + shift + leftclick`, the axis will be fully reset.
+This includes `ax.limits` which are reset to `nothing` via `autolimits!(ax)`
+This interaction is registered as `:limitreset` and uses the `LimitReset` type.
+
+### Center on point
+
+You can center the axis on your cursor with `alt + left click`.
+Note that depending on the plot type, this may mean different things.
+For most, a point on the surface of the plot is used.
+For `meshscatter`, `scatter` and derived plots the position of the scattered mesh/marker is used.
+This interaction is registered as `:cursorfocus` and uses the `FocusOnCursor` type.
+
+
+
 ## Attributes
 
 ```@attrdocs

src/camera/projection_math.jl

@@ -130,6 +130,9 @@ from `eyeposition` to `lookat` will be used.  All inputs must be
 supplied as 3-vectors.
 """
 function lookat(eyePos::Vec{3, T}, lookAt::Vec{3, T}, up::Vec{3, T}) where T
+    return lookat_basis(eyePos, lookAt, up) * translationmatrix(-eyePos)
+end
+function lookat_basis(eyePos::Vec{3, T}, lookAt::Vec{3, T}, up::Vec{3, T}) where T
     zaxis  = normalize(eyePos-lookAt)
     xaxis  = normalize(cross(up,    zaxis))
     yaxis  = normalize(cross(zaxis, xaxis))
@@ -139,7 +142,7 @@ function lookat(eyePos::Vec{3, T}, lookAt::Vec{3, T}, up::Vec{3, T}) where T
         xaxis[2], yaxis[2], zaxis[2], T0,
         xaxis[3], yaxis[3], zaxis[3], T0,
         T0,       T0,       T0,       T1
-    ) * translationmatrix(-eyePos)
+    )
 end
 
 function lookat(::Type{T}, eyePos::Vec{3}, lookAt::Vec{3}, up::Vec{3}) where T
@@ -240,8 +243,8 @@ end
 
 Decomposes a transformation matrix into a translation vector, scale vector and
 rotation Quaternion. Note that this is only valid for a transformation matrix
-created with matching order, i.e. 
-`transform = translation_matrix * scale_matrix * rotation_matrix`. The model 
+created with matching order, i.e.
+`transform = translation_matrix * scale_matrix * rotation_matrix`. The model
 matrix created by `Transformation` is one such matrix.
 """
 function decompose_translation_scale_rotation_matrix(model::Mat4{T}) where T
@@ -285,9 +288,9 @@ end
 """
     decompose_translation_scale_matrix(transform::Mat4)
 
-Like `decompose_translation_scale_rotation_matrix(transform)` but skips the 
+Like `decompose_translation_scale_rotation_matrix(transform)` but skips the
 extraction of the rotation component. This still works if a rotation is involved
-and requires the same order of operations, i.e. 
+and requires the same order of operations, i.e.
 `transform = translation_matrix * scale_matrix * rotation_matrix`.
 """
 function decompose_translation_scale_matrix(model::Mat4{T}) where T
@@ -390,7 +393,7 @@ function project(proj_view::Mat4{T1}, resolution::Vec2, point::Point{N, T2}) whe
     # at this point the visible range is strictly -1..1 so FLoat64 doesn't matter
     p = (clip ./ clip[4])[Vec(1, 2)]
     p = Vec2{T}(p[1], p[2])
-    return (0.5 .* (p .+ 1) .* (resolution .- 1)) .+ 1
+    return 0.5 .* (p .+ 1) .* resolution
 end
 
 # TODO: consider warning here to discourage risky functions

src/interaction/events.jl

@@ -303,4 +303,4 @@ ispressed(e::Events, op::Exclusively, waspressed = nothing) = op.x == union(e.ke
 # collections
 ispressed(parent, set::Set, waspressed = nothing) = all(x -> ispressed(parent, x, waspressed), set)
 ispressed(parent, set::Vector, waspressed = nothing) = all(x -> ispressed(parent, x, waspressed), set)
-ispressed(parent, set::Tuple, waspressed = nothing) = all(x -> ispressed(parent, x, waspressed), set)
+ispressed(parent, set::Tuple, waspressed = nothing) = all(x -> ispressed(parent, x, waspressed), set)

src/interaction/ray_casting.jl

@@ -207,6 +207,23 @@ function is_point_on_ray(p::Point3{T1}, ray::Ray{T2}) where {T1 <: Real, T2 <: R
 end
 
 
+function ray_plane_intersection(plane::Plane3{T1}, ray::Ray{T2}, epsilon = 1e-6) where {T1 <: Real, T2 <: Real}
+    # --- p ---   plane with normal (assumed normalized)
+    #     ↓
+    #     :  distance d along plane normal direction
+    #   ↖ :
+    #     r       ray with direction (assumed normalized)
+
+    d = distance(plane, ray.origin) # signed distance
+    cos_angle = dot(-plane.normal, ray.direction)
+
+    if abs(cos_angle) > epsilon
+        return ray.origin + d / cos_angle * ray.direction
+    else
+        return Point3f(NaN)
+    end
+end
+
 ################################################################################
 ### Ray casting (positions from ray-plot intersections)
 ################################################################################
@@ -287,15 +304,15 @@ function position_on_plot(plot::Union{Lines, LineSegments}, idx, ray::Ray; apply
     p0, p1 = apply_transform_and_model(plot, plot[1][][(idx-1):idx])
 
     pos = closest_point_on_line(f32_convert(plot, p0), f32_convert(plot, p1), ray)
-    
+
     if apply_transform
         return inv_f32_convert(plot, Point3d(pos))
     else
         p4d = inv(plot.model[]) * to_ndim(Point4d, inv_f32_convert(plot, Point3d(pos)), 1)
         p3d = p4d[Vec(1, 2, 3)] / p4d[4]
         itf = inverse_transform(transform_func(plot))
         out = Makie.apply_transform(itf, p3d, to_value(get(plot, :space, :data)))
-        return out 
+        return out
     end
 end
 
@@ -321,7 +338,7 @@ function position_on_plot(plot::Union{Heatmap, Image}, idx, ray::Ray; apply_tran
 end
 
 function position_on_plot(plot::Mesh, idx, ray::Ray; apply_transform = true)
-    positions = decompose(Point3, plot.mesh[])
+    positions = decompose(Point3d, plot.mesh[])
     ray = transform(inv(plot.model[]), inv_f32_convert(plot, ray))
     tf = transform_func(plot)
     space = to_value(get(plot, :space, :data))
@@ -418,7 +435,7 @@ function position_on_plot(plot::Volume, idx, ray::Ray; apply_transform = true)
     tf = transform_func(plot)
 
     if tf === nothing
-        
+
         ray = transform(inv(plot.model[]), ray)
         pos = ray_rect_intersection(Rect3(min, max .- min), ray)
         if apply_transform
@@ -433,7 +450,7 @@ function position_on_plot(plot::Volume, idx, ray::Ray; apply_transform = true)
         w = max - min
         ps = Point3d[min + (x, y, z) .* w for x in (0, 1) for y in (0, 1) for z in (0, 1)]
         fs = decompose(GLTriangleFace, QuadFace{Int}[
-            (1, 2, 4, 3), (7, 8, 6, 5), (5, 6, 2, 1), 
+            (1, 2, 4, 3), (7, 8, 6, 5), (5, 6, 2, 1),
             (3, 4, 8, 7), (1, 3, 7, 5), (6, 8, 4, 2)
         ])