3 import java.util.ArrayList;
4 import java.util.HashMap;
8 import jalview.api.AlignmentViewPanel;
9 import jalview.bin.Console;
10 import jalview.datamodel.PDBEntry;
11 import jalview.datamodel.SequenceI;
12 import jalview.ext.pymol.PymolCommands;
13 import jalview.ext.pymol.PymolManager;
14 import jalview.gui.StructureViewer.ViewerType;
15 import jalview.structure.AtomSpec;
16 import jalview.structure.AtomSpecModel;
17 import jalview.structure.StructureCommand;
18 import jalview.structure.StructureCommandI;
19 import jalview.structure.StructureSelectionManager;
20 import jalview.structures.models.AAStructureBindingModel;
22 public class PymolBindingModel extends AAStructureBindingModel
25 * format for labels shown on structures when mousing over sequence;
26 * see https://pymolwiki.org/index.php/Label#examples
27 * left not final so customisable e.g. with a Groovy script
29 private static String LABEL_FORMAT = "\"%s %s\" % (resn,resi)";
31 private PymolManager pymolManager;
34 * full paths to structure files opened in PyMOL
36 List<String> structureFiles = new ArrayList<>();
39 * lookup from file path to PyMOL object name
41 Map<String, String> pymolObjects = new HashMap<>();
43 private String lastLabelSpec;
53 public PymolBindingModel(StructureViewerBase viewer,
54 StructureSelectionManager ssm, PDBEntry[] pdbentry,
55 SequenceI[][] sequenceIs)
57 super(ssm, pdbentry, sequenceIs, null);
58 pymolManager = new PymolManager();
59 setStructureCommands(new PymolCommands());
64 public String[] getStructureFiles()
66 return structureFiles.toArray(new String[structureFiles.size()]);
70 public void highlightAtoms(List<AtomSpec> atoms)
73 * https://pymolwiki.org/index.php/indicate#examples
75 StringBuilder sb = new StringBuilder();
76 for (AtomSpec atom : atoms)
78 // todo promote to StructureCommandsI.showLabel()
79 String modelId = getModelIdForFile(atom.getPdbFile());
80 sb.append(String.format(" %s//%s/%d/*", modelId,
82 atom.getPdbResNum()));
84 String labelSpec = sb.toString();
85 if (labelSpec.equals(lastLabelSpec))
89 StructureCommandI command = new StructureCommand("indicate", labelSpec);
90 executeCommand(command, false);
92 lastLabelSpec = labelSpec;
96 public SequenceRenderer getSequenceRenderer(AlignmentViewPanel avp)
98 return new SequenceRenderer(avp.getAlignViewport());
102 protected List<String> executeCommand(StructureCommandI command,
105 // System.out.println(command.toString()); // debug
106 return pymolManager.sendCommand(command, getReply);
110 protected String getModelIdForFile(String file)
112 return pymolObjects.containsKey(file) ? pymolObjects.get(file) : "";
116 protected ViewerType getViewerType()
118 return ViewerType.PYMOL;
122 public boolean isViewerRunning()
124 return pymolManager.isPymolLaunched();
128 public void closeViewer(boolean closePymol)
130 super.closeViewer(closePymol);
134 public boolean launchPymol()
136 if (pymolManager.isPymolLaunched())
141 Process pymol = pymolManager.launchPymol();
144 // start listening for PyMOL selections - how??
145 startExternalViewerMonitor(pymol);
149 Console.error("Failed to launch PyMOL!");
151 return pymol != null;
154 public void openFile(PDBEntry pe)
156 // todo : check not already open, remap / rename, etc
157 String file = pe.getFile();
158 StructureCommandI cmd = getCommandGenerator().loadFile(file);
161 * a second parameter sets the pdbid as the loaded PyMOL object name
163 String pdbId = pe.getId();
165 String safePDBId = java.net.URLEncoder.encode(pdbId,"UTF-8");
166 pdbId = safePDBId.replace('%', '_');
167 pdbId = pdbId.replace("-", "__");
168 char fc = pdbId.charAt(0);
169 // put an 's' before any numerics
170 if (fc>='0' && fc<='9')
174 // pdbId.replace('-', 0)
175 } catch (Exception x)
177 Console.error("Unxpected encoding exception for '"+pdbId+"'",x);
179 cmd.addParameter(pdbId);
181 executeCommand(cmd, false);
183 pymolObjects.put(file, pdbId);
184 if (!structureFiles.contains(file))
186 structureFiles.add(file);
188 if (getSsm() != null)
190 getSsm().addStructureViewerListener(this);
196 protected String getModelId(int pdbfnum, String file)
202 * Returns the file extension to use for a saved viewer session file (.pse)
205 * @see https://pymolwiki.org/index.php/Save
208 public String getSessionFileExtension()
214 public String getHelpURL()
216 return "https://pymolwiki.org/";
220 * Constructs and sends commands to set atom properties for visible Jalview
221 * features on residues mapped to structure
226 public int sendFeaturesToViewer(AlignmentViewPanel avp)
228 // todo pull up this and JalviewChimeraBinding variant
229 Map<String, Map<Object, AtomSpecModel>> featureValues = buildFeaturesMap(
231 List<StructureCommandI> commands = getCommandGenerator()
232 .setAttributes(featureValues);
233 executeCommands(commands, false, null);
234 return commands.size();