JAL-1432 updated copyright notices
[jalview.git] / help / html / features / pdbviewer.html
1 <html>
2 <!--
3  * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8.0b1)
4  * Copyright (C) 2014 The Jalview Authors
5  * 
6  * This file is part of Jalview.
7  * 
8  * Jalview is free software: you can redistribute it and/or
9  * modify it under the terms of the GNU General Public License 
10  * as published by the Free Software Foundation, either version 3 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 along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
18  * The Jalview Authors are detailed in the 'AUTHORS' file.
19 -->
20 <head>
21 <title>PDB Viewer</title>
22 </head>
23 <body>
24 <p><strong>The Jalview internal PDB Viewer</strong><br>
25 Since Jalview 2.3, the <a href="jmol.html">Jmol PDB Viewer</a> is
26 the main method for <a href="viewingpdbs.html">viewing PDB
27 structures</a>. The documentation below concerns the original Jalview
28 PDB viewer, which is only used in situations where Jmol is unavailable
29 or cannot operate.</p>
30 <p><strong>The PDB Viewer Window</strong>
31 <p>This interactive structure viewing window is opened by selecting
32 the <strong>&quot;Sequence&#8594;View PDB entry:&quot;</strong> entry in
33 the <a href="../menus/popupMenu.html">sequence id pop-up menu</a>. This
34 can only be done for sequences which have an <a href="viewingpdbs.html">associated
35 PDB structure</a>, and the PDB Viewer will only be associated with the
36 particular alignment view from which it was opened.</p>
37 <p><strong>Controls</strong></p>
38 <p>The structure is rendered as an alpha-carbon trace. Moving the
39 mouse over the structure brings up tooltips with a residue name and PDB
40 sequence position. If a mapping exists to a residue in the associated
41 sequence, then this will be highlighted in the associated view in its
42 alignment window, and vice versa for viewing the coordinates associated
43 with a particular residue in the sequence in a particular view on the
44 alignment.</p>
45 <p>Selecting a residue highlights its associated sequence residue
46 and alpha carbon location.</p>
47 <p>
48 <table>
49         <tr>
50                 <td><strong>Action</strong></td>
51                 <td><strong>Windows</strong></td>
52                 <td><strong>Unix</strong></td>
53                 <td><strong>Mac/OSX</strong></td>
54         </tr>
55         <tr>
56                 <td>Select/<br>
57                 Deselect<br>
58                 Residue</td>
59                 <td>Left Click</td>
60                 <td>Left Click</td>
61                 <td>Click</td>
62         </tr>
63         <tr>
64                 <td>Rotate View</td>
65                 <td>Left Click and Drag</td>
66                 <td>Left Click and Drag</td>
67                 <td>Click and Drag</td>
68         </tr>
69         <tr>
70                 <td>Roll View</td>
71                 <td>Right Click and drag</td>
72                 <td>Right Click and Drag</td>
73                 <td>TODO</td>
74         </tr>
75         <tr>
76                 <td>Move Origin</td>
77                 <td>Middle-Button and Drag</td>
78                 <td>Middle-Button and Drag</td>
79                 <td>TODO</td>
80         </tr>
81         <tr>
82                 <td>Zoom In</td>
83                 <td>Up Arrow</td>
84                 <td>Up Arrow</td>
85                 <td>Up Arrow</td>
86         </tr>
87         <tr>
88                 <td>Zoom Out</td>
89                 <td>Down Arrow</td>
90                 <td>Down Arrow</td>
91                 <td>Down Arrow</td>
92         </tr>
93 </table>
94 </p>
95 <p>There are three menus:
96 <ul>
97         <li><Strong>File<br>
98         </strong>
99         <ul>
100                 <li><strong>Save As<br>
101                 </strong><em>Saves the current view as an EPS or PNG file.</em></li>
102                 <li><strong>View Mapping<br>
103                 </strong><em> Opens a text window showing the alignment between the
104                 residues corresponding to alpha-carbon atoms in the PDB structure and
105                 the residues in the associated sequence.</em></li>
106         </ul>
107         </li>
108         <li><strong>Colours<br>
109         </strong>
110         <ul>
111                 <li><strong>By Sequence<br>
112                 </strong><em> Colours each residue in the structure with the colour of its
113                 corresponding residue in the associated sequence as rendered in the
114                 associated alignment view, including any Uniprot sequence features or
115                 region colourings.<br>
116                 Residues which only exist in the PDB structure are coloured white if
117                 they are insertions (relative to the associated sequence in the
118                 alignment) and grey if they are N or C terminal flanks outside the
119                 region mapped to the alignment window's sequence.</em></li>
120                 <li><strong>By Chain<br>
121                 </strong><em> Assigns a random colour to each PDB chain.</em>
122                 <li><strong>Charge &amp; Cysteine<br>
123                 </strong><em> Highlights cysteines in yellow, anionic (Aspartic Acid or
124                 Glutamic Acid) residues in red, and cationic (Lysine or Arginine)
125                 residues in blue.</em></li>
126                 <li><strong><em>Standard and User Defined Jalview
127                 colourschemes.<br>
128                 </em></strong> The remaining entries apply the colourschemes available from the
129                 standard and user defined <a href="../colourSchemes/index.html">amino
130                 acid colours</a>.</em></li>
131         </ul>
132         </li>
133         <li><strong>View<br>
134         </strong><em> These options can be turned off to improve performance when
135         viewing large structures, some at the expense of visual clarity.</em>
136         <ul>
137                 <li><strong>Wireframe<br>
138                 </strong><em> Draws thin lines rather than thick lines for the
139                 alpha-carbon trace.</em></li>
140                 <li><strong>Depthcue<br>
141                 </strong><em>Shades the structure so parts of the structure near the front
142                 of the view are brighter than those further away.</em></li>
143                 <li><strong>Z Buffering<br>
144                 </strong><em> Applies depth sorting to correctly render occluded regions
145                 of the backbone trace.</em></li>
146                 <li><strong>Show All Chains<br>
147                 </strong><em> When turned on, shows all chains in the PDB file, not just
148                 the one associated with a sequence in the alignment window.</em></li>
149                 <!--  NOT YET IMPLEMENTED <li><strong>Associate View</strong><br>
150                 Change which view on the associated sequence's alignment is to be
151                 associated with the PDB viewer.-->
152         </ul>
153         </li>
154 </ul>
155 </p>
156 <p><strong>Notes for PDB Viewing in the Jalview Applet</strong>
157 <p>The applet can only load PDB files by copying and pasting the
158 text into the popup window which appears when &quot;Show PDB
159 Structure&quot; is selected after right clicking on a sequence name.</p>
160 </body>
161 </html>