GUI: plot label ranges as circumcircles

shawnlaffan · shawnlaffan · commit ec5e1f3431a8 · 2025-12-31T18:11:30.000+11:00
Off by default, same as for the convex hulls.
diff --git a/lib/Biodiverse/GUI/Canvas/Grid.pm b/lib/Biodiverse/GUI/Canvas/Grid.pm
@@ -42,15 +42,24 @@ sub new {
     $self->init_legend(%args, parent => $self);
 
     $self->{callbacks} = {
-        map        => sub {shift->draw_cells_cb(@_)},
-        highlights => sub {shift->plot_highlights(@_)},
-        overlays   => sub {shift->_bounding_box_page_units(@_)},
-        underlays  => sub {},
-        legend     => sub {shift->get_legend->draw(@_)},
-        sel_rect   => sub {shift->draw_selection_rect (@_)},
-        range_outlines => undef,
+        map                 => sub {shift->draw_cells_cb(@_)},
+        highlights          => sub {shift->plot_highlights(@_)},
+        overlays            => sub {shift->_bounding_box_page_units(@_)},
+        underlays           => sub {},
+        legend              => sub {shift->get_legend->draw(@_)},
+        sel_rect            => sub {shift->draw_selection_rect(@_)},
+        range_convex_hulls  => undef,
+        range_circumcircles => undef,
     };
-    $self->{callback_order} = [qw /underlays map overlays legend range_outlines highlights sel_rect/];
+    $self->{callback_order} = [qw /
+        underlays
+        map
+        overlays
+        legend
+        range_convex_hulls
+        range_circumcircles
+        highlights sel_rect
+    /];
 
     return $self;
 }
@@ -629,10 +638,19 @@ sub plot_highlights {
     return FALSE;
 }
 
