alg/glseqbrowser.hpp

   1 #ifndef _GLTRACKS_H_
   2 #define _GLTRACKS_H_
   3
   4 #include <map>
   5 #include <set>
   6 #include <vector>
   7
   8 #include "alg/annotation_colors.hpp"
   9 #include "alg/sequence.hpp"
  10 #include "alg/glsequence.hpp"
  11
  12 //! Manage rendering a collection of glSequences
  13 class GlSeqBrowser
  14 {
  15 public:
  16   GlSeqBrowser();
  17   GlSeqBrowser(const GlSeqBrowser&);
  18
  19   //! setup the opengl canvas
  20   void initializeGL();
  21   //! called when our screen canvas is resized
  22   void resizeGL(int width, int height);
  23   //! render our scene
  24   void paintGL() const;
  25
  26   //! select a region (using canvas coordinates)
  27   void GlSeqBrowser::selectRegion(int top, int left, int bottom, int right);
  28
  29   //! border size
  30   float border() const;
  31
  32   //! max world left coordinate
  33   float left() const;
  34   //! max world right coordinate
  35   float right() const;
  36
  37   void setViewportCenter(float x);
  38   //! return world coordinate of the left side of the viewport
  39   float viewportLeft() const;
  40   //! return world coordinate of the center of the viewport
  41   float viewportCenter() const;
  42   //! return world coordinate of the right side of the viewport
  43   float viewportRight() const;
  44   //! return height of the viewport in world coordinates
  45   float viewportHeight() const;
  46   //! return width of the viewport in world coordinates
  47   float viewportWidth() const;
  48
  49   //! zoom out far enough to show the full size of the sequence
  50   double zoomOut();
  51   //! zoom in to a reasonable sequence view
  52   double zoomToSequence();
  53   //! set the current zoom level in (base pairs / pix )
  54   //! its a double as zoom levels of [0.01, 1.0] make nice sequence views
  55   void setZoom(double zoom_level);
  56   //! returns the current zoom level as basepairs per pixel
  57   double zoom() const;
  58   //! center the provided path in the current viewport
  59   void centerOnPath(const std::vector<int>&);
  60
  61   void setColorMapper(AnnotationColors& cm);
  62   AnnotationColors& colorMapper();
  63
  64   //! clear our tracks and connections
  65   void clear();
  66
  67   //! add a sequence to the back of our track container
  68   void push_sequence(const Sequence &s);
  69   //! add a glsequence to the back of our track container
  70   void push_sequence(GlSequence &s);
  71   //! return our track container
  72   const std::vector<GlSequence>& sequences() const;
  73
  74   //! clear all the line segments between all the sequences
  75   void clear_links();
  76   //! define a path
  77   void link(const std::vector<int>& path, const std::vector<bool>& isRC, int length);
  78   //! returns the index of pathids based on order added by link
  79   const std::set<int>& selectedPaths() const;
  80   //! define our function for formating sequence copy
  81   typedef std::string format_track(const Sequence& s, int left, int right);
  82   //! copy sequence from selected track using formating function
  83   void copySelectedTracks(std::string& copy_buffer, format_track func);
  84   //! copy sequence from selected tracks as plain sequences
  85   void copySelectedTracksAsString(std::string& copy_buffer);
  86   //! copy sequence from selected tracks as FASTA sequences
  87   void copySelectedTracksAsFasta(std::string& copy_buffer);
  88
  89
  90   //! Provide a logical name for a type discriminator for our glName stack
  91   enum FeatureType { MussaTrack, MussaSegment };
  92
  93   //! a useful point class
  94   template<class T> struct point {
  95     T x;
  96     T y;
  97
  98     point(T x_, T y_):x(x_), y(y_) {}
  99   };
 100
 101   //! a useful rectangle, where 0,0 is in the lower left
 102   template<class T> struct rect {
 103     T top;
 104     T left;
 105     T bottom;
 106     T right;
 107
 108     rect() {}
 109     rect(T t, T l, T b, T r) : top(t), left(l), bottom(b), right(r) {}
 110     T width() { return right - left; }
 111     T height() { return top - bottom; }
 112   };
 113
 114   struct Segment
 115   {
 116     point<float> start;
 117     point<float> end;
 118     bool reversed;
 119     std::set<int> path_ids;
 120
 121     Segment() : start(0.0, 0.0), end(0.0, 0.0) {}
 122     Segment(float x1, float y1, float x2, float y2, bool isRC)
 123       : start(x1, y1), end(x2, y2), reversed(isRC) {}
 124   };
 125
 126   //! data structure holding our line segments
 127   /*! the vector is of size track_container.size()-1
 128    *  it's indexed by the pair x1, x2 (the two x coordinates between
 129    *  the two tracks
 130    */
 131   typedef std::pair<int, int> segment_key;
 132   typedef std::map<segment_key, Segment> pair_segment_map;
 133   typedef std::vector<pair_segment_map> path_segment_map_vector;
 134   path_segment_map_vector path_segments;
 135
 136   struct TrackRegion
 137   {
 138     GLuint track_id;
 139     int left;
 140     int right;
 141
 142     TrackRegion():track_id(0), left(0), right(0) {};
 143     TrackRegion(const TrackRegion& o)
 144       : track_id(o.track_id), left(o.left), right(o.right) {}
 145     TrackRegion(GLuint id, int l, int r)
 146       : track_id(id), left(l), right(r) {}
 147     void set(GLuint id, int l, int r) { track_id = id; left=l; right=r; };
 148   };
 149
 150 private:
 151   //! recalculate the viewable world
 152   /*! depending on the size of our canvas, our zoom level and
 153    *  how far we've been offset
 154    */
 155   void update_viewport(float center, double new_zoom);
 156
 157   //! determine where all the tracks should be placed
 158   void update_layout();
 159
 160   //! convert opengl selections into the list of paths we should highlight
 161   void processSelection(GLuint hits,
 162                         GLuint buffer[],
 163                         GLuint bufsize,
 164                         const rect<float>& r);
 165
 166   //! master scene drawing function
 167   /*! draw is broken out for the opengl selection code
 168    */
 169   void draw() const;
 170   //! draw glsequence tracks
 171   void draw_tracks() const;
 172   //! draw line segments between tracks
 173   void draw_segments() const;
 174   //! draw selection box
 175   void draw_selection() const;
 176
 177   //! number of pixels to reserve around the edges of our canvas
 178   const int border_width;
 179   //! the current viewable region (world coord)
 180   rect<float> cur_ortho;
 181   //! how many pixels our viewport is (screen coord)
 182   point<int> viewport_size;
 183   //! the center of our current viewport (world coord) (used for scrollbar)
 184   float viewport_center;
 185   double zoom_level;
 186   AnnotationColors color_mapper;
 187   //! container of all the GlSequences loaded into our scene
 188   std::vector<GlSequence> track_container;
 189   //! counter for each path added to us via connect
 190   int pathid;
 191
 192 protected:
 193   //! where to draw our box (world coordinates)
 194   rect<float> selectedRegion;
 195   //! true if we have a selection
 196   bool selectedMode;
 197   //! indicate which paths are selected
 198   std::set<int> selected_paths;
 199   //! which track is selected (it only makes sense to have one track selected).
 200   std::list<TrackRegion> selected_tracks;
 201   typedef std::list<TrackRegion>::iterator selected_track_iterator;
 202 };
 203 #endif