2 * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
3 * Copyright (C) $$Year-Rel$$ The Jalview Authors
5 * This file is part of Jalview.
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.
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.
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.
23 import jalview.analysis.AlignSeq;
24 import jalview.datamodel.PDBEntry;
25 import jalview.datamodel.SequenceI;
26 import jalview.gui.AlignmentPanel;
27 import jalview.gui.FeatureRenderer;
28 import jalview.gui.SequenceRenderer;
29 import jalview.io.DataSourceType;
30 import jalview.io.StructureFile;
31 import jalview.renderer.seqfeatures.FeatureColourFinder;
32 import jalview.structure.AtomSpec;
33 import jalview.structure.StructureListener;
34 import jalview.structure.StructureMapping;
35 import jalview.structure.StructureSelectionManager;
37 import java.awt.Color;
38 import java.awt.Dimension;
39 import java.awt.Event;
41 import java.awt.Graphics;
42 import java.awt.Graphics2D;
43 // JBPNote TODO: This class is quite noisy - needs proper log.info/log.debug
44 import java.awt.Image;
45 import java.awt.RenderingHints;
46 import java.awt.event.KeyAdapter;
47 import java.awt.event.KeyEvent;
48 import java.awt.event.MouseEvent;
49 import java.awt.event.MouseListener;
50 import java.awt.event.MouseMotionListener;
51 import java.io.PrintStream;
52 import java.util.List;
53 import java.util.Vector;
55 import javax.swing.JPanel;
56 import javax.swing.ToolTipManager;
58 public class PDBCanvas extends JPanel implements MouseListener,
59 MouseMotionListener, StructureListener
61 boolean redrawneeded = true;
71 public StructureFile pdb;
83 float[] centre = new float[3];
85 float[] width = new float[3];
95 boolean bysequence = true;
97 boolean depthcue = true;
101 boolean bymolecule = false;
103 boolean zbuffer = true;
119 Font font = new Font("Helvetica", Font.PLAIN, 10);
121 jalview.gui.SeqCanvas seqcanvas;
123 public SequenceI[] sequence;
125 final StringBuffer mappingDetails = new StringBuffer();
129 Vector<String> highlightRes;
131 boolean pdbAction = false;
133 boolean seqColoursReady = false;
135 jalview.renderer.seqfeatures.FeatureRenderer fr;
137 Color backgroundColour = Color.black;
141 StructureSelectionManager ssm;
145 void init(PDBEntry pdbentry, SequenceI[] seq, String[] chains,
146 AlignmentPanel ap, DataSourceType protocol)
149 this.pdbentry = pdbentry;
152 ssm = ap.av.getStructureSelectionManager();
156 pdb = ssm.setMapping(seq, chains, pdbentry.getFile(), protocol);
158 if (protocol.equals(jalview.io.DataSourceType.PASTE))
160 pdbentry.setFile("INLINE" + pdb.getId());
163 } catch (Exception ex)
165 ex.printStackTrace();
171 errorMessage = "Error loading file: " + pdbentry.getId();
174 pdbentry.setId(pdb.getId());
176 ssm.addStructureViewerListener(this);
187 // JUST DEAL WITH ONE SEQUENCE FOR NOW
188 SequenceI sequence = seq[0];
190 for (int i = 0; i < pdb.getChains().size(); i++)
194 .append("\n\nPDB Sequence is :\nSequence = "
195 + pdb.getChains().elementAt(i).sequence
196 .getSequenceAsString());
197 mappingDetails.append("\nNo of residues = "
198 + pdb.getChains().elementAt(i).residues.size() + "\n\n");
200 // Now lets compare the sequences to get
201 // the start and end points.
202 // Align the sequence to the pdb
203 AlignSeq as = new AlignSeq(sequence,
204 pdb.getChains().elementAt(i).sequence, "pep");
205 as.calcScoreMatrix();
207 PrintStream ps = new PrintStream(System.out)
210 public void print(String x)
212 mappingDetails.append(x);
216 public void println()
218 mappingDetails.append("\n");
222 as.printAlignment(ps);
224 if (as.maxscore > max)
229 pdbstart = as.seq2start;
231 seqstart = as.seq1start + sequence.getStart() - 1;
232 seqend = as.seq1end + sequence.getEnd() - 1;
235 mappingDetails.append("\nPDB start/end " + pdbstart + " " + pdbend);
236 mappingDetails.append("\nSEQ start/end " + seqstart + " " + seqend);
239 mainchain = pdb.getChains().elementAt(maxchain);
241 mainchain.pdbstart = pdbstart;
242 mainchain.pdbend = pdbend;
243 mainchain.seqstart = seqstart;
244 mainchain.seqend = seqend;
245 mainchain.isVisible = true;
248 this.prefsize = new Dimension(getSize().width, getSize().height);
250 addMouseMotionListener(this);
251 addMouseListener(this);
253 addKeyListener(new KeyAdapter()
256 public void keyPressed(KeyEvent evt)
269 ToolTipManager.sharedInstance().registerComponent(this);
270 ToolTipManager.sharedInstance().setInitialDelay(0);
271 ToolTipManager.sharedInstance().setDismissDelay(10000);
274 Vector<Bond> visiblebonds;
278 seqColoursReady = false;
279 // Sort the bonds by z coord
280 visiblebonds = new Vector<Bond>();
282 for (PDBChain chain : pdb.getChains())
286 for (Bond bond : chain.bonds)
288 visiblebonds.addElement(bond);
294 seqColoursReady = true;
299 public void findWidth()
301 float[] max = new float[3];
302 float[] min = new float[3];
304 max[0] = (float) -1e30;
305 max[1] = (float) -1e30;
306 max[2] = (float) -1e30;
308 min[0] = (float) 1e30;
309 min[1] = (float) 1e30;
310 min[2] = (float) 1e30;
312 for (PDBChain chain : pdb.getChains())
316 for (Bond tmp : chain.bonds)
318 if (tmp.start[0] >= max[0])
320 max[0] = tmp.start[0];
323 if (tmp.start[1] >= max[1])
325 max[1] = tmp.start[1];
328 if (tmp.start[2] >= max[2])
330 max[2] = tmp.start[2];
333 if (tmp.start[0] <= min[0])
335 min[0] = tmp.start[0];
338 if (tmp.start[1] <= min[1])
340 min[1] = tmp.start[1];
343 if (tmp.start[2] <= min[2])
345 min[2] = tmp.start[2];
348 if (tmp.end[0] >= max[0])
353 if (tmp.end[1] >= max[1])
358 if (tmp.end[2] >= max[2])
363 if (tmp.end[0] <= min[0])
368 if (tmp.end[1] <= min[1])
373 if (tmp.end[2] <= min[2])
381 * System.out.println("xmax " + max[0] + " min " + min[0]);
382 * System.out.println("ymax " + max[1] + " min " + min[1]);
383 * System.out.println("zmax " + max[2] + " min " + min[2]);
386 width[0] = Math.abs(max[0] - min[0]);
387 width[1] = Math.abs(max[1] - min[1]);
388 width[2] = Math.abs(max[2] - min[2]);
392 if (width[1] > width[0])
397 if (width[2] > width[1])
402 // System.out.println("Maxwidth = " + maxwidth);
405 public float findScale()
414 height = getHeight();
418 width = prefsize.width;
419 height = prefsize.height;
431 return (float) (dim / (1.5d * maxwidth));
434 public void findCentre()
442 // Find centre coordinate
443 for (PDBChain chain : pdb.getChains())
447 bsize += chain.bonds.size();
449 for (Bond bond : chain.bonds)
451 xtot = xtot + bond.start[0] + bond.end[0];
452 ytot = ytot + bond.start[1] + bond.end[1];
453 ztot = ztot + bond.start[2] + bond.end[2];
458 centre[0] = xtot / (2 * (float) bsize);
459 centre[1] = ytot / (2 * (float) bsize);
460 centre[2] = ztot / (2 * (float) bsize);
464 public void paintComponent(Graphics g)
466 super.paintComponent(g);
468 if (!seqColoursReady || errorMessage != null)
470 g.setColor(Color.black);
471 g.setFont(new Font("Verdana", Font.BOLD, 14));
472 g.drawString(errorMessage == null ? "Retrieving PDB data...."
473 : errorMessage, 20, getHeight() / 2);
477 // Only create the image at the beginning -
478 // this saves much memory usage
479 if ((img == null) || (prefsize.width != getWidth())
480 || (prefsize.height != getHeight()))
483 prefsize.width = getWidth();
484 prefsize.height = getHeight();
487 img = createImage(prefsize.width, prefsize.height);
488 ig = img.getGraphics();
489 Graphics2D ig2 = (Graphics2D) ig;
491 ig2.setRenderingHint(RenderingHints.KEY_ANTIALIASING,
492 RenderingHints.VALUE_ANTIALIAS_ON);
499 drawAll(ig, prefsize.width, prefsize.height);
500 redrawneeded = false;
503 g.drawImage(img, 0, 0, this);
508 public void drawAll(Graphics g, int width, int height)
510 g.setColor(backgroundColour);
511 g.fillRect(0, 0, width, height);
516 public void updateSeqColours()
529 // This method has been taken out of PDBChain to allow
530 // Applet and Application specific sequence renderers to be used
531 void colourBySequence()
533 SequenceRenderer sr = new SequenceRenderer(ap.av);
535 StructureMapping[] mapping = ssm.getMapping(pdbentry.getFile());
537 boolean showFeatures = false;
538 if (ap.av.isShowSequenceFeatures())
542 fr = new FeatureRenderer(ap);
545 fr.transferSettings(ap.alignFrame.getFeatureRenderer());
550 FeatureColourFinder finder = new FeatureColourFinder(fr);
552 if (bysequence && pdb != null)
554 for (int ii = 0; ii < pdb.getChains().size(); ii++)
556 chain = pdb.getChains().elementAt(ii);
558 for (int i = 0; i < chain.bonds.size(); i++)
560 Bond tmp = chain.bonds.elementAt(i);
561 tmp.startCol = Color.lightGray;
562 tmp.endCol = Color.lightGray;
563 if (chain != mainchain)
568 for (int s = 0; s < sequence.length; s++)
570 for (int m = 0; m < mapping.length; m++)
572 if (mapping[m].getSequence() == sequence[s])
574 int pos = mapping[m].getSeqPos(tmp.at1.resNumber) - 1;
577 pos = sequence[s].findIndex(pos);
578 tmp.startCol = sr.getResidueColour(sequence[s], pos,
581 pos = mapping[m].getSeqPos(tmp.at2.resNumber) - 1;
584 pos = sequence[s].findIndex(pos);
586 .getResidueColour(sequence[s], pos, finder);
599 public void drawScene(Graphics g)
608 zsort.sort(visiblebonds);
612 for (int i = 0; i < visiblebonds.size(); i++)
614 tmpBond = visiblebonds.elementAt(i);
616 xstart = (int) (((tmpBond.start[0] - centre[0]) * scale) + (getWidth() / 2));
617 ystart = (int) (((centre[1] - tmpBond.start[1]) * scale) + (getHeight() / 2));
619 xend = (int) (((tmpBond.end[0] - centre[0]) * scale) + (getWidth() / 2));
620 yend = (int) (((centre[1] - tmpBond.end[1]) * scale) + (getHeight() / 2));
622 xmid = (xend + xstart) / 2;
623 ymid = (yend + ystart) / 2;
624 if (depthcue && !bymolecule)
626 if (tmpBond.start[2] < (centre[2] - (maxwidth / 6)))
629 g.setColor(tmpBond.startCol.darker().darker());
630 drawLine(g, xstart, ystart, xmid, ymid);
631 g.setColor(tmpBond.endCol.darker().darker());
632 drawLine(g, xmid, ymid, xend, yend);
635 else if (tmpBond.start[2] < (centre[2] + (maxwidth / 6)))
637 g.setColor(tmpBond.startCol.darker());
638 drawLine(g, xstart, ystart, xmid, ymid);
640 g.setColor(tmpBond.endCol.darker());
641 drawLine(g, xmid, ymid, xend, yend);
645 g.setColor(tmpBond.startCol);
646 drawLine(g, xstart, ystart, xmid, ymid);
648 g.setColor(tmpBond.endCol);
649 drawLine(g, xmid, ymid, xend, yend);
652 else if (depthcue && bymolecule)
654 if (tmpBond.start[2] < (centre[2] - (maxwidth / 6)))
656 g.setColor(Color.green.darker().darker());
657 drawLine(g, xstart, ystart, xend, yend);
659 else if (tmpBond.start[2] < (centre[2] + (maxwidth / 6)))
661 g.setColor(Color.green.darker());
662 drawLine(g, xstart, ystart, xend, yend);
666 g.setColor(Color.green);
667 drawLine(g, xstart, ystart, xend, yend);
670 else if (!depthcue && !bymolecule)
672 g.setColor(tmpBond.startCol);
673 drawLine(g, xstart, ystart, xmid, ymid);
674 g.setColor(tmpBond.endCol);
675 drawLine(g, xmid, ymid, xend, yend);
679 drawLine(g, xstart, ystart, xend, yend);
682 if (highlightBond1 != null && highlightBond1 == tmpBond)
684 g.setColor(tmpBond.endCol.brighter().brighter().brighter()
686 drawLine(g, xmid, ymid, xend, yend);
689 if (highlightBond2 != null && highlightBond2 == tmpBond)
691 g.setColor(tmpBond.startCol.brighter().brighter().brighter()
693 drawLine(g, xstart, ystart, xmid, ymid);
700 public void drawLine(Graphics g, int x1, int y1, int x2, int y2)
704 if (((float) Math.abs(y2 - y1) / (float) Math.abs(x2 - x1)) < 0.5)
706 g.drawLine(x1, y1, x2, y2);
707 g.drawLine(x1 + 1, y1 + 1, x2 + 1, y2 + 1);
708 g.drawLine(x1, y1 - 1, x2, y2 - 1);
712 g.setColor(g.getColor().brighter());
713 g.drawLine(x1, y1, x2, y2);
714 g.drawLine(x1 + 1, y1, x2 + 1, y2);
715 g.drawLine(x1 - 1, y1, x2 - 1, y2);
720 g.drawLine(x1, y1, x2, y2);
724 public Dimension minimumsize()
729 public Dimension preferredsize()
734 public void keyPressed(KeyEvent evt)
736 if (evt.getKeyCode() == KeyEvent.VK_UP)
738 scale = (float) (scale * 1.1);
742 else if (evt.getKeyCode() == KeyEvent.VK_DOWN)
744 scale = (float) (scale * 0.9);
751 public void mousePressed(MouseEvent e)
754 Atom fatom = findAtom(e.getX(), e.getY());
757 fatom.isSelected = !fatom.isSelected;
761 if (foundchain != -1)
763 PDBChain chain = pdb.getChains().elementAt(foundchain);
764 if (chain == mainchain)
766 if (fatom.alignmentMapping != -1)
768 if (highlightRes == null)
770 highlightRes = new Vector<String>();
773 final String atomString = Integer
774 .toString(fatom.alignmentMapping);
775 if (highlightRes.contains(atomString))
777 highlightRes.remove(atomString);
781 highlightRes.add(atomString);
796 public void mouseMoved(MouseEvent e)
799 if (highlightBond1 != null)
801 highlightBond1.at2.isSelected = false;
802 highlightBond2.at1.isSelected = false;
803 highlightBond1 = null;
804 highlightBond2 = null;
807 Atom fatom = findAtom(e.getX(), e.getY());
809 PDBChain chain = null;
810 if (foundchain != -1)
812 chain = pdb.getChains().elementAt(foundchain);
813 if (chain == mainchain)
815 mouseOverStructure(fatom.resNumber, chain.id);
821 this.setToolTipText(chain.id + ":" + fatom.resNumber + " "
826 mouseOverStructure(-1, chain != null ? chain.id : null);
827 this.setToolTipText(null);
832 public void mouseClicked(MouseEvent e)
837 public void mouseEntered(MouseEvent e)
842 public void mouseExited(MouseEvent e)
847 public void mouseDragged(MouseEvent evt)
854 MCMatrix objmat = new MCMatrix(3, 3);
855 objmat.setIdentity();
857 if ((evt.getModifiers() & Event.META_MASK) != 0)
859 objmat.rotatez(((mx - omx)));
863 objmat.rotatex(((my - omy)));
864 objmat.rotatey(((omx - mx)));
868 for (PDBChain chain : pdb.getChains())
870 for (Bond tmpBond : chain.bonds)
872 // Translate the bond so the centre is 0,0,0
873 tmpBond.translate(-centre[0], -centre[1], -centre[2]);
875 // Now apply the rotation matrix
876 tmpBond.start = objmat.vectorMultiply(tmpBond.start);
877 tmpBond.end = objmat.vectorMultiply(tmpBond.end);
879 // Now translate back again
880 tmpBond.translate(centre[0], centre[1], centre[2]);
897 public void mouseReleased(MouseEvent evt)
903 void drawLabels(Graphics g)
906 for (PDBChain chain : pdb.getChains())
910 for (Bond tmpBond : chain.bonds)
912 if (tmpBond.at1.isSelected)
914 labelAtom(g, tmpBond, 1);
917 if (tmpBond.at2.isSelected)
919 labelAtom(g, tmpBond, 2);
926 public void labelAtom(Graphics g, Bond b, int n)
929 g.setColor(Color.red);
932 int xstart = (int) (((b.start[0] - centre[0]) * scale) + (getWidth() / 2));
933 int ystart = (int) (((centre[1] - b.start[1]) * scale) + (getHeight() / 2));
935 g.drawString(b.at1.resName + "-" + b.at1.resNumber, xstart, ystart);
940 int xstart = (int) (((b.end[0] - centre[0]) * scale) + (getWidth() / 2));
941 int ystart = (int) (((centre[1] - b.end[1]) * scale) + (getHeight() / 2));
943 g.drawString(b.at2.resName + "-" + b.at2.resNumber, xstart, ystart);
949 public Atom findAtom(int x, int y)
955 for (int ii = 0; ii < pdb.getChains().size(); ii++)
957 PDBChain chain = pdb.getChains().elementAt(ii);
963 for (Bond bond : chain.bonds)
967 truex = (int) (((tmpBond.start[0] - centre[0]) * scale) + (getWidth() / 2));
969 if (Math.abs(truex - x) <= 2)
971 int truey = (int) (((centre[1] - tmpBond.start[1]) * scale) + (getHeight() / 2));
973 if (Math.abs(truey - y) <= 2)
982 // Still here? Maybe its the last bond
984 truex = (int) (((tmpBond.end[0] - centre[0]) * scale) + (getWidth() / 2));
986 if (Math.abs(truex - x) <= 2)
988 int truey = (int) (((tmpBond.end[1] - centre[1]) * scale) + (getHeight() / 2));
990 if (Math.abs(truey - y) <= 2)
1000 if (fatom != null) // )&& chain.ds != null)
1001 { // dead code? value of chain is either overwritten or discarded
1002 chain = pdb.getChains().elementAt(foundchain);
1009 Bond highlightBond1, highlightBond2;
1011 public void highlightRes(int ii)
1013 if (!seqColoursReady)
1018 if (highlightRes != null && highlightRes.contains((ii - 1) + ""))
1025 for (index = 0; index < mainchain.bonds.size(); index++)
1027 tmpBond = mainchain.bonds.elementAt(index);
1028 if (tmpBond.at1.alignmentMapping == ii - 1)
1030 if (highlightBond1 != null)
1032 highlightBond1.at2.isSelected = false;
1035 if (highlightBond2 != null)
1037 highlightBond2.at1.isSelected = false;
1040 highlightBond1 = null;
1041 highlightBond2 = null;
1045 highlightBond1 = mainchain.bonds.elementAt(index - 1);
1046 highlightBond1.at2.isSelected = true;
1049 if (index != mainchain.bonds.size())
1051 highlightBond2 = mainchain.bonds.elementAt(index);
1052 highlightBond2.at1.isSelected = true;
1059 redrawneeded = true;
1063 public void setAllchainsVisible(boolean b)
1065 for (int ii = 0; ii < pdb.getChains().size(); ii++)
1067 PDBChain chain = pdb.getChains().elementAt(ii);
1068 chain.isVisible = b;
1070 mainchain.isVisible = true;
1075 // ////////////////////////////////
1076 // /StructureListener
1078 public String[] getPdbFile()
1080 return new String[] { pdbentry.getFile() };
1085 public void mouseOverStructure(int pdbResNum, String chain)
1087 if (lastMessage == null || !lastMessage.equals(pdbResNum + chain))
1089 ssm.mouseOverStructure(pdbResNum, chain, pdbentry.getFile());
1092 lastMessage = pdbResNum + chain;
1095 StringBuffer resetLastRes = new StringBuffer();
1097 StringBuffer eval = new StringBuffer();
1100 * Highlight the specified atoms in the structure.
1105 public void highlightAtoms(List<AtomSpec> atoms)
1107 if (!seqColoursReady)
1112 for (AtomSpec atom : atoms)
1114 int atomIndex = atom.getAtomIndex();
1115 if (highlightRes != null
1116 && highlightRes.contains((atomIndex - 1) + ""))
1121 highlightAtom(atomIndex);
1124 redrawneeded = true;
1129 * Highlight the atom at the specified index.
1133 protected void highlightAtom(int atomIndex)
1137 for (index = 0; index < mainchain.bonds.size(); index++)
1139 tmpBond = mainchain.bonds.elementAt(index);
1140 if (tmpBond.at1.atomIndex == atomIndex)
1142 if (highlightBond1 != null)
1144 highlightBond1.at2.isSelected = false;
1147 if (highlightBond2 != null)
1149 highlightBond2.at1.isSelected = false;
1152 highlightBond1 = null;
1153 highlightBond2 = null;
1157 highlightBond1 = mainchain.bonds.elementAt(index - 1);
1158 highlightBond1.at2.isSelected = true;
1161 if (index != mainchain.bonds.size())
1163 highlightBond2 = mainchain.bonds.elementAt(index);
1164 highlightBond2.at1.isSelected = true;
1172 public Color getColour(int atomIndex, int pdbResNum, String chain,
1176 // if (!pdbfile.equals(pdbentry.getFile()))
1179 // return new Color(viewer.getAtomArgb(atomIndex));
1183 public void updateColours(Object source)
1186 redrawneeded = true;
1191 public void releaseReferences(Object svl)
1193 // TODO Auto-generated method stub
1198 public boolean isListeningFor(SequenceI seq)
1200 if (sequence != null)
1202 for (SequenceI s : sequence)