port_matrix_component.h

Go to the documentation of this file.

/*
    Copyright (C) 2002-2009 Paul Davis

    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 2 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program; if not, write to the Free Software
    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.

*/

#ifndef __gtk_ardour_port_matrix_component_h__
#define __gtk_ardour_port_matrix_component_h__

#include <stdint.h>
#include <gtkmm/eventbox.h>
#include <boost/shared_ptr.hpp>

class PortMatrix;
class PortMatrixBody;
class PortMatrixNode;
class PortGroup;
class PortGroupList;

namespace ARDOUR {
        class Bundle;
        class BundleChannel;
}

class PortMatrixComponent
{
public:
        PortMatrixComponent (PortMatrix *, PortMatrixBody *);
        virtual ~PortMatrixComponent ();

        virtual double component_to_parent_x (double x) const = 0;
        virtual double parent_to_component_x (double x) const = 0;
        virtual double component_to_parent_y (double y) const = 0;
        virtual double parent_to_component_y (double y) const = 0;
        virtual void mouseover_changed (std::list<PortMatrixNode> const &) = 0;
        virtual void draw_extra (cairo_t *) = 0;
        virtual void button_press (double, double, GdkEventButton *) {}
        virtual void button_release (double, double, GdkEventButton *) {}
        virtual void motion (double, double) {}

        void set_show_ports (bool);
        void setup ();
        GdkPixmap* get_pixmap (GdkDrawable *);
        std::pair<uint32_t, uint32_t> dimensions ();

        void require_render () {
                _render_required = true;
        }

        void require_rebuild () {
                _dimension_computation_required = true;
                _render_required = true;
        }

        void set_parent_rectangle (Gdk::Rectangle const & r) {
                _parent_rectangle = r;
        }

        Gdk::Rectangle parent_rectangle () const {
                return _parent_rectangle;
        }

        static uint32_t grid_spacing () {
                return 24;
        }

protected:

        static uint32_t label_border_width () {
                return 1;
        }

        static uint32_t name_pad () {
                return 8;
        }

        static double thin_grid_line_width () {
                return 0.5;
        }

        static double thick_grid_line_width () {
                return 1;
        }

        static uint32_t connection_indicator_pad () {
                return 6;
        }

        static uint32_t mouseover_line_width () {
                return 4;
        }

        static double angle () {
                return M_PI / 4;
        }

        Gdk::Color background_colour ();

        /* XXX I guess these colours should come from a theme, or something */

        static Gdk::Color text_colour () {
                return Gdk::Color ("#ffffff");
        }

        static Gdk::Color grid_colour () {
                return Gdk::Color ("#000000");
        }

        static Gdk::Color association_colour () {
                return Gdk::Color ("#00ff00");
        }

        static Gdk::Color non_connectable_colour () {
                return Gdk::Color ("#cccccc");
        }

        static Gdk::Color mouseover_line_colour () {
                return Gdk::Color ("#ff0000");
        }

        static Gdk::Color highlighted_channel_colour () {
                return Gdk::Color ("#777777");
        }

        /* XXX */
        static Gdk::Color get_a_bundle_colour (int x) {
                if ((x % 2) == 0) {
                        return Gdk::Color ("#555555");
                } else {
                        return Gdk::Color ("#666666");
                }
        }

        /* XXX */
        static Gdk::Color get_a_group_colour (int x) {
                if ((x % 2) == 0) {
                        return Gdk::Color ("#222222");
                } else {
                        return Gdk::Color ("#444444");
                }
        }

        void set_source_rgb (cairo_t *, Gdk::Color const &);
        void set_source_rgba (cairo_t *, Gdk::Color const &, double);
        uint32_t group_size (boost::shared_ptr<const PortGroup>) const;
        uint32_t channel_to_position (ARDOUR::BundleChannel, boost::shared_ptr<const PortGroup>) const;
        virtual ARDOUR::BundleChannel position_to_channel (double, double, boost::shared_ptr<const PortGroup>) const;

        virtual void render (cairo_t *) = 0;
        virtual void compute_dimensions () = 0;

        PortMatrix* _matrix;
        PortMatrixBody* _body; 
        uint32_t _width; 
        uint32_t _height; 
        Gdk::Rectangle _parent_rectangle;

private:
        GdkPixmap* _pixmap; 
        bool _render_required; 
        bool _dimension_computation_required; 
};

#endif