d6804f816edf3316bc336539f856d9980b2c67c2
[blender-addons-contrib.git] / io_mesh_xyz / import_xyz.py
1 # ##### BEGIN GPL LICENSE BLOCK #####
2 #
3 #  This program is free software; you can redistribute it and/or
4 #  modify it under the terms of the GNU General Public License
5 #  as published by the Free Software Foundation; either version 2
6 #  of the License, or (at your option) any later version.
7 #
8 #  This program is distributed in the hope that it will be useful,
9 #  but WITHOUT ANY WARRANTY; without even the implied warranty of
10 #  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11 #  GNU General Public License for more details.
12 #
13 #  You should have received a copy of the GNU General Public License
14 #  along with this program; if not, write to the Free Software Foundation,
15 #  Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
16 #
17 # ##### END GPL LICENSE BLOCK #####
18
19 import bpy
20 from math import pi, sqrt
21 from mathutils import Vector, Matrix
22
23 # -----------------------------------------------------------------------------
24 #                                                  Atom and element data
25
26
27 # This is a list that contains some data of all possible elements. The structure
28 # is as follows:
29 #
30 # 1, "Hydrogen", "H", [0.0,0.0,1.0], 0.32, 0.32, 0.32 , -1 , 1.54   means
31 #
32 # No., name, short name, color, radius (used), radius (covalent), radius (atomic),
33 #
34 # charge state 1, radius (ionic) 1, charge state 2, radius (ionic) 2, ... all
35 # charge states for any atom are listed, if existing.
36 # The list is fixed and cannot be changed ... (see below)
37
38 ELEMENTS_DEFAULT = (
39 ( 1,      "Hydrogen",        "H", (  1.0,   1.0,   1.0), 0.32, 0.32, 0.79 , -1 , 1.54 ),
40 ( 2,        "Helium",       "He", ( 0.85,   1.0,   1.0), 0.93, 0.93, 0.49 ),
41 ( 3,       "Lithium",       "Li", (  0.8,  0.50,   1.0), 1.23, 1.23, 2.05 ,  1 , 0.68 ),
42 ( 4,     "Beryllium",       "Be", ( 0.76,   1.0,   0.0), 0.90, 0.90, 1.40 ,  1 , 0.44 ,  2 , 0.35 ),
43 ( 5,         "Boron",        "B", (  1.0,  0.70,  0.70), 0.82, 0.82, 1.17 ,  1 , 0.35 ,  3 , 0.23 ),
44 ( 6,        "Carbon",        "C", ( 0.56,  0.56,  0.56), 0.77, 0.77, 0.91 , -4 , 2.60 ,  4 , 0.16 ),
45 ( 7,      "Nitrogen",        "N", ( 0.18,  0.31,  0.97), 0.75, 0.75, 0.75 , -3 , 1.71 ,  1 , 0.25 ,  3 , 0.16 ,  5 , 0.13 ),
46 ( 8,        "Oxygen",        "O", (  1.0,  0.05,  0.05), 0.73, 0.73, 0.65 , -2 , 1.32 , -1 , 1.76 ,  1 , 0.22 ,  6 , 0.09 ),
47 ( 9,      "Fluorine",        "F", ( 0.56,  0.87,  0.31), 0.72, 0.72, 0.57 , -1 , 1.33 ,  7 , 0.08 ),
48 (10,          "Neon",       "Ne", ( 0.70,  0.89,  0.96), 0.71, 0.71, 0.51 ,  1 , 1.12 ),
49 (11,        "Sodium",       "Na", ( 0.67,  0.36,  0.94), 1.54, 1.54, 2.23 ,  1 , 0.97 ),
50 (12,     "Magnesium",       "Mg", ( 0.54,   1.0,   0.0), 1.36, 1.36, 1.72 ,  1 , 0.82 ,  2 , 0.66 ),
51 (13,     "Aluminium",       "Al", ( 0.74,  0.65,  0.65), 1.18, 1.18, 1.82 ,  3 , 0.51 ),
52 (14,       "Silicon",       "Si", ( 0.94,  0.78,  0.62), 1.11, 1.11, 1.46 , -4 , 2.71 , -1 , 3.84 ,  1 , 0.65 ,  4 , 0.42 ),
53 (15,    "Phosphorus",        "P", (  1.0,  0.50,   0.0), 1.06, 1.06, 1.23 , -3 , 2.12 ,  3 , 0.44 ,  5 , 0.35 ),
54 (16,        "Sulfur",        "S", (  1.0,   1.0,  0.18), 1.02, 1.02, 1.09 , -2 , 1.84 ,  2 , 2.19 ,  4 , 0.37 ,  6 , 0.30 ),
55 (17,      "Chlorine",       "Cl", ( 0.12,  0.94,  0.12), 0.99, 0.99, 0.97 , -1 , 1.81 ,  5 , 0.34 ,  7 , 0.27 ),
56 (18,         "Argon",       "Ar", ( 0.50,  0.81,  0.89), 0.98, 0.98, 0.88 ,  1 , 1.54 ),
57 (19,     "Potassium",        "K", ( 0.56,  0.25,  0.83), 2.03, 2.03, 2.77 ,  1 , 0.81 ),
58 (20,       "Calcium",       "Ca", ( 0.23,   1.0,   0.0), 1.74, 1.74, 2.23 ,  1 , 1.18 ,  2 , 0.99 ),
59 (21,      "Scandium",       "Sc", ( 0.90,  0.90,  0.90), 1.44, 1.44, 2.09 ,  3 , 0.73 ),
60 (22,      "Titanium",       "Ti", ( 0.74,  0.76,  0.78), 1.32, 1.32, 2.00 ,  1 , 0.96 ,  2 , 0.94 ,  3 , 0.76 ,  4 , 0.68 ),
61 (23,      "Vanadium",        "V", ( 0.65,  0.65,  0.67), 1.22, 1.22, 1.92 ,  2 , 0.88 ,  3 , 0.74 ,  4 , 0.63 ,  5 , 0.59 ),
62 (24,      "Chromium",       "Cr", ( 0.54,   0.6,  0.78), 1.18, 1.18, 1.85 ,  1 , 0.81 ,  2 , 0.89 ,  3 , 0.63 ,  6 , 0.52 ),
63 (25,     "Manganese",       "Mn", ( 0.61,  0.47,  0.78), 1.17, 1.17, 1.79 ,  2 , 0.80 ,  3 , 0.66 ,  4 , 0.60 ,  7 , 0.46 ),
64 (26,          "Iron",       "Fe", ( 0.87,   0.4,   0.2), 1.17, 1.17, 1.72 ,  2 , 0.74 ,  3 , 0.64 ),
65 (27,        "Cobalt",       "Co", ( 0.94,  0.56,  0.62), 1.16, 1.16, 1.67 ,  2 , 0.72 ,  3 , 0.63 ),
66 (28,        "Nickel",       "Ni", ( 0.31,  0.81,  0.31), 1.15, 1.15, 1.62 ,  2 , 0.69 ),
67 (29,        "Copper",       "Cu", ( 0.78,  0.50,   0.2), 1.17, 1.17, 1.57 ,  1 , 0.96 ,  2 , 0.72 ),
68 (30,          "Zinc",       "Zn", ( 0.49,  0.50,  0.69), 1.25, 1.25, 1.53 ,  1 , 0.88 ,  2 , 0.74 ),
69 (31,       "Gallium",       "Ga", ( 0.76,  0.56,  0.56), 1.26, 1.26, 1.81 ,  1 , 0.81 ,  3 , 0.62 ),
70 (32,     "Germanium",       "Ge", (  0.4,  0.56,  0.56), 1.22, 1.22, 1.52 , -4 , 2.72 ,  2 , 0.73 ,  4 , 0.53 ),
71 (33,       "Arsenic",       "As", ( 0.74,  0.50,  0.89), 1.20, 1.20, 1.33 , -3 , 2.22 ,  3 , 0.58 ,  5 , 0.46 ),
72 (34,      "Selenium",       "Se", (  1.0,  0.63,   0.0), 1.16, 1.16, 1.22 , -2 , 1.91 , -1 , 2.32 ,  1 , 0.66 ,  4 , 0.50 ,  6 , 0.42 ),
73 (35,       "Bromine",       "Br", ( 0.65,  0.16,  0.16), 1.14, 1.14, 1.12 , -1 , 1.96 ,  5 , 0.47 ,  7 , 0.39 ),
74 (36,       "Krypton",       "Kr", ( 0.36,  0.72,  0.81), 1.31, 1.31, 1.24 ),
75 (37,      "Rubidium",       "Rb", ( 0.43,  0.18,  0.69), 2.16, 2.16, 2.98 ,  1 , 1.47 ),
76 (38,     "Strontium",       "Sr", (  0.0,   1.0,   0.0), 1.91, 1.91, 2.45 ,  2 , 1.12 ),
77 (39,       "Yttrium",        "Y", ( 0.58,   1.0,   1.0), 1.62, 1.62, 2.27 ,  3 , 0.89 ),
78 (40,     "Zirconium",       "Zr", ( 0.58,  0.87,  0.87), 1.45, 1.45, 2.16 ,  1 , 1.09 ,  4 , 0.79 ),
79 (41,       "Niobium",       "Nb", ( 0.45,  0.76,  0.78), 1.34, 1.34, 2.08 ,  1 , 1.00 ,  4 , 0.74 ,  5 , 0.69 ),
80 (42,    "Molybdenum",       "Mo", ( 0.32,  0.70,  0.70), 1.30, 1.30, 2.01 ,  1 , 0.93 ,  4 , 0.70 ,  6 , 0.62 ),
81 (43,    "Technetium",       "Tc", ( 0.23,  0.61,  0.61), 1.27, 1.27, 1.95 ,  7 , 0.97 ),
82 (44,     "Ruthenium",       "Ru", ( 0.14,  0.56,  0.56), 1.25, 1.25, 1.89 ,  4 , 0.67 ),
83 (45,       "Rhodium",       "Rh", ( 0.03,  0.49,  0.54), 1.25, 1.25, 1.83 ,  3 , 0.68 ),
84 (46,     "Palladium",       "Pd", (  0.0,  0.41,  0.52), 1.28, 1.28, 1.79 ,  2 , 0.80 ,  4 , 0.65 ),
85 (47,        "Silver",       "Ag", ( 0.75,  0.75,  0.75), 1.34, 1.34, 1.75 ,  1 , 1.26 ,  2 , 0.89 ),
86 (48,       "Cadmium",       "Cd", (  1.0,  0.85,  0.56), 1.48, 1.48, 1.71 ,  1 , 1.14 ,  2 , 0.97 ),
87 (49,        "Indium",       "In", ( 0.65,  0.45,  0.45), 1.44, 1.44, 2.00 ,  3 , 0.81 ),
88 (50,           "Tin",       "Sn", (  0.4,  0.50,  0.50), 1.41, 1.41, 1.72 , -4 , 2.94 , -1 , 3.70 ,  2 , 0.93 ,  4 , 0.71 ),
89 (51,      "Antimony",       "Sb", ( 0.61,  0.38,  0.70), 1.40, 1.40, 1.53 , -3 , 2.45 ,  3 , 0.76 ,  5 , 0.62 ),
90 (52,     "Tellurium",       "Te", ( 0.83,  0.47,   0.0), 1.36, 1.36, 1.42 , -2 , 2.11 , -1 , 2.50 ,  1 , 0.82 ,  4 , 0.70 ,  6 , 0.56 ),
91 (53,        "Iodine",        "I", ( 0.58,   0.0,  0.58), 1.33, 1.33, 1.32 , -1 , 2.20 ,  5 , 0.62 ,  7 , 0.50 ),
92 (54,         "Xenon",       "Xe", ( 0.25,  0.61,  0.69), 1.31, 1.31, 1.24 ),
93 (55,       "Caesium",       "Cs", ( 0.34,  0.09,  0.56), 2.35, 2.35, 3.35 ,  1 , 1.67 ),
94 (56,        "Barium",       "Ba", (  0.0,  0.78,   0.0), 1.98, 1.98, 2.78 ,  1 , 1.53 ,  2 , 1.34 ),
95 (57,     "Lanthanum",       "La", ( 0.43,  0.83,   1.0), 1.69, 1.69, 2.74 ,  1 , 1.39 ,  3 , 1.06 ),
96 (58,        "Cerium",       "Ce", (  1.0,   1.0,  0.78), 1.65, 1.65, 2.70 ,  1 , 1.27 ,  3 , 1.03 ,  4 , 0.92 ),
97 (59,  "Praseodymium",       "Pr", ( 0.85,   1.0,  0.78), 1.65, 1.65, 2.67 ,  3 , 1.01 ,  4 , 0.90 ),
98 (60,     "Neodymium",       "Nd", ( 0.78,   1.0,  0.78), 1.64, 1.64, 2.64 ,  3 , 0.99 ),
99 (61,    "Promethium",       "Pm", ( 0.63,   1.0,  0.78), 1.63, 1.63, 2.62 ,  3 , 0.97 ),
100 (62,      "Samarium",       "Sm", ( 0.56,   1.0,  0.78), 1.62, 1.62, 2.59 ,  3 , 0.96 ),
101 (63,      "Europium",       "Eu", ( 0.38,   1.0,  0.78), 1.85, 1.85, 2.56 ,  2 , 1.09 ,  3 , 0.95 ),
102 (64,    "Gadolinium",       "Gd", ( 0.27,   1.0,  0.78), 1.61, 1.61, 2.54 ,  3 , 0.93 ),
103 (65,       "Terbium",       "Tb", ( 0.18,   1.0,  0.78), 1.59, 1.59, 2.51 ,  3 , 0.92 ,  4 , 0.84 ),
104 (66,    "Dysprosium",       "Dy", ( 0.12,   1.0,  0.78), 1.59, 1.59, 2.49 ,  3 , 0.90 ),
105 (67,       "Holmium",       "Ho", (  0.0,   1.0,  0.61), 1.58, 1.58, 2.47 ,  3 , 0.89 ),
106 (68,        "Erbium",       "Er", (  0.0,  0.90,  0.45), 1.57, 1.57, 2.45 ,  3 , 0.88 ),
107 (69,       "Thulium",       "Tm", (  0.0,  0.83,  0.32), 1.56, 1.56, 2.42 ,  3 , 0.87 ),
108 (70,     "Ytterbium",       "Yb", (  0.0,  0.74,  0.21), 1.74, 1.74, 2.40 ,  2 , 0.93 ,  3 , 0.85 ),
109 (71,      "Lutetium",       "Lu", (  0.0,  0.67,  0.14), 1.56, 1.56, 2.25 ,  3 , 0.85 ),
110 (72,       "Hafnium",       "Hf", ( 0.30,  0.76,   1.0), 1.44, 1.44, 2.16 ,  4 , 0.78 ),
111 (73,      "Tantalum",       "Ta", ( 0.30,  0.65,   1.0), 1.34, 1.34, 2.09 ,  5 , 0.68 ),
112 (74,      "Tungsten",        "W", ( 0.12,  0.58,  0.83), 1.30, 1.30, 2.02 ,  4 , 0.70 ,  6 , 0.62 ),
113 (75,       "Rhenium",       "Re", ( 0.14,  0.49,  0.67), 1.28, 1.28, 1.97 ,  4 , 0.72 ,  7 , 0.56 ),
114 (76,        "Osmium",       "Os", ( 0.14,   0.4,  0.58), 1.26, 1.26, 1.92 ,  4 , 0.88 ,  6 , 0.69 ),
115 (77,       "Iridium",       "Ir", ( 0.09,  0.32,  0.52), 1.27, 1.27, 1.87 ,  4 , 0.68 ),
116 (78,     "Platinium",       "Pt", ( 0.81,  0.81,  0.87), 1.30, 1.30, 1.83 ,  2 , 0.80 ,  4 , 0.65 ),
117 (79,          "Gold",       "Au", (  1.0,  0.81,  0.13), 1.34, 1.34, 1.79 ,  1 , 1.37 ,  3 , 0.85 ),
118 (80,       "Mercury",       "Hg", ( 0.72,  0.72,  0.81), 1.49, 1.49, 1.76 ,  1 , 1.27 ,  2 , 1.10 ),
119 (81,      "Thallium",       "Tl", ( 0.65,  0.32,  0.30), 1.48, 1.48, 2.08 ,  1 , 1.47 ,  3 , 0.95 ),
120 (82,          "Lead",       "Pb", ( 0.34,  0.34,  0.38), 1.47, 1.47, 1.81 ,  2 , 1.20 ,  4 , 0.84 ),
121 (83,       "Bismuth",       "Bi", ( 0.61,  0.30,  0.70), 1.46, 1.46, 1.63 ,  1 , 0.98 ,  3 , 0.96 ,  5 , 0.74 ),
122 (84,      "Polonium",       "Po", ( 0.67,  0.36,   0.0), 1.46, 1.46, 1.53 ,  6 , 0.67 ),
123 (85,      "Astatine",       "At", ( 0.45,  0.30,  0.27), 1.45, 1.45, 1.43 , -3 , 2.22 ,  3 , 0.85 ,  5 , 0.46 ),
124 (86,         "Radon",       "Rn", ( 0.25,  0.50,  0.58), 1.00, 1.00, 1.34 ),
125 (87,      "Francium",       "Fr", ( 0.25,   0.0,   0.4), 1.00, 1.00, 1.00 ,  1 , 1.80 ),
126 (88,        "Radium",       "Ra", (  0.0,  0.49,   0.0), 1.00, 1.00, 1.00 ,  2 , 1.43 ),
127 (89,      "Actinium",       "Ac", ( 0.43,  0.67,  0.98), 1.00, 1.00, 1.00 ,  3 , 1.18 ),
128 (90,       "Thorium",       "Th", (  0.0,  0.72,   1.0), 1.65, 1.65, 1.00 ,  4 , 1.02 ),
129 (91,  "Protactinium",       "Pa", (  0.0,  0.63,   1.0), 1.00, 1.00, 1.00 ,  3 , 1.13 ,  4 , 0.98 ,  5 , 0.89 ),
130 (92,       "Uranium",        "U", (  0.0,  0.56,   1.0), 1.42, 1.42, 1.00 ,  4 , 0.97 ,  6 , 0.80 ),
131 (93,     "Neptunium",       "Np", (  0.0,  0.50,   1.0), 1.00, 1.00, 1.00 ,  3 , 1.10 ,  4 , 0.95 ,  7 , 0.71 ),
132 (94,     "Plutonium",       "Pu", (  0.0,  0.41,   1.0), 1.00, 1.00, 1.00 ,  3 , 1.08 ,  4 , 0.93 ),
133 (95,     "Americium",       "Am", ( 0.32,  0.36,  0.94), 1.00, 1.00, 1.00 ,  3 , 1.07 ,  4 , 0.92 ),
134 (96,        "Curium",       "Cm", ( 0.47,  0.36,  0.89), 1.00, 1.00, 1.00 ),
135 (97,     "Berkelium",       "Bk", ( 0.54,  0.30,  0.89), 1.00, 1.00, 1.00 ),
136 (98,   "Californium",       "Cf", ( 0.63,  0.21,  0.83), 1.00, 1.00, 1.00 ),
137 (99,   "Einsteinium",       "Es", ( 0.70,  0.12,  0.83), 1.00, 1.00, 1.00 ),
138 (100,       "Fermium",       "Fm", ( 0.70,  0.12,  0.72), 1.00, 1.00, 1.00 ),
139 (101,   "Mendelevium",       "Md", ( 0.70,  0.05,  0.65), 1.00, 1.00, 1.00 ),
140 (102,      "Nobelium",       "No", ( 0.74,  0.05,  0.52), 1.00, 1.00, 1.00 ),
141 (103,    "Lawrencium",       "Lr", ( 0.78,   0.0,   0.4), 1.00, 1.00, 1.00 ),
142 (104,       "Vacancy",      "Vac", (  0.5,   0.5,   0.5), 1.00, 1.00, 1.00),
143 (105,       "Default",  "Default", (  1.0,   1.0,   1.0), 1.00, 1.00, 1.00),
144 (106,         "Stick",    "Stick", (  0.5,   0.5,   0.5), 1.00, 1.00, 1.00),
145 )
146
147 # This list here contains all data of the elements and will be used during
148 # runtime. It is a list of classes.
149 # During executing Atomic Blender, the list will be initialized with the fixed
150 # data from above via the class structure below (ElementProp). We
151 # have then one fixed list (above), which will never be changed, and a list of
152 # classes with same data. The latter can be modified via loading a separate
153 # custom data file for instance.
154 ELEMENTS = []
155
156 # This is the list, which contains all atoms of all frames! Each item is a
157 # list which contains the atoms of a single frame. It is a list of
158 # 'AtomProp'.
159 ALL_FRAMES = []
160
161 # A list of ALL balls which are put into the scene
162 STRUCTURE = []
163
164
165 # This is the class, which stores the properties for one element.
166 class ElementProp(object):
167     __slots__ = ('number', 'name', 'short_name', 'color', 'radii', 'radii_ionic')
168     def __init__(self, number, name, short_name, color, radii, radii_ionic):
169         self.number = number
170         self.name = name
171         self.short_name = short_name
172         self.color = color
173         self.radii = radii
174         self.radii_ionic = radii_ionic
175
176 # This is the class, which stores the properties of one atom.
177 class AtomProp(object):
178     __slots__ = ('element', 'name', 'location', 'radius', 'color', 'material')
179     def __init__(self, element, name, location, radius, color, material):
180         self.element = element
181         self.name = name
182         self.location = location
183         self.radius = radius
184         self.color = color
185         self.material = material
186
187
188 # -----------------------------------------------------------------------------
189 #                                                           Some basic routines
190
191 def read_elements():
192
193     del ELEMENTS[:]
194
195     for item in ELEMENTS_DEFAULT:
196
197         # All three radii into a list
198         radii = [item[4],item[5],item[6]]
199         # The handling of the ionic radii will be done later. So far, it is an
200         # empty list.
201         radii_ionic = []
202
203         li = ElementProp(item[0],item[1],item[2],item[3],
204                                      radii,radii_ionic)
205         ELEMENTS.append(li)
206
207
208 # filepath_pdb: path to pdb file
209 # radiustype  : '0' default
210 #               '1' atomic radii
211 #               '2' van der Waals
212 def read_xyz_file(filepath_xyz,radiustype):
213
214     number_frames = 0
215     total_number_atoms = 0
216
217     # Open the file ...
218     filepath_xyz_p = open(filepath_xyz, "r")
219
220     #Go through the whole file.
221     FLAG = False
222     for line in filepath_xyz_p:
223
224         # ... the loop is broken here (EOF) ...
225         if line == "":
226             continue
227
228         split_list = line.rsplit()
229
230         if len(split_list) == 1:
231             number_atoms = int(split_list[0])
232             FLAG = True
233
234         if FLAG == True:
235
236             line = filepath_xyz_p.readline()
237             line = line.rstrip()
238
239             all_atoms= []
240             for i in range(number_atoms):
241
242
243                 # This is a guarantee that only the total number of atoms of the
244                 # first frame is used. Condition is, so far, that the number of
245                 # atoms in a xyz file is constant. However, sometimes the number
246                 # may increase (or decrease). If it decreases, the addon crashes.
247                 # If it increases, only the tot number of atoms of the first frame
248                 # is used.
249                 # By time, I will allow varying atom numbers ... but this takes
250                 # some time ...
251                 if number_frames != 0:
252                     if i >= total_number_atoms:
253                         break
254
255
256                 line = filepath_xyz_p.readline()
257                 line = line.rstrip()
258                 split_list = line.rsplit()
259                 short_name = str(split_list[0])
260
261                 # Go through all elements and find the element of the current atom.
262                 FLAG_FOUND = False
263                 for element in ELEMENTS:
264                     if str.upper(short_name) == str.upper(element.short_name):
265                         # Give the atom its proper name, color and radius:
266                         name = element.name
267                         # int(radiustype) => type of radius:
268                         # pre-defined (0), atomic (1) or van der Waals (2)
269                         radius = float(element.radii[int(radiustype)])
270                         color = element.color
271                         FLAG_FOUND = True
272                         break
273
274                 # Is it a vacancy or an 'unknown atom' ?
275                 if FLAG_FOUND == False:
276                     # Give this atom also a name. If it is an 'X' then it is a
277                     # vacancy. Otherwise ...
278                     if "X" in short_name:
279                         short_name = "VAC"
280                         name = "Vacancy"
281                         radius = float(ELEMENTS[-3].radii[int(radiustype)])
282                         color = ELEMENTS[-3].color
283                     # ... take what is written in the xyz file. These are somewhat
284                     # unknown atoms. This should never happen, the element list is
285                     # almost complete. However, we do this due to security reasons.
286                     else:
287                         name = str.upper(short_name)
288                         radius = float(ELEMENTS[-2].radii[int(radiustype)])
289                         color = ELEMENTS[-2].color
290
291                 x = float(split_list[1])
292                 y = float(split_list[2])
293                 z = float(split_list[3])
294
295                 location = Vector((x,y,z))
296
297                 all_atoms.append([short_name, name, location, radius, color])
298
299             # We note here all elements. This needs to be done only once.
300             if number_frames == 0:
301
302                 # This is a guarantee that only the total number of atoms of the
303                 # first frame is used. Condition is, so far, that the number of
304                 # atoms in a xyz file is constant. However, sometimes the number
305                 # may increase (or decrease). If it decreases, the addon crashes.
306                 # If it increases, only the tot number of atoms of the first frame
307                 # is used.
308                 # By time, I will allow varying atom numbers ... but this takes
309                 # some time ...
310                 total_number_atoms = number_atoms
311
312
313                 elements = []
314                 for atom in all_atoms:
315                     FLAG_FOUND = False
316                     for element in elements:
317                         # If the atom name is already in the list,
318                         # FLAG on 'True'.
319                         if element == atom[1]:
320                             FLAG_FOUND = True
321                             break
322                     # No name in the current list has been found? => New entry.
323                     if FLAG_FOUND == False:
324                         # Stored are: Atom label (e.g. 'Na'), the corresponding
325                         # atom name (e.g. 'Sodium') and its color.
326                         elements.append(atom[1])
327
328             # Sort the atoms: create lists of atoms of one type
329             structure = []
330             for element in elements:
331                 atoms_one_type = []
332                 for atom in all_atoms:
333                     if atom[1] == element:
334                         atoms_one_type.append(AtomProp(atom[0],
335                                                        atom[1],
336                                                        atom[2],
337                                                        atom[3],
338                                                        atom[4],[]))
339                 structure.append(atoms_one_type)
340
341             ALL_FRAMES.append(structure)
342             number_frames += 1
343             FLAG = False
344
345     filepath_xyz_p.close()
346
347     return total_number_atoms
348
349
350 # -----------------------------------------------------------------------------
351 #                                                            The main routine
352
353 def import_xyz(Ball_type,
354                Ball_azimuth,
355                Ball_zenith,
356                Ball_radius_factor,
357                radiustype,
358                Ball_distance_factor,
359                put_to_center,
360                put_to_center_all,
361                use_camera,
362                use_lamp,
363                filepath_xyz):
364
365     # List of materials
366     atom_material_list = []
367
368     # ------------------------------------------------------------------------
369     # INITIALIZE THE ELEMENT LIST
370
371     read_elements()
372
373     # ------------------------------------------------------------------------
374     # READING DATA OF ATOMS
375
376     Number_of_total_atoms = read_xyz_file(filepath_xyz,
377                                                        radiustype)
378
379     # We show the atoms of the first frame.
380     first_frame = ALL_FRAMES[0]
381
382     # ------------------------------------------------------------------------
383     # MATERIAL PROPERTIES FOR ATOMS
384
385     # Create first a new list of materials for each type of atom
386     # (e.g. hydrogen)
387     for atoms_of_one_type in first_frame:
388         # Take the first atom
389         atom = atoms_of_one_type[0]
390         material = bpy.data.materials.new(atom.name)
391         material.name = atom.name
392         material.diffuse_color = atom.color
393         atom_material_list.append(material)
394
395     # Now, we go through all atoms and give them a material. For all atoms ...
396     for atoms_of_one_type in first_frame:
397         for atom in atoms_of_one_type:
398             # ... and all materials ...
399             for material in atom_material_list:
400                 # ... select the correct material for the current atom via
401                 # comparison of names ...
402                 if atom.name in material.name:
403                     # ... and give the atom its material properties.
404                     # However, before we check if it is a vacancy
405                     # The vacancy is represented by a transparent cube.
406                     if atom.name == "Vacancy":
407                         material.transparency_method = 'Z_TRANSPARENCY'
408                         material.alpha = 1.3
409                         material.raytrace_transparency.fresnel = 1.6
410                         material.raytrace_transparency.fresnel_factor = 1.6
411                         material.use_transparency = True
412                     # The atom gets its properties.
413                     atom.material = material
414
415     # ------------------------------------------------------------------------
416     # TRANSLATION OF THE STRUCTURE TO THE ORIGIN
417
418     # It may happen that the structure in a XYZ file already has an offset
419
420
421     # If chosen, the structure is put into the center of the scene
422     # (only the first frame).
423     if put_to_center == True and put_to_center_all == False:
424
425         sum_vec = Vector((0.0,0.0,0.0))
426
427         # Sum of all atom coordinates
428         for atoms_of_one_type in first_frame:
429             sum_vec = sum([atom.location for atom in atoms_of_one_type], sum_vec)
430
431         # Then the average is taken
432         sum_vec = sum_vec / Number_of_total_atoms
433
434         # After, for each atom the center of gravity is substracted
435         for atoms_of_one_type in first_frame:
436             for atom in atoms_of_one_type:
437                 atom.location -= sum_vec
438
439     # If chosen, the structure is put into the center of the scene
440     # (all frames).
441     if put_to_center_all == True:
442
443         # For all frames
444         for frame in ALL_FRAMES:
445
446             sum_vec = Vector((0.0,0.0,0.0))
447
448             # Sum of all atom coordinates
449             for (i, atoms_of_one_type) in enumerate(frame):
450
451                 # This is a guarantee that only the total number of atoms of the
452                 # first frame is used. Condition is, so far, that the number of
453                 # atoms in a xyz file is constant. However, sometimes the number
454                 # may increase (or decrease). If it decreases, the addon crashes.
455                 # If it increases, only the tot number of atoms of the first frame
456                 # is used.
457                 # By time, I will allow varying atom numbers ... but this takes
458                 # some time ...
459                 if i >= Number_of_total_atoms:
460                     break
461
462                 sum_vec = sum([atom.location for atom in atoms_of_one_type], sum_vec)
463
464             # Then the average is taken
465             sum_vec = sum_vec / Number_of_total_atoms
466
467             # After, for each atom the center of gravity is substracted
468             for atoms_of_one_type in frame:
469                 for atom in atoms_of_one_type:
470                     atom.location -= sum_vec
471
472
473     # ------------------------------------------------------------------------
474     # SCALING
475
476     # Take all atoms and adjust their radii and scale the distances.
477     for atoms_of_one_type in first_frame:
478         for atom in atoms_of_one_type:
479             atom.location *= Ball_distance_factor
480
481     # ------------------------------------------------------------------------
482     # DETERMINATION OF SOME GEOMETRIC PROPERTIES
483
484     # In the following, some geometric properties of the whole object are
485     # determined: center, size, etc.
486     sum_vec = Vector((0.0,0.0,0.0))
487
488     # First the center is determined. All coordinates are summed up ...
489     for atoms_of_one_type in first_frame:
490         sum_vec = sum([atom.location for atom in atoms_of_one_type], sum_vec)
491
492     # ... and the average is taken. This gives the center of the object.
493     object_center_vec = sum_vec / Number_of_total_atoms
494
495     # Now, we determine the size.The farthest atom from the object center is
496     # taken as a measure. The size is used to place well the camera and light
497     # into the scene.
498
499     object_size_vec = []
500     for atoms_of_one_type in first_frame:
501         object_size_vec += [atom.location - object_center_vec for atom in atoms_of_one_type]
502
503     object_size = 0.0
504     object_size = max(object_size_vec).length
505
506     # ------------------------------------------------------------------------
507     # CAMERA AND LAMP
508     camera_factor = 20.0
509
510     # If chosen a camera is put into the scene.
511     if use_camera == True:
512
513         # Assume that the object is put into the global origin. Then, the
514         # camera is moved in x and z direction, not in y. The object has its
515         # size at distance sqrt(object_size) from the origin. So, move the
516         # camera by this distance times a factor of camera_factor in x and z.
517         # Then add x, y and z of the origin of the object.
518         object_camera_vec = Vector((sqrt(object_size) * camera_factor,
519                                     0.0,
520                                     sqrt(object_size) * camera_factor))
521         camera_xyz_vec = object_center_vec + object_camera_vec
522
523         # Create the camera
524         current_layers=bpy.context.scene.layers
525         camera_data = bpy.data.cameras.new("A_camera")
526         camera_data.lens = 45
527         camera_data.clip_end = 500.0
528         camera = bpy.data.objects.new("A_camera", camera_data)
529         camera.location = camera_xyz_vec
530         camera.layers = current_layers
531         bpy.context.scene.objects.link(camera)
532
533         # Here the camera is rotated such it looks towards the center of
534         # the object. The [0.0, 0.0, 1.0] vector along the z axis
535         z_axis_vec             = Vector((0.0, 0.0, 1.0))
536         # The angle between the last two vectors
537         angle                  = object_camera_vec.angle(z_axis_vec, 0)
538         # The cross-product of z_axis_vec and object_camera_vec
539         axis_vec               = z_axis_vec.cross(object_camera_vec)
540         # Rotate 'axis_vec' by 'angle' and convert this to euler parameters.
541         # 4 is the size of the matrix.
542         camera.rotation_euler  = Matrix.Rotation(angle, 4, axis_vec).to_euler()
543
544         # Rotate the camera around its axis by 90° such that we have a nice
545         # camera position and view onto the object.
546         bpy.ops.object.select_all(action='DESELECT')
547         camera.select_set(True)
548         bpy.ops.transform.rotate(value=(90.0*2*pi/360.0),
549                                  axis=object_camera_vec,
550                                  constraint_axis=(False, False, False),
551                                  constraint_orientation='GLOBAL',
552                                  mirror=False, proportional='DISABLED',
553                                  proportional_edit_falloff='SMOOTH',
554                                  proportional_size=1, snap=False,
555                                  snap_target='CLOSEST', snap_point=(0, 0, 0),
556                                  snap_align=False, snap_normal=(0, 0, 0),
557                                  release_confirm=False)
558
559     # Here a lamp is put into the scene, if chosen.
560     if use_lamp == True:
561
562         # This is the distance from the object measured in terms of %
563         # of the camera distance. It is set onto 50% (1/2) distance.
564         lamp_dl = sqrt(object_size) * 15 * 0.5
565         # This is a factor to which extend the lamp shall go to the right
566         # (from the camera  point of view).
567         lamp_dy_right = lamp_dl * (3.0/4.0)
568
569         # Create x, y and z for the lamp.
570         object_lamp_vec = Vector((lamp_dl,lamp_dy_right,lamp_dl))
571         lamp_xyz_vec = object_center_vec + object_lamp_vec
572
573         # Create the lamp
574         current_layers=bpy.context.scene.layers
575         lamp_data = bpy.data.lamps.new(name="A_lamp", type="POINT")
576         lamp_data.distance = 500.0
577         lamp_data.energy = 3.0
578         lamp_data.shadow_method = 'RAY_SHADOW'
579         lamp = bpy.data.objects.new("A_lamp", lamp_data)
580         lamp.location = lamp_xyz_vec
581         lamp.layers = current_layers
582         bpy.context.scene.objects.link(lamp)
583
584         bpy.context.scene.world.light_settings.use_ambient_occlusion = True
585         bpy.context.scene.world.light_settings.ao_factor = 0.2
586
587
588     # ------------------------------------------------------------------------
589     # DRAWING THE ATOMS
590
591     bpy.ops.object.select_all(action='DESELECT')
592
593     # For each list of atoms of ONE type (e.g. Hydrogen)
594     for atoms_of_one_type in first_frame:
595
596         # Create first the vertices composed of the coordinates of all
597         # atoms of one type
598         atom_vertices = []
599         for atom in atoms_of_one_type:
600             # In fact, the object is created in the World's origin.
601             # This is why 'object_center_vec' is substracted. At the end
602             # the whole object is translated back to 'object_center_vec'.
603             atom_vertices.append( atom.location - object_center_vec )
604
605         # Build the mesh
606         atom_mesh = bpy.data.meshes.new("Mesh_"+atom.name)
607         atom_mesh.from_pydata(atom_vertices, [], [])
608         atom_mesh.update()
609         new_atom_mesh = bpy.data.objects.new(atom.name, atom_mesh)
610         bpy.context.scene.objects.link(new_atom_mesh)
611
612         # Now, build a representative sphere (atom)
613         current_layers=bpy.context.scene.layers
614
615         if atom.name == "Vacancy":
616             bpy.ops.mesh.primitive_cube_add(
617                             view_align=False, enter_editmode=False,
618                             location=(0.0, 0.0, 0.0),
619                             rotation=(0.0, 0.0, 0.0),
620                             layers=current_layers)
621         else:
622             # NURBS balls
623             if Ball_type == "0":
624                 bpy.ops.surface.primitive_nurbs_surface_sphere_add(
625                             view_align=False, enter_editmode=False,
626                             location=(0,0,0), rotation=(0.0, 0.0, 0.0),
627                             layers=current_layers)
628             # UV balls
629             elif Ball_type == "1":
630                 bpy.ops.mesh.primitive_uv_sphere_add(
631                             segments=Ball_azimuth, ring_count=Ball_zenith,
632                             size=1, view_align=False, enter_editmode=False,
633                             location=(0,0,0), rotation=(0, 0, 0),
634                             layers=current_layers)
635             # Meta balls
636             elif Ball_type == "2":
637                 bpy.ops.object.metaball_add(type='BALL', view_align=False,
638                             enter_editmode=False, location=(0, 0, 0),
639                             rotation=(0, 0, 0), layers=current_layers)
640
641         ball = bpy.context.view_layer.objects.active
642         ball.scale  = (atom.radius*Ball_radius_factor,) * 3
643
644         if atom.name == "Vacancy":
645             ball.name = "Cube_"+atom.name
646         else:
647             ball.name = "Ball (NURBS)_"+atom.name
648         ball.active_material = atom.material
649         ball.parent = new_atom_mesh
650         new_atom_mesh.instance_type = 'VERTS'
651         # The object is back translated to 'object_center_vec'.
652         new_atom_mesh.location = object_center_vec
653         STRUCTURE.append(new_atom_mesh)
654
655     # ------------------------------------------------------------------------
656     # SELECT ALL LOADED OBJECTS
657
658     bpy.ops.object.select_all(action='DESELECT')
659     obj = None
660     for obj in STRUCTURE:
661         obj.select_set(True)
662     # activate the last selected object (perhaps another should be active?)
663     if obj:
664         bpy.context.view_layer.objects.active = obj
665
666
667
668 def build_frames(frame_delta, frame_skip):
669
670     scn = bpy.context.scene
671
672     # Introduce the basis for all elements that appear in the structure.
673     for element in STRUCTURE:
674
675         bpy.ops.object.select_all(action='DESELECT')
676         bpy.context.view_layer.objects.active = element
677         element.select_set(True)
678         bpy.ops.object.shape_key_add(True)
679
680     frame_skip += 1
681
682     # Introduce the keys and reference the atom positions for each key.
683     i = 0
684     for j, frame in enumerate(ALL_FRAMES):
685
686         if j % frame_skip == 0:
687
688             for elements_frame, elements_structure in zip(frame,STRUCTURE):
689
690                 key = elements_structure.shape_key_add()
691
692                 for atom_frame, atom_structure in zip(elements_frame, key.data):
693
694                     atom_structure.co = (atom_frame.location
695                                        - elements_structure.location)
696
697                 key.name = atom_frame.name + "_frame_" + str(i)
698
699             i += 1
700
701     num_frames = i
702
703     scn.frame_start = 0
704     scn.frame_end = frame_delta * num_frames
705
706     # Manage the values of the keys
707     for element in STRUCTURE:
708
709         scn.frame_current = 0
710
711         element.data.shape_keys.key_blocks[1].value = 1.0
712         element.data.shape_keys.key_blocks[2].value = 0.0
713         element.data.shape_keys.key_blocks[1].keyframe_insert("value")
714         element.data.shape_keys.key_blocks[2].keyframe_insert("value")
715
716         scn.frame_current += frame_delta
717
718         number = 0
719
720         for number in range(num_frames)[2:]:#-1]:
721
722             element.data.shape_keys.key_blocks[number-1].value = 0.0
723             element.data.shape_keys.key_blocks[number].value = 1.0
724             element.data.shape_keys.key_blocks[number+1].value = 0.0
725             element.data.shape_keys.key_blocks[number-1].keyframe_insert("value")
726             element.data.shape_keys.key_blocks[number].keyframe_insert("value")
727             element.data.shape_keys.key_blocks[number+1].keyframe_insert("value")
728
729             scn.frame_current += frame_delta
730
731         number += 1
732
733         element.data.shape_keys.key_blocks[number].value = 1.0
734         element.data.shape_keys.key_blocks[number-1].value = 0.0
735         element.data.shape_keys.key_blocks[number].keyframe_insert("value")
736         element.data.shape_keys.key_blocks[number-1].keyframe_insert("value")