- generate sphinx docs for bpy_extras module
[blender.git] / release / scripts / modules / bpy_extras / io_utils.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 # <pep8 compliant>
20
21 __all__ = (
22     "ExportHelper",
23     "ImportHelper",
24     "axis_conversion",
25     "load_image",
26     "create_derived_objects",
27     "free_derived_objects",
28     "unpack_list",
29     "unpack_face_list",
30     "path_reference",
31     "path_reference_copy",
32     "path_reference_mode",
33 )
34
35 import bpy
36 from bpy.props import StringProperty, BoolProperty, EnumProperty
37
38
39 class ExportHelper:
40     filepath = StringProperty(name="File Path", description="Filepath used for exporting the file", maxlen=1024, default="", subtype='FILE_PATH')
41     check_existing = BoolProperty(name="Check Existing", description="Check and warn on overwriting existing files", default=True, options={'HIDDEN'})
42
43     # subclasses can override with decorator
44     # True == use ext, False == no ext, None == do nothing.
45     check_extension = True
46
47     def invoke(self, context, event):
48         import os
49         if not self.filepath:
50             blend_filepath = context.blend_data.filepath
51             if not blend_filepath:
52                 blend_filepath = "untitled"
53             else:
54                 blend_filepath = os.path.splitext(blend_filepath)[0]
55
56             self.filepath = blend_filepath + self.filename_ext
57
58         context.window_manager.fileselect_add(self)
59         return {'RUNNING_MODAL'}
60
61     def check(self, context):
62         check_extension = self.check_extension
63
64         if check_extension is None:
65             return False
66
67         filepath = bpy.path.ensure_ext(self.filepath, self.filename_ext if check_extension else "")
68
69         if filepath != self.filepath:
70             self.filepath = filepath
71             return True
72
73         return False
74
75
76 class ImportHelper:
77     filepath = StringProperty(name="File Path", description="Filepath used for importing the file", maxlen=1024, default="", subtype='FILE_PATH')
78
79     def invoke(self, context, event):
80         context.window_manager.fileselect_add(self)
81         return {'RUNNING_MODAL'}
82
83
84 # Axis conversion function, not pretty LUT
85 # use lookup tabes to convert between any axis
86 _axis_convert_matrix = (
87     ((-1.0, 0.0, 0.0), (0.0, -1.0, 0.0), (0.0, 0.0, 1.0)),
88     ((-1.0, 0.0, 0.0), (0.0, 0.0, -1.0), (0.0, -1.0, 0.0)),
89     ((-1.0, 0.0, 0.0), (0.0, 0.0, 1.0), (0.0, 1.0, 0.0)),
90     ((-1.0, 0.0, 0.0), (0.0, 1.0, 0.0), (0.0, 0.0, -1.0)),
91     ((0.0, -1.0, 0.0), (-1.0, 0.0, 0.0), (0.0, 0.0, -1.0)),
92     ((0.0, -1.0, 0.0), (0.0, 0.0, -1.0), (1.0, 0.0, 0.0)),
93     ((0.0, -1.0, 0.0), (0.0, 0.0, 1.0), (-1.0, 0.0, 0.0)),
94     ((0.0, -1.0, 0.0), (1.0, 0.0, 0.0), (0.0, 0.0, 1.0)),
95     ((0.0, 0.0, -1.0), (-1.0, 0.0, 0.0), (0.0, 1.0, 0.0)),
96     ((0.0, 0.0, -1.0), (0.0, -1.0, 0.0), (-1.0, 0.0, 0.0)),
97     ((0.0, 0.0, -1.0), (0.0, 1.0, 0.0), (1.0, 0.0, 0.0)),
98     ((0.0, 0.0, -1.0), (1.0, 0.0, 0.0), (0.0, -1.0, 0.0)),
99     ((0.0, 0.0, 1.0), (-1.0, 0.0, 0.0), (0.0, -1.0, 0.0)),
100     ((0.0, 0.0, 1.0), (0.0, -1.0, 0.0), (1.0, 0.0, 0.0)),
101     ((0.0, 0.0, 1.0), (0.0, 1.0, 0.0), (-1.0, 0.0, 0.0)),
102     ((0.0, 0.0, 1.0), (1.0, 0.0, 0.0), (0.0, 1.0, 0.0)),
103     ((0.0, 1.0, 0.0), (-1.0, 0.0, 0.0), (0.0, 0.0, 1.0)),
104     ((0.0, 1.0, 0.0), (0.0, 0.0, -1.0), (-1.0, 0.0, 0.0)),
105     ((0.0, 1.0, 0.0), (0.0, 0.0, 1.0), (1.0, 0.0, 0.0)),
106     ((0.0, 1.0, 0.0), (1.0, 0.0, 0.0), (0.0, 0.0, -1.0)),
107     ((1.0, 0.0, 0.0), (0.0, -1.0, 0.0), (0.0, 0.0, -1.0)),
108     ((1.0, 0.0, 0.0), (0.0, 0.0, -1.0), (0.0, 1.0, 0.0)),
109     ((1.0, 0.0, 0.0), (0.0, 0.0, 1.0), (0.0, -1.0, 0.0)),
110     )
111
112 # store args as a single int
113 # (X Y Z -X -Y -Z) --> (0, 1, 2, 3, 4, 5)
114 # each value is ((src_forward, src_up), (dst_forward, dst_up))
115 # where all 4 values are or'd into a single value...
116 #    (i1<<0 | i1<<3 | i1<<6 | i1<<9)
117 _axis_convert_lut = (
118     {0x8C8, 0x4D0, 0x2E0, 0xAE8, 0x701, 0x511, 0x119, 0xB29, 0x682, 0x88A, 0x09A, 0x2A2, 0x80B, 0x413, 0x223, 0xA2B, 0x644, 0x454, 0x05C, 0xA6C, 0x745, 0x94D, 0x15D, 0x365},
119     {0xAC8, 0x8D0, 0x4E0, 0x2E8, 0x741, 0x951, 0x159, 0x369, 0x702, 0xB0A, 0x11A, 0x522, 0xA0B, 0x813, 0x423, 0x22B, 0x684, 0x894, 0x09C, 0x2AC, 0x645, 0xA4D, 0x05D, 0x465},
120     {0x4C8, 0x2D0, 0xAE0, 0x8E8, 0x681, 0x291, 0x099, 0x8A9, 0x642, 0x44A, 0x05A, 0xA62, 0x40B, 0x213, 0xA23, 0x82B, 0x744, 0x354, 0x15C, 0x96C, 0x705, 0x50D, 0x11D, 0xB25},
121     {0x2C8, 0xAD0, 0x8E0, 0x4E8, 0x641, 0xA51, 0x059, 0x469, 0x742, 0x34A, 0x15A, 0x962, 0x20B, 0xA13, 0x823, 0x42B, 0x704, 0xB14, 0x11C, 0x52C, 0x685, 0x28D, 0x09D, 0x8A5},
122     {0x708, 0xB10, 0x120, 0x528, 0x8C1, 0xAD1, 0x2D9, 0x4E9, 0x942, 0x74A, 0x35A, 0x162, 0x64B, 0xA53, 0x063, 0x46B, 0x804, 0xA14, 0x21C, 0x42C, 0x885, 0x68D, 0x29D, 0x0A5},
123     {0xB08, 0x110, 0x520, 0x728, 0x941, 0x151, 0x359, 0x769, 0x802, 0xA0A, 0x21A, 0x422, 0xA4B, 0x053, 0x463, 0x66B, 0x884, 0x094, 0x29C, 0x6AC, 0x8C5, 0xACD, 0x2DD, 0x4E5},
124     {0x508, 0x710, 0xB20, 0x128, 0x881, 0x691, 0x299, 0x0A9, 0x8C2, 0x4CA, 0x2DA, 0xAE2, 0x44B, 0x653, 0xA63, 0x06B, 0x944, 0x754, 0x35C, 0x16C, 0x805, 0x40D, 0x21D, 0xA25},
125     {0x108, 0x510, 0x720, 0xB28, 0x801, 0x411, 0x219, 0xA29, 0x882, 0x08A, 0x29A, 0x6A2, 0x04B, 0x453, 0x663, 0xA6B, 0x8C4, 0x4D4, 0x2DC, 0xAEC, 0x945, 0x14D, 0x35D, 0x765},
126     {0x748, 0x350, 0x160, 0x968, 0xAC1, 0x2D1, 0x4D9, 0x8E9, 0xA42, 0x64A, 0x45A, 0x062, 0x68B, 0x293, 0x0A3, 0x8AB, 0xA04, 0x214, 0x41C, 0x82C, 0xB05, 0x70D, 0x51D, 0x125},
127     {0x948, 0x750, 0x360, 0x168, 0xB01, 0x711, 0x519, 0x129, 0xAC2, 0x8CA, 0x4DA, 0x2E2, 0x88B, 0x693, 0x2A3, 0x0AB, 0xA44, 0x654, 0x45C, 0x06C, 0xA05, 0x80D, 0x41D, 0x225},
128     {0x348, 0x150, 0x960, 0x768, 0xA41, 0x051, 0x459, 0x669, 0xA02, 0x20A, 0x41A, 0x822, 0x28B, 0x093, 0x8A3, 0x6AB, 0xB04, 0x114, 0x51C, 0x72C, 0xAC5, 0x2CD, 0x4DD, 0x8E5},
129     {0x148, 0x950, 0x760, 0x368, 0xA01, 0x811, 0x419, 0x229, 0xB02, 0x10A, 0x51A, 0x722, 0x08B, 0x893, 0x6A3, 0x2AB, 0xAC4, 0x8D4, 0x4DC, 0x2EC, 0xA45, 0x04D, 0x45D, 0x665},
130     {0x688, 0x890, 0x0A0, 0x2A8, 0x4C1, 0x8D1, 0xAD9, 0x2E9, 0x502, 0x70A, 0xB1A, 0x122, 0x74B, 0x953, 0x163, 0x36B, 0x404, 0x814, 0xA1C, 0x22C, 0x445, 0x64D, 0xA5D, 0x065},
131     {0x888, 0x090, 0x2A0, 0x6A8, 0x501, 0x111, 0xB19, 0x729, 0x402, 0x80A, 0xA1A, 0x222, 0x94B, 0x153, 0x363, 0x76B, 0x444, 0x054, 0xA5C, 0x66C, 0x4C5, 0x8CD, 0xADD, 0x2E5},
132     {0x288, 0x690, 0x8A0, 0x0A8, 0x441, 0x651, 0xA59, 0x069, 0x4C2, 0x2CA, 0xADA, 0x8E2, 0x34B, 0x753, 0x963, 0x16B, 0x504, 0x714, 0xB1C, 0x12C, 0x405, 0x20D, 0xA1D, 0x825},
133     {0x088, 0x290, 0x6A0, 0x8A8, 0x401, 0x211, 0xA19, 0x829, 0x442, 0x04A, 0xA5A, 0x662, 0x14B, 0x353, 0x763, 0x96B, 0x4C4, 0x2D4, 0xADC, 0x8EC, 0x505, 0x10D, 0xB1D, 0x725},
134     {0x648, 0x450, 0x060, 0xA68, 0x2C1, 0x4D1, 0x8D9, 0xAE9, 0x282, 0x68A, 0x89A, 0x0A2, 0x70B, 0x513, 0x123, 0xB2B, 0x204, 0x414, 0x81C, 0xA2C, 0x345, 0x74D, 0x95D, 0x165},
135     {0xA48, 0x650, 0x460, 0x068, 0x341, 0x751, 0x959, 0x169, 0x2C2, 0xACA, 0x8DA, 0x4E2, 0xB0B, 0x713, 0x523, 0x12B, 0x284, 0x694, 0x89C, 0x0AC, 0x205, 0xA0D, 0x81D, 0x425},
136     {0x448, 0x050, 0xA60, 0x668, 0x281, 0x091, 0x899, 0x6A9, 0x202, 0x40A, 0x81A, 0xA22, 0x50B, 0x113, 0xB23, 0x72B, 0x344, 0x154, 0x95C, 0x76C, 0x2C5, 0x4CD, 0x8DD, 0xAE5},
137     {0x048, 0xA50, 0x660, 0x468, 0x201, 0xA11, 0x819, 0x429, 0x342, 0x14A, 0x95A, 0x762, 0x10B, 0xB13, 0x723, 0x52B, 0x2C4, 0xAD4, 0x8DC, 0x4EC, 0x285, 0x08D, 0x89D, 0x6A5},
138     {0x808, 0xA10, 0x220, 0x428, 0x101, 0xB11, 0x719, 0x529, 0x142, 0x94A, 0x75A, 0x362, 0x8CB, 0xAD3, 0x2E3, 0x4EB, 0x044, 0xA54, 0x65C, 0x46C, 0x085, 0x88D, 0x69D, 0x2A5},
139     {0xA08, 0x210, 0x420, 0x828, 0x141, 0x351, 0x759, 0x969, 0x042, 0xA4A, 0x65A, 0x462, 0xACB, 0x2D3, 0x4E3, 0x8EB, 0x084, 0x294, 0x69C, 0x8AC, 0x105, 0xB0D, 0x71D, 0x525},
140     {0x408, 0x810, 0xA20, 0x228, 0x081, 0x891, 0x699, 0x2A9, 0x102, 0x50A, 0x71A, 0xB22, 0x4CB, 0x8D3, 0xAE3, 0x2EB, 0x144, 0x954, 0x75C, 0x36C, 0x045, 0x44D, 0x65D, 0xA65},
141     )
142
143 _axis_convert_num = {'X': 0, 'Y': 1, 'Z': 2, '-X': 3, '-Y': 4, '-Z': 5}
144
145
146 def axis_conversion(from_forward='Y', from_up='Z', to_forward='Y', to_up='Z'):
147     """
148     Each argument us an axis in ['X', 'Y', 'Z', '-X', '-Y', '-Z']
149     where the first 2 are a source and the second 2 are the target.
150     """
151     from mathutils import Matrix
152     from functools import reduce
153
154     if from_forward == to_forward and from_up == to_up:
155         return Matrix().to_3x3()
156
157     value = reduce(int.__or__, (_axis_convert_num[a] << (i * 3) for i, a in enumerate((from_forward, from_up, to_forward, to_up))))
158
159     for i, axis_lut in enumerate(_axis_convert_lut):
160         if value in axis_lut:
161             return Matrix(_axis_convert_matrix[i])
162     assert("internal error")
163
164
165 # limited replacement for BPyImage.comprehensiveImageLoad
166 def load_image(imagepath, dirname):
167     import os
168
169     if os.path.exists(imagepath):
170         return bpy.data.images.load(imagepath)
171
172     variants = [imagepath, os.path.join(dirname, imagepath), os.path.join(dirname, os.path.basename(imagepath))]
173
174     for filepath in variants:
175         for nfilepath in (filepath, bpy.path.resolve_ncase(filepath)):
176             if os.path.exists(nfilepath):
177                 return bpy.data.images.load(nfilepath)
178
179     # TODO comprehensiveImageLoad also searched in bpy.config.textureDir
180     return None
181
182
183 # return a tuple (free, object list), free is True if memory should be freed later with free_derived_objects()
184 def create_derived_objects(scene, ob):
185     if ob.parent and ob.parent.dupli_type != 'NONE':
186         return False, None
187
188     if ob.dupli_type != 'NONE':
189         ob.dupli_list_create(scene)
190         return True, [(dob.object, dob.matrix) for dob in ob.dupli_list]
191     else:
192         return False, [(ob, ob.matrix_world)]
193
194
195 def free_derived_objects(ob):
196     ob.dupli_list_clear()
197
198
199 def unpack_list(list_of_tuples):
200     flat_list = []
201     flat_list_extend = flat_list.extend  # a tich faster
202     for t in list_of_tuples:
203         flat_list_extend(t)
204     return flat_list
205
206
207 # same as above except that it adds 0 for triangle faces
208 def unpack_face_list(list_of_tuples):
209     #allocate the entire list
210     flat_ls = [0] * (len(list_of_tuples) * 4)
211     i = 0
212
213     for t in list_of_tuples:
214         if len(t) == 3:
215             if t[2] == 0:
216                 t = t[1], t[2], t[0]
217         else:  # assuem quad
218             if t[3] == 0 or t[2] == 0:
219                 t = t[2], t[3], t[0], t[1]
220
221         flat_ls[i:i + len(t)] = t
222         i += 4
223     return flat_ls
224
225
226 path_reference_mode = EnumProperty(
227         name="Path Mode",
228         description="Method used to reference paths",
229         items=(('AUTO', "Auto", "Use Relative paths with subdirectories only"),
230                ('ABSOLUTE', "Absolute", "Always write absolute paths"),
231                ('RELATIVE', "Relative", "Always write relative patsh (where possible)"),
232                ('MATCH', "Match", "Match Absolute/Relative setting with input path"),
233                ('STRIP', "Strip Path", "Filename only"),
234                ('COPY', "Copy", "copy the file to the destination path (or subdirectory)"),
235                ),
236         default='AUTO'
237         )
238
239
240 def path_reference(filepath, base_src, base_dst, mode='AUTO', copy_subdir="", copy_set=None):
241     """
242     Return a filepath relative to a destination directory, for use with
243     exporters.
244
245     :arg filepath: the file path to return, supporting blenders relative '//' prefix.
246     :type filepath: string
247     :arg base_src: the directory the *filepath* is relative too (normally the blend file).
248     :type base_src: string
249     :arg base_dst: the directory the *filepath* will be referenced from (normally the export path).
250     :type base_dst: string
251     :arg mode: the method used get the path in ['AUTO', 'ABSOLUTE', 'RELATIVE', 'MATCH', 'STRIP', 'COPY']
252     :type mode: string
253     :arg copy_subdir: the subdirectory of *base_dst* to use when mode='COPY'.
254     :type copy_subdir: string
255     :arg copy_set: collect from/to pairs when mode='COPY', pass to *path_reference_copy* when exportign is done.
256     :type copy_set: set
257     :return: the new filepath.
258     :rtype: string
259     """
260     import os
261     is_relative = filepath.startswith("//")
262     filepath_abs = os.path.normpath(bpy.path.abspath(filepath, base_src))
263
264     if mode in ('ABSOLUTE', 'RELATIVE', 'STRIP'):
265         pass
266     elif mode == 'MATCH':
267         mode = 'RELATIVE' if is_relative else 'ABSOLUTE'
268     elif mode == 'AUTO':
269         mode = 'RELATIVE' if bpy.path.is_subdir(filepath, base_dst) else 'ABSOLUTE'
270     elif mode == 'COPY':
271         if copy_subdir:
272             subdir_abs = os.path.join(os.path.normpath(base_dst), copy_subdir)
273         else:
274             subdir_abs = os.path.normpath(base_dst)
275
276         filepath_cpy = os.path.join(subdir_abs, os.path.basename(filepath))
277
278         copy_set.add((filepath_abs, filepath_cpy))
279
280         filepath_abs = filepath_cpy
281         mode = 'RELATIVE'
282     else:
283         Excaption("invalid mode given %r" % mode)
284
285     if mode == 'ABSOLUTE':
286         return filepath_abs
287     elif mode == 'RELATIVE':
288         return os.path.relpath(filepath_abs, base_dst)
289     elif mode == 'STRIP':
290         return os.path.basename(filepath_abs)
291
292
293 def path_reference_copy(copy_set, report=print):
294     """
295     Execute copying files of path_reference
296
297     :arg copy_set: set of (from, to) pairs to copy.
298     :type copy_set: set
299     :arg report: function used for reporting warnings, takes a string argument.
300     :type report: function
301     """
302     if not copy_set:
303         return
304
305     import os
306     import shutil
307
308     for file_src, file_dst in copy_set:
309         if not os.path.exists(file_src):
310             report("missing %r, not copying" % file_src)
311         elif os.path.exists(file_dst) and os.path.samefile(file_src, file_dst):
312             pass
313         else:
314             dir_to = os.path.dirname(file_dst)
315
316             if not os.path.isdir(dir_to):
317                 os.makedirs(dir_to)
318
319             shutil.copy(file_src, file_dst)