-sub clear_range_outlines {
+sub clear_range_convex_hulls {
     my $self = shift;
     $self->set_overlay(
-        cb_target   => 'range_outlines',
+        cb_target   => 'range_convex_hulls',
+        plot_on_top => 1,
+        data        => undef,
+    );
+}
+
+sub clear_range_circumcircles {
+    my $self = shift;
+    $self->set_overlay(
+        cb_target   => 'range_circumcircles',
         plot_on_top => 1,
         data        => undef,
     );
@@ -663,7 +681,19 @@ sub set_overlay {
     $linewidth ||= 1;
 
     my $cb;
-    if (is_blessed_ref ($data->[0])) {
+    if (is_blessed_ref ($data) && $data->isa('Biodiverse::Geometry::Circle')) {
+        $cb = sub {
+            my ($self, $cx) = @_;
+            $cx->set_matrix($self->{matrix});
+            $cx->set_source_rgba(@rgba);
+            #  line width should be an option in the GUI
+            $cx->set_line_width(max($cx->device_to_user_distance($linewidth, $linewidth)));
+            $cx->arc(@{$data->centre}, $data->radius, 0, 2.0 * PI);
+            $cx->close_path;
+            $cx->$stroke_or_fill;
+        }
+    }
+    elsif (is_blessed_ref ($data->[0])) {
         $cb = sub {
             my ($self, $cx) = @_;
             $cx->set_matrix($self->{matrix});
diff --git a/lib/Biodiverse/GUI/Tabs/Labels.pm b/lib/Biodiverse/GUI/Tabs/Labels.pm
@@ -399,6 +399,7 @@ sub get_tree_menu_items {
                qw /plot_branches_by
                    highlight_groups_on_map
                    highlight_groups_on_map_convex_hull
+                   highlight_groups_on_map_circumcircle
                    highlight_paths_on_tree
                    separator
                    background_colour
@@ -912,6 +913,25 @@ sub get_highlight_label_range_convex_hulls {
     $_[0]->{highlight_label_range_convex_hulls};
 }
 
+sub set_highlight_label_range_circumcircles {
+    my ($self, $value) = @_;
+
+    $self->{highlight_label_range_circumcircles} = !!$value;
+
+    return;
+}
+
+sub toggle_highlight_label_range_circumcircles {
+    my ($self, $value) = @_;
+
+    $self->{highlight_label_range_circumcircles}
+        = !$self->{highlight_label_range_circumcircles};
+}
+
+sub get_highlight_label_range_circumcircles {
+    $_[0]->{highlight_label_range_circumcircles};
+}
+
 sub highlight_label_range_convex_hulls {
     my ($self, $node) = @_;
 
@@ -923,7 +943,7 @@ sub highlight_label_range_convex_hulls {
     my $label_hash = $bd->get_labels_ref->get_element_hash;
 
     #  clear existing
-    $self->{grid}->clear_range_outlines;
+    $self->{grid}->clear_range_convex_hulls;
 
     my $cache = $bd->get_cached_value_dor_set_default_href('LABEL_RANGE_CONVEX_HULL_VERTICES');
 
@@ -934,7 +954,34 @@ sub highlight_label_range_convex_hulls {
             //= $bd->get_label_range_convex_hull(label => $label)->GetPoints(0, 0);
         $self->{grid}->set_overlay(
             type        => 'polyline',
-            cb_target   => 'range_outlines',
+            cb_target   => 'range_convex_hulls',
+            plot_on_top => 1,
+            data        => $data,
+            colour      => COLOUR_BLACK,
+            alpha       => 0.5,
+        );
+    }
+}
+
+sub highlight_label_range_circumcircles {
+    my ($self, $node) = @_;
+
+    return if !$self->get_highlight_label_range_circumcircles;
+
+    my $terminal_elements = $node->get_terminal_elements;
+
+    my $bd = $self->get_base_ref;
+    my $label_hash = $bd->get_labels_ref->get_element_hash;
+
+    #  clear existing
+    $self->{grid}->clear_range_circumcircles;
+
+    foreach my $label (keys %$terminal_elements) {
+        next LABEL if !exists $label_hash->{$label};
+        my $data = $bd->get_label_range_circumcircle(label => $label);
+        $self->{grid}->set_overlay(
+            type        => 'polyline',
+            cb_target   => 'range_circumcircles',
             plot_on_top => 1,
             data        => $data,
             colour      => COLOUR_BLACK,
@@ -1520,7 +1567,8 @@ sub on_end_phylogeny_hover {
 
     return if !$self->do_canvas_hover_flag;
 
-    $self->{grid}->clear_range_outlines;
+    $self->{grid}->clear_range_convex_hulls;
+    $self->{grid}->clear_range_circumcircles;
     $self->{grid}->mark_with_circles;
 }
 
@@ -1535,6 +1583,7 @@ sub on_phylogeny_highlight {
 
     $self->highlight_label_range_marks($node);
     $self->highlight_label_range_convex_hulls($node);
+    $self->highlight_label_range_circumcircles($node);
 
     if (defined $node) {
         my $text = 'Node: ' . $node->get_name;
diff --git a/lib/Biodiverse/GUI/Tabs/Spatial.pm b/lib/Biodiverse/GUI/Tabs/Spatial.pm
@@ -418,6 +418,7 @@ sub get_tree_menu_items {
                    separator
                    highlight_groups_on_map
                    highlight_groups_on_map_convex_hull
+                   highlight_groups_on_map_circumcircle
                    highlight_paths_on_tree
                    separator
                    plot_branches_by
@@ -1208,6 +1209,7 @@ sub on_phylogeny_highlight {
 
     $self->highlight_label_range_marks($node);
     $self->highlight_label_range_convex_hulls($node);
+    $self->highlight_label_range_circumcircles($node);
 
     return;
 }
diff --git a/lib/Biodiverse/GUI/Tabs/Tab.pm b/lib/Biodiverse/GUI/Tabs/Tab.pm
@@ -1332,6 +1332,21 @@ EOT
                 $self->get_highlight_label_range_convex_hulls;
             },
         },
+        highlight_groups_on_map_circumcircle => {
+            type     => 'Gtk3::CheckMenuItem',
+            label    => 'Highlight groups on map with range circumcircles',
+            tooltip  => 'When hovering the mouse over a tree branch, '
+                . 'plot a circumcircle containing the range of each subtending label.',
+            event    => 'toggled',
+            callback => sub {
+                my ($self, $widget) = @_;
+                $self->set_highlight_label_range_circumcircles($widget->get_active);
+            },
+            active   => sub {
+                my ($self) = @_;
+                $self->get_highlight_label_range_circumcircles;
+            },
+        },
         highlight_paths_on_tree => {
             type     => 'Gtk3::CheckMenuItem',
             label    => 'Highlight paths on tree',
