src/jalview/appletgui/RotatableCanvas.java

   1 /*
   2  * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
   3  * Copyright (C) $$Year-Rel$$ The Jalview Authors
   4  *
   5  * This file is part of Jalview.
   6  *
   7  * Jalview is free software: you can redistribute it and/or
   8  * modify it under the terms of the GNU General Public License
   9  * as published by the Free Software Foundation, either version 3
  10  * of the License, or (at your option) any later version.
  11  *
  12  * Jalview is distributed in the hope that it will be useful, but
  13  * WITHOUT ANY WARRANTY; without even the implied warranty
  14  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  15  * PURPOSE.  See the GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
  19  * The Jalview Authors are detailed in the 'AUTHORS' file.
  20  */
  21 package jalview.appletgui;
  22
  23 import jalview.api.RotatableCanvasI;
  24 import jalview.datamodel.Point;
  25 import jalview.datamodel.SequenceGroup;
  26 import jalview.datamodel.SequenceI;
  27 import jalview.datamodel.SequencePoint;
  28 import jalview.math.RotatableMatrix;
  29 import jalview.math.RotatableMatrix.Axis;
  30 import jalview.util.MessageManager;
  31 import jalview.viewmodel.AlignmentViewport;
  32
  33 import java.awt.Color;
  34 import java.awt.Dimension;
  35 import java.awt.Font;
  36 import java.awt.Graphics;
  37 import java.awt.Image;
  38 import java.awt.Panel;
  39 import java.awt.event.KeyEvent;
  40 import java.awt.event.KeyListener;
  41 import java.awt.event.MouseEvent;
  42 import java.awt.event.MouseListener;
  43 import java.awt.event.MouseMotionListener;
  44 import java.util.List;
  45
  46 public class RotatableCanvas extends Panel implements MouseListener,
  47         MouseMotionListener, KeyListener, RotatableCanvasI
  48 {
  49   private static final int DIMS = 3;
  50
  51   String tooltip;
  52
  53   int toolx;
  54
  55   int tooly;
  56
  57   // RubberbandRectangle rubberband;
  58
  59   boolean drawAxes = true;
  60
  61   int mouseX = 0;
  62
  63   int mouseY = 0;
  64
  65   Image img;
  66
  67   Graphics ig;
  68
  69   Dimension prefsize;
  70
  71   Point centre;
  72
  73   float[] width = new float[DIMS];
  74
  75   float[] max = new float[DIMS];
  76
  77   float[] min = new float[DIMS];
  78
  79   float maxwidth;
  80
  81   float scale;
  82
  83   int npoint;
  84
  85   List<SequencePoint> points;
  86
  87   Point[] orig;
  88
  89   Point[] axisEndPoints;
  90
  91   int startx;
  92
  93   int starty;
  94
  95   int lastx;
  96
  97   int lasty;
  98
  99   int rectx1;
 100
 101   int recty1;
 102
 103   int rectx2;
 104
 105   int recty2;
 106
 107   float scalefactor = 1;
 108
 109   AlignmentViewport av;
 110
 111   boolean showLabels = false;
 112
 113   public RotatableCanvas(AlignmentViewport viewport)
 114   {
 115     this.av = viewport;
 116     axisEndPoints = new Point[DIMS];
 117   }
 118
 119   public void showLabels(boolean b)
 120   {
 121     showLabels = b;
 122     repaint();
 123   }
 124
 125   @Override
 126   public void setPoints(List<SequencePoint> points, int npoint)
 127   {
 128     this.points = points;
 129     this.npoint = npoint;
 130     PaintRefresher.Register(this, av.getSequenceSetId());
 131
 132     prefsize = getPreferredSize();
 133     orig = new Point[npoint];
 134
 135     for (int i = 0; i < npoint; i++)
 136     {
 137       SequencePoint sp = points.get(i);
 138       orig[i] = sp.coord;
 139     }
 140
 141     resetAxes();
 142
 143     findCentre();
 144     findWidth();
 145
 146     scale = findScale();
 147
 148     // System.out.println("Scale factor = " + scale);
 149
 150     addMouseListener(this);
 151     addKeyListener(this);
 152     // if (getParent() != null) {
 153     // getParent().addKeyListener(this);
 154     // }
 155     addMouseMotionListener(this);
 156
 157     // Add rubberband
 158     // rubberband = new RubberbandRectangle(this);
 159     // rubberband.setActive(true);
 160     // rubberband.addListener(this);
 161   }
 162
 163   /*
 164    * public boolean handleSequenceSelectionEvent(SequenceSelectionEvent evt) {
 165    * redrawneeded = true; repaint(); return true; }
 166    *
 167    * public void removeNotify() { controller.removeListener(this);
 168    * super.removeNotify(); }
 169    */
 170
 171   /**
 172    * Resets axes to the initial state: x-axis to the right, y-axis up, z-axis to
 173    * back (so obscured in a 2-D display)
 174    */
 175   public void resetAxes()
 176   {
 177     axisEndPoints[0] = new Point(1f, 0f, 0f);
 178     axisEndPoints[1] = new Point(0f, 1f, 0f);
 179     axisEndPoints[2] = new Point(0f, 0f, 1f);
 180   }
 181
 182   /**
 183    * Computes and saves the maximum and minimum (x, y, z) positions of any
 184    * sequence point, and also the min-max range (width) for each dimension, and
 185    * the maximum width for all dimensions
 186    */
 187   public void findWidth()
 188   {
 189     max = new float[3];
 190     min = new float[3];
 191
 192     max[0] = Float.MIN_VALUE;
 193     max[1] = Float.MIN_VALUE;
 194     max[2] = Float.MIN_VALUE;
 195
 196     min[0] = Float.MAX_VALUE;
 197     min[1] = Float.MAX_VALUE;
 198     min[2] = Float.MAX_VALUE;
 199
 200     for (SequencePoint sp : points)
 201     {
 202       max[0] = Math.max(max[0], sp.coord.x);
 203       max[1] = Math.max(max[1], sp.coord.y);
 204       max[2] = Math.max(max[2], sp.coord.z);
 205       min[0] = Math.min(min[0], sp.coord.x);
 206       min[1] = Math.min(min[1], sp.coord.y);
 207       min[2] = Math.min(min[2], sp.coord.z);
 208     }
 209
 210     width[0] = Math.abs(max[0] - min[0]);
 211     width[1] = Math.abs(max[1] - min[1]);
 212     width[2] = Math.abs(max[2] - min[2]);
 213
 214     maxwidth = Math.max(width[0], Math.max(width[1], width[2]));
 215   }
 216
 217   public float findScale()
 218   {
 219     int dim, w, height;
 220     if (getSize().width != 0)
 221     {
 222       w = getSize().width;
 223       height = getSize().height;
 224     }
 225     else
 226     {
 227       w = prefsize.width;
 228       height = prefsize.height;
 229     }
 230
 231     if (w < height)
 232     {
 233       dim = w;
 234     }
 235     else
 236     {
 237       dim = height;
 238     }
 239
 240     return dim * scalefactor / (2 * maxwidth);
 241   }
 242
 243   /**
 244    * Computes and saves the position of the centre of the view
 245    */
 246   public void findCentre()
 247   {
 248     findWidth();
 249
 250     float x = (max[0] + min[0]) / 2;
 251     float y = (max[1] + min[1]) / 2;
 252     float z = (max[2] + min[2]) / 2;
 253
 254     centre = new Point(x, y, z);
 255   }
 256
 257   @Override
 258   public Dimension getPreferredSize()
 259   {
 260     if (prefsize != null)
 261     {
 262       return prefsize;
 263     }
 264     else
 265     {
 266       return new Dimension(400, 400);
 267     }
 268   }
 269
 270   @Override
 271   public Dimension getMinimumSize()
 272   {
 273     return getPreferredSize();
 274   }
 275
 276   @Override
 277   public void update(Graphics g)
 278   {
 279     paint(g);
 280   }
 281
 282   @Override
 283   public void paint(Graphics g)
 284   {
 285     if (points == null)
 286     {
 287       g.setFont(new Font("Verdana", Font.PLAIN, 18));
 288       g.drawString(
 289               MessageManager.getString("label.calculating_pca") + "....",
 290               20, getSize().height / 2);
 291     }
 292     else
 293     {
 294
 295       // Only create the image at the beginning -
 296       if ((img == null) || (prefsize.width != getSize().width)
 297               || (prefsize.height != getSize().height))
 298       {
 299         prefsize.width = getSize().width;
 300         prefsize.height = getSize().height;
 301
 302         scale = findScale();
 303
 304         // System.out.println("New scale = " + scale);
 305         img = createImage(getSize().width, getSize().height);
 306         ig = img.getGraphics();
 307
 308       }
 309
 310       drawBackground(ig, Color.black);
 311       drawScene(ig);
 312       if (drawAxes)
 313       {
 314         drawAxes(ig);
 315       }
 316
 317       if (tooltip != null)
 318       {
 319         ig.setColor(Color.red);
 320         ig.drawString(tooltip, toolx, tooly);
 321       }
 322
 323       g.drawImage(img, 0, 0, this);
 324     }
 325   }
 326
 327   public void drawAxes(Graphics g)
 328   {
 329
 330     g.setColor(Color.yellow);
 331     for (int i = 0; i < 3; i++)
 332     {
 333       g.drawLine(getSize().width / 2, getSize().height / 2,
 334               (int) (axisEndPoints[i].x * scale * max[0] + getSize().width / 2),
 335               (int) (axisEndPoints[i].y * scale * max[1] + getSize().height / 2));
 336     }
 337   }
 338
 339   public void drawBackground(Graphics g, Color col)
 340   {
 341     g.setColor(col);
 342     g.fillRect(0, 0, prefsize.width, prefsize.height);
 343   }
 344
 345   public void drawScene(Graphics g)
 346   {
 347     for (int i = 0; i < npoint; i++)
 348     {
 349       SequencePoint sp = points.get(i);
 350       SequenceI sequence = sp.getSequence();
 351       Color sequenceColour = av.getSequenceColour(sequence);
 352       g.setColor(
 353               sequenceColour == Color.black ? Color.white : sequenceColour);
 354       if (av.getSelectionGroup() != null)
 355       {
 356         if (av.getSelectionGroup().getSequences(null)
 357                 .contains(sequence))
 358         {
 359           g.setColor(Color.gray);
 360         }
 361       }
 362
 363       if (sp.coord.z < centre.z)
 364       {
 365         g.setColor(g.getColor().darker());
 366       }
 367
 368       int halfwidth = getSize().width / 2;
 369       int halfheight = getSize().height / 2;
 370       int x = (int) ((sp.coord.x - centre.x) * scale) + halfwidth;
 371       int y = (int) ((sp.coord.y - centre.y) * scale) + halfheight;
 372       g.fillRect(x - 3, y - 3, 6, 6);
 373
 374       if (showLabels)
 375       {
 376         g.setColor(Color.red);
 377         g.drawString(sequence.getName(), x - 3, y - 4);
 378       }
 379     }
 380   }
 381
 382   @Override
 383   public void keyTyped(KeyEvent evt)
 384   {
 385   }
 386
 387   @Override
 388   public void keyReleased(KeyEvent evt)
 389   {
 390   }
 391
 392   @Override
 393   public void keyPressed(KeyEvent evt)
 394   {
 395     boolean shiftDown = evt.isShiftDown();
 396     int keyCode = evt.getKeyCode();
 397     if (keyCode == KeyEvent.VK_UP)
 398     {
 399       if (shiftDown)
 400       {
 401         rotate(0f, -1f);
 402       }
 403       else
 404       {
 405         zoom(1.1f);
 406       }
 407     }
 408     else if (keyCode == KeyEvent.VK_DOWN)
 409     {
 410       if (shiftDown)
 411       {
 412         rotate(0f, 1f);
 413       }
 414       else
 415       {
 416         zoom(0.9f);
 417       }
 418     }
 419     else if (shiftDown && keyCode == KeyEvent.VK_LEFT)
 420     {
 421       rotate(1f, 0f);
 422     }
 423     else if (shiftDown && keyCode == KeyEvent.VK_RIGHT)
 424     {
 425       rotate(-1f, 0f);
 426     }
 427     else if (evt.getKeyChar() == 's')
 428     {
 429       System.err.println("DEBUG: Rectangle selection"); // log.debug
 430       if (rectx2 != -1 && recty2 != -1)
 431       {
 432         rectSelect(rectx1, recty1, rectx2, recty2);
 433
 434       }
 435     }
 436     repaint();
 437   }
 438
 439   @Override
 440   public void mouseClicked(MouseEvent evt)
 441   {
 442   }
 443
 444   @Override
 445   public void mouseEntered(MouseEvent evt)
 446   {
 447   }
 448
 449   @Override
 450   public void mouseExited(MouseEvent evt)
 451   {
 452   }
 453
 454   @Override
 455   public void mouseReleased(MouseEvent evt)
 456   {
 457   }
 458
 459   @Override
 460   public void mousePressed(MouseEvent evt)
 461   {
 462     int x = evt.getX();
 463     int y = evt.getY();
 464
 465     mouseX = x;
 466     mouseY = y;
 467
 468     startx = x;
 469     starty = y;
 470
 471     rectx1 = x;
 472     recty1 = y;
 473
 474     rectx2 = -1;
 475     recty2 = -1;
 476
 477     SequenceI found = findSequenceAtPoint(x, y);
 478
 479     if (found != null)
 480     {
 481       // TODO: applet PCA is not associatable with multi-panels - only parent
 482       // view
 483       if (av.getSelectionGroup() != null)
 484       {
 485         av.getSelectionGroup().addOrRemove(found, true);
 486         av.getSelectionGroup().setEndRes(av.getAlignment().getWidth() - 1);
 487       }
 488       else
 489       {
 490         av.setSelectionGroup(new SequenceGroup());
 491         av.getSelectionGroup().addOrRemove(found, true);
 492         av.getSelectionGroup().setEndRes(av.getAlignment().getWidth() - 1);
 493
 494       }
 495       PaintRefresher.Refresh(this, av.getSequenceSetId());
 496       av.sendSelection();
 497     }
 498     repaint();
 499   }
 500
 501   @Override
 502   public void mouseMoved(MouseEvent evt)
 503   {
 504     SequenceI found = findSequenceAtPoint(evt.getX(), evt.getY());
 505     if (found == null)
 506     {
 507       tooltip = null;
 508     }
 509     else
 510     {
 511       tooltip = found.getName();
 512       toolx = evt.getX();
 513       tooly = evt.getY();
 514     }
 515     repaint();
 516   }
 517
 518   @Override
 519   public void mouseDragged(MouseEvent evt)
 520   {
 521     int xPos = evt.getX();
 522     int yPos = evt.getY();
 523
 524     if (xPos == mouseX && yPos == mouseY)
 525     {
 526       return;
 527     }
 528
 529     int xDelta = xPos - mouseX;
 530     int yDelta = yPos - mouseY;
 531
 532     rotate(xDelta, yDelta);
 533     repaint();
 534   }
 535
 536   public void rectSelect(int x1, int y1, int x2, int y2)
 537   {
 538     // boolean changedSel = false;
 539     for (int i = 0; i < npoint; i++)
 540     {
 541       SequencePoint sp = points.get(i);
 542       int tmp1 = (int) ((sp.coord.x - centre.x) * scale
 543               + getSize().width / 2.0);
 544       int tmp2 = (int) ((sp.coord.y - centre.y) * scale
 545               + getSize().height / 2.0);
 546
 547       SequenceI sequence = sp.getSequence();
 548       if (tmp1 > x1 && tmp1 < x2 && tmp2 > y1 && tmp2 < y2)
 549       {
 550         if (av != null)
 551         {
 552           if (!av.getSelectionGroup().getSequences(null)
 553                   .contains(sequence))
 554           {
 555             av.getSelectionGroup().addSequence(sequence, true);
 556           }
 557         }
 558       }
 559     }
 560   }
 561
 562   /**
 563    * Answers the first sequence found whose point on the display is within 2
 564    * pixels of the given coordinates, or null if none is found
 565    *
 566    * @param x
 567    * @param y
 568    *
 569    * @return
 570    */
 571   public SequenceI findSequenceAtPoint(int x, int y)
 572   {
 573     int halfwidth = getSize().width / 2;
 574     int halfheight = getSize().height / 2;
 575
 576     int found = -1;
 577
 578     for (int i = 0; i < npoint; i++)
 579     {
 580
 581       SequencePoint sp = points.get(i);
 582       int px = (int) ((sp.coord.x - centre.x) * scale)
 583               + halfwidth;
 584       int py = (int) ((sp.coord.y - centre.y) * scale)
 585               + halfheight;
 586
 587       if (Math.abs(px - x) < 3 && Math.abs(py - y) < 3)
 588       {
 589         found = i;
 590         break;
 591       }
 592     }
 593
 594     if (found != -1)
 595     {
 596       return points.get(found).getSequence();
 597     }
 598     else
 599     {
 600       return null;
 601     }
 602   }
 603
 604   /**
 605    * Resets the view to initial state (no rotation)
 606    */
 607   public void resetView()
 608   {
 609     img = null;
 610     resetAxes();
 611   }
 612
 613   @Override
 614   public void zoom(float factor)
 615   {
 616     if (factor > 0f)
 617     {
 618       scalefactor *= factor;
 619     }
 620     scale = findScale();
 621   }
 622
 623   @Override
 624   public void rotate(float x, float y)
 625   {
 626     if (x == 0f && y == 0f)
 627     {
 628       return;
 629     }
 630
 631     /*
 632      * get the identity transformation...
 633      */
 634     RotatableMatrix rotmat = new RotatableMatrix();
 635
 636     /*
 637      * rotate around the X axis for change in Y
 638      * (mouse movement up/down); note we are equating a
 639      * number of pixels with degrees of rotation here!
 640      */
 641     if (y != 0)
 642     {
 643       rotmat.rotate(y, Axis.X);
 644     }
 645
 646     /*
 647      * rotate around the Y axis for change in X
 648      * (mouse movement left/right)
 649      */
 650     if (x != 0)
 651     {
 652       rotmat.rotate(x, Axis.Y);
 653     }
 654
 655     /*
 656      * apply the composite transformation to sequence points
 657      */
 658     for (int i = 0; i < npoint; i++)
 659     {
 660       SequencePoint sp = points.get(i);
 661       sp.translate(-centre.x, -centre.y, -centre.z);
 662
 663       // Now apply the rotation matrix
 664       sp.coord = rotmat.vectorMultiply(sp.coord);
 665
 666       // Now translate back again
 667       sp.translate(centre.x, centre.y, centre.z);
 668     }
 669
 670     /*
 671      * rotate the x/y/z axis positions
 672      */
 673     for (int i = 0; i < DIMS; i++)
 674     {
 675       axisEndPoints[i] = rotmat.vectorMultiply(axisEndPoints[i]);
 676     }
 677   }
 678
 679 }