[Summary] Just adding comment for better code-maintaining.
[ardour.git] / gtk2_ardour / ardour_button.cc
index ee4f3af5f27f30e5369d26b9b1d95ab9b0a215de..c06c3629a5b4d44076aea68fbca99983e169fde4 100644 (file)
@@ -59,7 +59,7 @@ ArdourButton::Element ArdourButton::just_led_default_elements = ArdourButton::El
 
 ArdourButton::ArdourButton (Element e)
        : _elements (e)
-       , _icon (ArdourButton::NoIcon)
+       , _icon (Gtkmm2ext::ArdourIcon::NoIcon)
        , _tweaks (Tweaks (0))
        , _char_pixel_width (0)
        , _char_pixel_height (0)
@@ -193,12 +193,24 @@ ArdourButton::set_alignment (const float xa, const float ya)
        _yalign = ya;
 }
 
+
+/* TODO make this a dedicated function elsewhere.
+ *
+ * Option 1:
+ * virtual ArdourButton::render_vector_icon() 
+ * ArdourIconButton::render_vector_icon
+ *
+ * Option 2:
+ * ARDOUR_UI_UTILS::render_vector_icon()
+ */
 void
 ArdourButton::render (cairo_t* cr, cairo_rectangle_t *)
 {
        uint32_t text_color;
        uint32_t led_color;
 
+       const float corner_radius = std::max(2.f, _corner_radius * ARDOUR_UI::ui_scale);
+
        if (_update_colors) {
                set_colors ();
        }
@@ -239,14 +251,14 @@ ArdourButton::render (cairo_t* cr, cairo_rectangle_t *)
 
        // draw edge (filling a rect underneath, rather than stroking a border on top, allows the corners to be lighter-weight.
        if ((_elements & (Body|Edge)) == (Body|Edge)) {
-               rounded_function (cr, 0, 0, get_width(), get_height(), _corner_radius + 1.5);
+               rounded_function (cr, 0, 0, get_width(), get_height(), corner_radius + 1.5);
                cairo_set_source_rgba (cr, 0, 0, 0, 1);
                cairo_fill(cr);
        }
 
        // background fill
        if ((_elements & Body)==Body) {
-               rounded_function (cr, 1, 1, get_width() - 2, get_height() - 2, _corner_radius);
+               rounded_function (cr, 1, 1, get_width() - 2, get_height() - 2, corner_radius);
                if (active_state() == Gtkmm2ext::ImplicitActive && !((_elements & Indicator)==Indicator)) {
                        ArdourCanvas::set_source_rgba (cr, fill_inactive_color);
                        cairo_fill (cr);
@@ -265,7 +277,7 @@ ArdourButton::render (cairo_t* cr, cairo_rectangle_t *)
        if ((_elements & Body)==Body) {
                if (active_state() == Gtkmm2ext::ImplicitActive && !((_elements & Indicator)==Indicator)) {
                        cairo_set_line_width (cr, 2.0);
-                       rounded_function (cr, 2, 2, get_width() - 4, get_height() - 4, _corner_radius-0.5);
+                       rounded_function (cr, 2, 2, get_width() - 4, get_height() - 4, corner_radius-0.5);
                        ArdourCanvas::set_source_rgba (cr, fill_active_color);
                        cairo_stroke (cr);
                }
@@ -276,22 +288,15 @@ ArdourButton::render (cairo_t* cr, cairo_rectangle_t *)
                if ( active_state() == Gtkmm2ext::ExplicitActive && ( !((_elements & Indicator)==Indicator) || use_custom_led_color) ) {
                        //concave
                        cairo_set_source (cr, concave_pattern);
-                       Gtkmm2ext::rounded_rectangle (cr, 1, 1, get_width() - 2, get_height() - 2, _corner_radius);
+                       Gtkmm2ext::rounded_rectangle (cr, 1, 1, get_width() - 2, get_height() - 2, corner_radius);
                        cairo_fill (cr);
                } else {
                        cairo_set_source (cr, convex_pattern);
-                       Gtkmm2ext::rounded_rectangle (cr, 1, 1, get_width() - 2, get_height() - 2, _corner_radius);
+                       Gtkmm2ext::rounded_rectangle (cr, 1, 1, get_width() - 2, get_height() - 2, corner_radius);
                        cairo_fill (cr);
                }
        }
 
-#define VECTORICONSTROKEFILL \
-       cairo_set_line_width(cr, 1.5); \
-       cairo_set_source_rgba (cr, 0, 0, 0, 1.0); \
-       cairo_stroke_preserve(cr); \
-       cairo_set_source_rgba (cr, 1, 1, 1, 1.0); \
-       cairo_fill(cr);
-
        //Pixbuf, if any
        if (_pixbuf) {
                double x = rint((get_width() - _pixbuf->get_width()) * .5);
@@ -313,228 +318,9 @@ ArdourButton::render (cairo_t* cr, cairo_rectangle_t *)
                gdk_cairo_set_source_pixbuf (cr, _pixbuf->gobj(), x, y);
                cairo_fill (cr);
        }
-       else // rec-en is exclusive to pixbuf (tape machine mode, rec-en)
-       if ((_elements & VectorIcon) && _icon == RecTapeMode) {
-               const double x = get_width() * .5;
-               const double y = get_height() * .5;
-               const double r = std::min(10., std::min(x, y) * .6); // TODO we need a better way to limit max. radius.
-               const double slit = .11 * M_PI;
-               cairo_save(cr);
-               cairo_translate(cr, x, y);
-
-               cairo_arc (cr, 0, 0, r, 0, 2 * M_PI);
-               if (active_state() == Gtkmm2ext::ExplicitActive)
-                       cairo_set_source_rgba (cr, .95, .1, .1, 1.);
-               else
-                       cairo_set_source_rgba (cr, .95, .44, .44, 1.); // #f46f6f
-               cairo_fill_preserve(cr);
-               cairo_set_source_rgba (cr, .0, .0, .0, .5);
-               cairo_set_line_width(cr, 1);
-               cairo_stroke(cr);
-
-               cairo_save(cr);
-               cairo_set_source_rgba (cr, .15, .07, .07, 1.0);
-
-               cairo_rotate (cr, -.5 * M_PI);
-               cairo_move_to(cr, 0, 0);
-               cairo_arc (cr, 0, 0, r *.85, -slit, slit);
-               cairo_line_to(cr, 0, 0);
-               cairo_close_path(cr);
-
-               cairo_fill(cr);
-               cairo_rotate (cr, 2. * M_PI / 3.);
-
-               cairo_move_to(cr, 0, 0);
-               cairo_arc (cr, 0, 0, r *.85, -slit, slit);
-               cairo_line_to(cr, 0, 0);
-               cairo_close_path(cr);
-               cairo_fill(cr);
-
-               cairo_rotate (cr, 2. * M_PI / 3.);
-               cairo_move_to(cr, 0, 0);
-               cairo_arc (cr, 0, 0, r *.85, -slit, slit);
-               cairo_line_to(cr, 0, 0);
-               cairo_close_path(cr);
-               cairo_fill(cr);
-
-               cairo_restore(cr);
-
-               cairo_arc (cr, 0, 0, r * .3, 0, 2 * M_PI);
-               if (active_state() == Gtkmm2ext::ExplicitActive)
-                       cairo_set_source_rgba (cr, .95, .1, .1, 1.);
-               else
-                       cairo_set_source_rgba (cr, .95, .44, .44, 1.); // #f46f6f
-               cairo_fill(cr);
-               cairo_set_source_rgba (cr, .0, .0, .0, 1.0);
-               cairo_arc (cr, 0, 0, r *.15, 0, 2 * M_PI); // hole in the middle
-               cairo_fill(cr);
-
-               cairo_restore(cr);
-       }
-       else if ((_elements & VectorIcon) && _icon == RecButton) {
-               const double x = get_width() * .5;
-               const double y = get_height() * .5;
-               const double r = std::min(10., std::min(x, y) * .55); // TODO we need a better way to limit max. radius.
-               cairo_arc (cr, x, y, r, 0, 2 * M_PI);
-               if (active_state() == Gtkmm2ext::ExplicitActive)
-                       cairo_set_source_rgba (cr, .95, .1, .1, 1.);
-               else
-                       cairo_set_source_rgba (cr, .95, .44, .44, 1.); // #f46f6f
-               cairo_fill_preserve(cr);
-               cairo_set_source_rgba (cr, .0, .0, .0, .8);
-               cairo_set_line_width(cr, 1);
-               cairo_stroke(cr);
-       }
-       else if ((_elements & VectorIcon) && _icon == CloseCross) {
-               const double x = get_width() * .5;
-               const double y = get_height() * .5;
-               const double o = .5 + std::min(x, y) * .4;
-               ArdourCanvas::set_source_rgba (cr, text_color);
-               cairo_set_line_width(cr, 1);
-               cairo_move_to(cr, x-o, y-o);
-               cairo_line_to(cr, x+o, y+o);
-               cairo_move_to(cr, x+o, y-o);
-               cairo_line_to(cr, x-o, y+o);
-               cairo_stroke(cr);
-       }
-       else if ((_elements & VectorIcon) && _icon == StripWidth) {
-               const double x0 = get_width()  * .2;
-               const double x1 = get_width()  * .8;
-
-               const double y0 = get_height() * .25;
-               const double y1= get_height()  * .75;
-
-               const double ym= get_height()  * .5;
-
-               // arrow
-               const double xa0= get_height()  * .39;
-               const double xa1= get_height()  * .61;
-               const double ya0= get_height()  * .35;
-               const double ya1= get_height()  * .65;
-
-               ArdourCanvas::set_source_rgba (cr, text_color);
-               cairo_set_line_width(cr, 1);
-
-               // left + right
-               cairo_move_to(cr, x0, y0);
-               cairo_line_to(cr, x0, y1);
-               cairo_move_to(cr, x1, y0);
-               cairo_line_to(cr, x1, y1);
-
-               // horiz center line
-               cairo_move_to(cr, x0, ym);
-               cairo_line_to(cr, x1, ym);
-
-               // arrow left
-               cairo_move_to(cr,  x0, ym);
-               cairo_line_to(cr, xa0, ya0);
-               cairo_move_to(cr,  x0, ym);
-               cairo_line_to(cr, xa0, ya1);
-
-               // arrow right
-               cairo_move_to(cr,  x1,  ym);
-               cairo_line_to(cr, xa1, ya0);
-               cairo_move_to(cr,  x1,  ym);
-               cairo_line_to(cr, xa1, ya1);
-               cairo_stroke(cr);
-       }
-       else if ((_elements & VectorIcon) && _icon == DinMidi) {
-               const double x = get_width() * .5;
-               const double y = get_height() * .5;
-               const double r = std::min(x, y) * .75;
-               ArdourCanvas::set_source_rgba (cr, text_color);
-               cairo_set_line_width(cr, 1);
-               cairo_arc (cr, x, y, r, 0, 2 * M_PI);
-               cairo_stroke(cr);
-
-               // pins equally spaced 45deg
-               cairo_arc (cr, x, y * 0.5, r * .15, 0, 2 * M_PI);
-               cairo_fill(cr);
-               cairo_arc (cr, x * 0.5, y, r * .15, 0, 2 * M_PI);
-               cairo_fill(cr);
-               cairo_arc (cr, x * 1.5, y, r * .15, 0, 2 * M_PI);
-               cairo_fill(cr);
-               //  .5 + .5 * .5 * sin(45deg),  1.5 - .5 * .5 * cos(45deg)
-               cairo_arc (cr, x * 0.677, y * .677, r * .15, 0, 2 * M_PI);
-               cairo_fill(cr);
-               cairo_arc (cr, x * 1.323, y * .677, r * .15, 0, 2 * M_PI);
-               cairo_fill(cr);
-
-               // bottom notch
-               cairo_arc (cr, x, y+r, r * .28, 1.05 * M_PI, 1.95 * M_PI);
-               cairo_stroke(cr);
-       }
-       else if ((_elements & VectorIcon) && _icon == BtnStop) {
-               const int wh = std::min (get_width(), get_height());
-               cairo_rectangle (cr,
-                               (get_width() - wh) * .5 + wh * .25,
-                               (get_height() - wh) * .5 + wh * .25,
-                               wh * .5, wh * .5);
-
-               VECTORICONSTROKEFILL;
-       }
-       else if ((_elements & VectorIcon) && _icon == BtnPlay) {
-               const int wh = std::min (get_width(), get_height()) * .5;
-               const double y = get_height() * .5;
-               const double x = get_width() - wh;
-
-               const float tri = ceil(.577 * wh); // 1/sqrt(3)
-
-               cairo_move_to (cr,  x + wh * .5, y);
-               cairo_line_to (cr,  x - wh * .5, y - tri);
-               cairo_line_to (cr,  x - wh * .5, y + tri);
-               cairo_close_path (cr);
-
-               VECTORICONSTROKEFILL;
-       }
-       else if ((_elements & VectorIcon) && _icon == BtnPanic) {
-               const int wh = std::min (get_width(), get_height()) * .1;
-               const double xc = get_width() * .5;
-               const double yh = get_height();
-               cairo_rectangle (cr,
-                               xc - wh, yh *.2,
-                               wh * 2,  yh *.4);
-               VECTORICONSTROKEFILL;
-
-               cairo_arc (cr, xc, yh *.75, wh, 0, 2 * M_PI);
-               VECTORICONSTROKEFILL;
-       }
-       else if ((_elements & VectorIcon) && (_icon == BtnStart || _icon == BtnEnd || _icon == BtnRange)) {
-               // small play triangle
-               int wh = std::min (get_width(), get_height());
-               const double y = get_height() * .5;
-               const double x = get_width() - wh * .5;
-               wh *= .18;
-               const float tri = ceil(.577 * wh * 2); // 1/sqrt(3)
-
-               const int ln = std::min (get_width(), get_height()) * .07;
-
-               if (_icon == BtnStart || _icon == BtnRange) {
-                       cairo_rectangle (cr,
-                                       x - wh - ln, y  - tri * 1.7,
-                                       ln * 2,  tri * 3.4);
-
-                       VECTORICONSTROKEFILL;
-               }
-
-               if (_icon == BtnEnd || _icon == BtnRange) {
-                       cairo_rectangle (cr,
-                                       x + wh - ln, y  - tri * 1.7,
-                                       ln * 2,  tri * 3.4);
-
-                       VECTORICONSTROKEFILL;
-               }
-
-               cairo_move_to (cr,  x + wh, y);
-               cairo_line_to (cr,  x - wh, y - tri);
-               cairo_line_to (cr,  x - wh, y + tri);
-               cairo_close_path (cr);
-
-               VECTORICONSTROKEFILL;
-       }
-       else if (_elements & VectorIcon) {
-               // missing icon
-               assert(0);
+       else /* VectorIcons are exclusive to Pixbuf Icons */
+       if (_elements & VectorIcon) {
+               Gtkmm2ext::ArdourIcon::render (cr, _icon, get_width(), get_height(), active_state(), text_color);
        }
 
        const int text_margin = char_pixel_width();
@@ -655,12 +441,12 @@ ArdourButton::render (cairo_t* cr, cairo_rectangle_t *)
 
                //black ring
                cairo_set_source_rgb (cr, 0, 0, 0);
-               cairo_arc (cr, 0, 0, _diameter * .5 - 1, 0, 2 * M_PI);
+               cairo_arc (cr, 0, 0, _diameter * .5 - 1 * ARDOUR_UI::ui_scale, 0, 2 * M_PI);
                cairo_fill(cr);
 
                //led color
                ArdourCanvas::set_source_rgba (cr, led_color);
-               cairo_arc (cr, 0, 0, _diameter * .5 - 3, 0, 2 * M_PI);
+               cairo_arc (cr, 0, 0, _diameter * .5 - 3 * ARDOUR_UI::ui_scale, 0, 2 * M_PI);
                cairo_fill(cr);
 
                cairo_restore (cr);
@@ -668,7 +454,7 @@ ArdourButton::render (cairo_t* cr, cairo_rectangle_t *)
 
        // a transparent overlay to indicate insensitivity
        if ((visual_state() & Gtkmm2ext::Insensitive)) {
-               rounded_function (cr, 0, 0, get_width(), get_height(), _corner_radius);
+               rounded_function (cr, 0, 0, get_width(), get_height(), corner_radius);
                uint32_t ins_color = ARDOUR_UI::config()->color ("gtk_background");
                ArdourCanvas::set_source_rgb_a (cr, ins_color, 0.6);
                cairo_fill (cr);
@@ -678,7 +464,7 @@ ArdourButton::render (cairo_t* cr, cairo_rectangle_t *)
        if (ARDOUR_UI::config()->get_widget_prelight()
                        && !((visual_state() & Gtkmm2ext::Insensitive))) {
                if (_hovering) {
-                       rounded_function (cr, 1, 1, get_width() - 2, get_height() - 2, _corner_radius);
+                       rounded_function (cr, 1, 1, get_width() - 2, get_height() - 2, corner_radius);
                        cairo_set_source_rgba (cr, 0.905, 0.917, 0.925, 0.2);
                        cairo_fill (cr);
                }
@@ -686,7 +472,7 @@ ArdourButton::render (cairo_t* cr, cairo_rectangle_t *)
 
        //user is currently pressing the button. dark outline helps to indicate this
        if (_grabbed && !(_elements & (Inactive|Menu))) {
-               rounded_function (cr, 1, 1, get_width() - 2, get_height() - 2, _corner_radius);
+               rounded_function (cr, 1, 1, get_width() - 2, get_height() - 2, corner_radius);
                cairo_set_line_width(cr, 2);
                cairo_set_source_rgba (cr, 0.1, 0.1, 0.1, .5);
                cairo_stroke (cr);
@@ -696,7 +482,7 @@ ArdourButton::render (cairo_t* cr, cairo_rectangle_t *)
        if (visual_state() & Gtkmm2ext::Selected) {
                cairo_set_line_width(cr, 1);
                cairo_set_source_rgba (cr, 1, 0, 0, 0.8);
-               rounded_function (cr, 0.5, 0.5, get_width() - 1, get_height() - 1, _corner_radius);
+               rounded_function (cr, 0.5, 0.5, get_width() - 1, get_height() - 1, corner_radius);
                cairo_stroke (cr);
        }
 
@@ -706,7 +492,7 @@ ArdourButton::render (cairo_t* cr, cairo_rectangle_t *)
        //   (the editor is always the first receiver for KeyDown).
        //   It's needed for eg. the engine-dialog at startup or after closing a sesion.
        if (_focused) {
-               rounded_function (cr, 1.5, 1.5, get_width() - 3, get_height() - 3, _corner_radius);
+               rounded_function (cr, 1.5, 1.5, get_width() - 3, get_height() - 3, corner_radius);
                cairo_set_source_rgba (cr, 0.905, 0.917, 0.925, 0.8);
                double dashes = 1;
                cairo_set_dash (cr, &dashes, 1, 0);
@@ -742,7 +528,7 @@ ArdourButton::on_size_request (Gtk::Requisition* req)
        CairoWidget::on_size_request (req);
 
        if (_diameter == 0) {
-               const float newdia = rint (ARDOUR_UI::config()->get_font_scale () / 9600.0); // 11px with 100% font-scaling
+               const float newdia = rintf (11.f * ARDOUR_UI::ui_scale);
                if (_diameter != newdia) {
                        _pattern_height = 0;
                        _diameter = newdia;
@@ -776,7 +562,7 @@ ArdourButton::on_size_request (Gtk::Requisition* req)
 
        if (_elements & VectorIcon) {
                assert(!(_elements & Text));
-               const int wh = std::max (rint (TRACKHEADERBTNW * char_avg_pixel_width()), ceil (char_pixel_height() * BASELINESTRETCH + 1.));
+               const int wh = std::max (6., std::max (rint (TRACKHEADERBTNW * char_avg_pixel_width()), ceil (char_pixel_height() * BASELINESTRETCH + 1.)));
                req->width += wh;
                req->height = std::max(req->height, wh);
        }
@@ -1343,9 +1129,10 @@ ArdourButton::add_elements (Element e)
 }
 
 void
-ArdourButton::set_icon (Icon i)
+ArdourButton::set_icon (Gtkmm2ext::ArdourIcon::Icon i)
 {
        _icon = i;
+       _elements = (ArdourButton::Element) ((_elements | ArdourButton::VectorIcon) & ~ArdourButton::Text);
        CairoWidget::set_dirty ();
 }