dcc5d9ecec04d07b628b7718d942a35244ac7ce8
[blender-staging.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 import bpy
22 from bpy.props import StringProperty, BoolProperty, EnumProperty
23
24
25 class ExportHelper:
26     filepath = StringProperty(name="File Path", description="Filepath used for exporting the file", maxlen=1024, default="", subtype='FILE_PATH')
27     check_existing = BoolProperty(name="Check Existing", description="Check and warn on overwriting existing files", default=True, options={'HIDDEN'})
28
29     # subclasses can override with decorator
30     # True == use ext, False == no ext, None == do nothing.
31     check_extension = True
32
33     def invoke(self, context, event):
34         import os
35         if not self.filepath:
36             blend_filepath = context.blend_data.filepath
37             if not blend_filepath:
38                 blend_filepath = "untitled"
39             else:
40                 blend_filepath = os.path.splitext(blend_filepath)[0]
41
42             self.filepath = blend_filepath + self.filename_ext
43
44         context.window_manager.fileselect_add(self)
45         return {'RUNNING_MODAL'}
46
47     def check(self, context):
48         check_extension = self.check_extension
49
50         if check_extension is None:
51             return False
52
53         filepath = bpy.path.ensure_ext(self.filepath, self.filename_ext if check_extension else "")
54
55         if filepath != self.filepath:
56             self.filepath = filepath
57             return True
58
59         return False
60
61
62 class ImportHelper:
63     filepath = StringProperty(name="File Path", description="Filepath used for importing the file", maxlen=1024, default="", subtype='FILE_PATH')
64
65     def invoke(self, context, event):
66         context.window_manager.fileselect_add(self)
67         return {'RUNNING_MODAL'}
68
69
70 # Axis conversion function, not pretty LUT
71 # use lookup tabes to convert between any axis
72 _axis_convert_matrix = (
73     ((-1.0, 0.0, 0.0), (0.0, -1.0, 0.0), (0.0, 0.0, 1.0)),
74     ((-1.0, 0.0, 0.0), (0.0, 0.0, -1.0), (0.0, -1.0, 0.0)),
75     ((-1.0, 0.0, 0.0), (0.0, 0.0, 1.0), (0.0, 1.0, 0.0)),
76     ((-1.0, 0.0, 0.0), (0.0, 1.0, 0.0), (0.0, 0.0, -1.0)),
77     ((0.0, -1.0, 0.0), (-1.0, 0.0, 0.0), (0.0, 0.0, -1.0)),
78     ((0.0, -1.0, 0.0), (0.0, 0.0, -1.0), (1.0, 0.0, 0.0)),
79     ((0.0, -1.0, 0.0), (0.0, 0.0, 1.0), (-1.0, 0.0, 0.0)),
80     ((0.0, -1.0, 0.0), (1.0, 0.0, 0.0), (0.0, 0.0, 1.0)),
81     ((0.0, 0.0, -1.0), (-1.0, 0.0, 0.0), (0.0, 1.0, 0.0)),
82     ((0.0, 0.0, -1.0), (0.0, -1.0, 0.0), (-1.0, 0.0, 0.0)),
83     ((0.0, 0.0, -1.0), (0.0, 1.0, 0.0), (1.0, 0.0, 0.0)),
84     ((0.0, 0.0, -1.0), (1.0, 0.0, 0.0), (0.0, -1.0, 0.0)),
85     ((0.0, 0.0, 1.0), (-1.0, 0.0, 0.0), (0.0, -1.0, 0.0)),
86     ((0.0, 0.0, 1.0), (0.0, -1.0, 0.0), (1.0, 0.0, 0.0)),
87     ((0.0, 0.0, 1.0), (0.0, 1.0, 0.0), (-1.0, 0.0, 0.0)),
88     ((0.0, 0.0, 1.0), (1.0, 0.0, 0.0), (0.0, 1.0, 0.0)),
89     ((0.0, 1.0, 0.0), (-1.0, 0.0, 0.0), (0.0, 0.0, 1.0)),
90     ((0.0, 1.0, 0.0), (0.0, 0.0, -1.0), (-1.0, 0.0, 0.0)),
91     ((0.0, 1.0, 0.0), (0.0, 0.0, 1.0), (1.0, 0.0, 0.0)),
92     ((0.0, 1.0, 0.0), (1.0, 0.0, 0.0), (0.0, 0.0, -1.0)),
93     ((1.0, 0.0, 0.0), (0.0, -1.0, 0.0), (0.0, 0.0, -1.0)),
94     ((1.0, 0.0, 0.0), (0.0, 0.0, -1.0), (0.0, 1.0, 0.0)),
95     ((1.0, 0.0, 0.0), (0.0, 0.0, 1.0), (0.0, -1.0, 0.0)),
96     )
97
98 # store args as a single int
99 # (X Y Z -X -Y -Z) --> (0, 1, 2, 3, 4, 5)
100 # each value is ((src_forward, src_up), (dst_forward, dst_up))
101 # where all 4 values are or'd into a single value...
102 #    (i1<<0 | i1<<3 | i1<<6 | i1<<9)
103 _axis_convert_lut = (
104     {0x5c, 0x9a, 0x119, 0x15d, 0x20b, 0x2a2, 0x2c8, 0x365, 0x413, 0x46c, 0x4d0, 0x529, 0x644, 0x682, 0x701, 0x745, 0x823, 0x88a, 0x8e0, 0x94d, 0xa2b, 0xa54, 0xae8, 0xb11},
105     {0x9c, 0xac, 0x159, 0x169, 0x22b, 0x2e8, 0x40b, 0x465, 0x4c8, 0x522, 0x684, 0x694, 0x741, 0x751, 0x813, 0x8d0, 0xa23, 0xa4d, 0xae0, 0xb0a},
106     {0x99, 0xa9, 0x15c, 0x16c, 0x213, 0x2d0, 0x423, 0x44a, 0x4e0, 0x50d, 0x681, 0x691, 0x744, 0x754, 0x82b, 0x8e8, 0xa0b, 0xa62, 0xac8, 0xb25},
107     {0x59, 0x85, 0x11c, 0x142, 0x223, 0x28d, 0x2e0, 0x34a, 0x42b, 0x469, 0x4e8, 0x52c, 0x641, 0x69d, 0x704, 0x75a, 0x80b, 0x8a5, 0x8c8, 0x962, 0xa13, 0xa51, 0xad0, 0xb14},
108     {0xa5, 0x162, 0x21c, 0x285, 0x2d9, 0x342, 0x463, 0x46b, 0x520, 0x528, 0x68d, 0x74a, 0x804, 0x89d, 0x8c1, 0x95a, 0xa4b, 0xa53, 0xb08, 0xb10},
109     {0x4b, 0x53, 0x108, 0x110, 0x29c, 0x2ac, 0x359, 0x369, 0x41a, 0x422, 0x4dd, 0x4e5, 0x663, 0x66b, 0x720, 0x728, 0x884, 0x894, 0x941, 0x951, 0xa02, 0xa0a, 0xac5, 0xacd},
110     {0x63, 0x6b, 0x120, 0x128, 0x299, 0x2a9, 0x35c, 0x36c, 0x405, 0x40d, 0x4c2, 0x4ca, 0x64b, 0x653, 0x708, 0x710, 0x881, 0x891, 0x944, 0x954, 0xa1d, 0xa25, 0xada, 0xae2},
111     {0x8a, 0x14d, 0x219, 0x29a, 0x2dc, 0x35d, 0x44b, 0x453, 0x508, 0x510, 0x6a2, 0x765, 0x801, 0x882, 0x8c4, 0x945, 0xa63, 0xa6b, 0xb20, 0xb28},
112     {0x5a, 0x62, 0x8b, 0x11d, 0x125, 0x148, 0x22c, 0x28b, 0x293, 0x2e9, 0x348, 0x350, 0x41c, 0x42c, 0x45a, 0x4d9, 0x4e9, 0x51d, 0x642, 0x64a, 0x6a3, 0x705, 0x70d, 0x760, 0x814, 0x8a3, 0x8ab, 0x8d1, 0x960, 0x968, 0xa04, 0xa14, 0xa42, 0xac1, 0xad1, 0xb05},
113     {0x54, 0xab, 0x111, 0x168, 0x21d, 0x225, 0x2da, 0x2e2, 0x45c, 0x519, 0x66c, 0x693, 0x729, 0x750, 0x805, 0x80d, 0x8c2, 0x8ca, 0xa44, 0xb01},
114     {0x51, 0x93, 0x114, 0x150, 0x202, 0x20a, 0x2c5, 0x2cd, 0x459, 0x51c, 0x669, 0x6ab, 0x72c, 0x768, 0x81a, 0x822, 0x8dd, 0x8e5, 0xa41, 0xb04},
115     {0x45, 0x4d, 0xa3, 0x102, 0x10a, 0x160, 0x229, 0x2a3, 0x2ab, 0x2ec, 0x360, 0x368, 0x419, 0x429, 0x445, 0x4dc, 0x4ec, 0x502, 0x65d, 0x665, 0x68b, 0x71a, 0x722, 0x748, 0x811, 0x88b, 0x893, 0x8d4, 0x948, 0x950, 0xa01, 0xa11, 0xa5d, 0xac4, 0xad4, 0xb1a},
116     {0x5d, 0x65, 0xa0, 0x11a, 0x122, 0x163, 0x214, 0x2a0, 0x2a8, 0x2d1, 0x363, 0x36b, 0x404, 0x414, 0x45d, 0x4c1, 0x4d1, 0x51a, 0x645, 0x64d, 0x688, 0x702, 0x70a, 0x74b, 0x82c, 0x888, 0x890, 0x8e9, 0x94b, 0x953, 0xa1c, 0xa2c, 0xa45, 0xad9, 0xae9, 0xb02},
117     {0x6c, 0x90, 0x129, 0x153, 0x21a, 0x222, 0x2dd, 0x2e5, 0x444, 0x501, 0x654, 0x6a8, 0x711, 0x76b, 0x802, 0x80a, 0x8c5, 0x8cd, 0xa5c, 0xb19},
118     {0x69, 0xa8, 0x12c, 0x16b, 0x205, 0x20d, 0x2c2, 0x2ca, 0x441, 0x504, 0x651, 0x690, 0x714, 0x753, 0x81d, 0x825, 0x8da, 0x8e2, 0xa59, 0xb1c},
119     {0x42, 0x4a, 0x88, 0x105, 0x10d, 0x14b, 0x211, 0x288, 0x290, 0x2d4, 0x34b, 0x353, 0x401, 0x411, 0x442, 0x4c4, 0x4d4, 0x505, 0x65a, 0x662, 0x6a0, 0x71d, 0x725, 0x763, 0x829, 0x8a0, 0x8a8, 0x8ec, 0x963, 0x96b, 0xa19, 0xa29, 0xa5a, 0xadc, 0xaec, 0xb1d},
120     {0xa2, 0x165, 0x204, 0x282, 0x2c1, 0x345, 0x448, 0x450, 0x50b, 0x513, 0x68a, 0x74d, 0x81c, 0x89a, 0x8d9, 0x95d, 0xa60, 0xa68, 0xb23, 0xb2b},
121     {0x60, 0x68, 0x123, 0x12b, 0x284, 0x294, 0x341, 0x351, 0x41d, 0x425, 0x4da, 0x4e2, 0x648, 0x650, 0x70b, 0x713, 0x89c, 0x8ac, 0x959, 0x969, 0xa05, 0xa0d, 0xac2, 0xaca},
122     {0x48, 0x50, 0x10b, 0x113, 0x281, 0x291, 0x344, 0x354, 0x402, 0x40a, 0x4c5, 0x4cd, 0x660, 0x668, 0x723, 0x72b, 0x899, 0x8a9, 0x95c, 0x96c, 0xa1a, 0xa22, 0xadd, 0xae5},
123     {0x8d, 0x14a, 0x201, 0x29d, 0x2c4, 0x35a, 0x460, 0x468, 0x523, 0x52b, 0x6a5, 0x762, 0x819, 0x885, 0x8dc, 0x942, 0xa48, 0xa50, 0xb0b, 0xb13},
124     {0x44, 0x9d, 0x101, 0x15a, 0x220, 0x2a5, 0x2e3, 0x362, 0x428, 0x454, 0x4eb, 0x511, 0x65c, 0x685, 0x719, 0x742, 0x808, 0x88d, 0x8cb, 0x94a, 0xa10, 0xa6c, 0xad3, 0xb29},
125     {0x84, 0x94, 0x141, 0x151, 0x210, 0x2d3, 0x420, 0x462, 0x4e3, 0x525, 0x69c, 0x6ac, 0x759, 0x769, 0x828, 0x8eb, 0xa08, 0xa4a, 0xacb, 0xb0d},
126     {0x81, 0x91, 0x144, 0x154, 0x228, 0x2eb, 0x408, 0x44d, 0x4cb, 0x50a, 0x699, 0x6a9, 0x75c, 0x76c, 0x810, 0x8d3, 0xa20, 0xa65, 0xae3, 0xb22},
127     )
128
129 _axis_convert_num = {'X': 0, 'Y': 1, 'Z': 2, '-X': 3, '-Y': 4, '-Z': 5}
130
131
132 def axis_conversion(from_forward='Y', from_up='Z', to_forward='Y', to_up='Z'):
133     """
134     Each argument us an axis in ['X', 'Y', 'Z', '-X', '-Y', '-Z']
135     where the first 2 are a source and the second 2 are the target.
136     """
137     from mathutils import Matrix
138     from functools import reduce
139
140     if from_forward == to_forward and from_up == to_up:
141         return Matrix().to_3x3()
142
143     value = reduce(int.__or__, (_axis_convert_num[a] << (i * 3) for i, a in enumerate((from_up, from_forward, to_up, to_forward))))
144
145     for i, axis_lut in enumerate(_axis_convert_lut):
146         if value in axis_lut:
147             return Matrix(_axis_convert_matrix[i])
148     assert("internal error")
149
150
151 # limited replacement for BPyImage.comprehensiveImageLoad
152 def load_image(imagepath, dirname):
153     import os
154
155     if os.path.exists(imagepath):
156         return bpy.data.images.load(imagepath)
157
158     variants = [imagepath, os.path.join(dirname, imagepath), os.path.join(dirname, os.path.basename(imagepath))]
159
160     for filepath in variants:
161         for nfilepath in (filepath, bpy.path.resolve_ncase(filepath)):
162             if os.path.exists(nfilepath):
163                 return bpy.data.images.load(nfilepath)
164
165     # TODO comprehensiveImageLoad also searched in bpy.config.textureDir
166     return None
167
168
169 # return a tuple (free, object list), free is True if memory should be freed later with free_derived_objects()
170 def create_derived_objects(scene, ob):
171     if ob.parent and ob.parent.dupli_type != 'NONE':
172         return False, None
173
174     if ob.dupli_type != 'NONE':
175         ob.dupli_list_create(scene)
176         return True, [(dob.object, dob.matrix) for dob in ob.dupli_list]
177     else:
178         return False, [(ob, ob.matrix_world)]
179
180
181 def free_derived_objects(ob):
182     ob.dupli_list_clear()
183
184
185 def unpack_list(list_of_tuples):
186     flat_list = []
187     flat_list_extend = flat_list.extend  # a tich faster
188     for t in list_of_tuples:
189         flat_list_extend(t)
190     return flat_list
191
192
193 # same as above except that it adds 0 for triangle faces
194 def unpack_face_list(list_of_tuples):
195     #allocate the entire list
196     flat_ls = [0] * (len(list_of_tuples) * 4)
197     i = 0
198
199     for t in list_of_tuples:
200         if len(t) == 3:
201             if t[2] == 0:
202                 t = t[1], t[2], t[0]
203         else:  # assuem quad
204             if t[3] == 0 or t[2] == 0:
205                 t = t[2], t[3], t[0], t[1]
206
207         flat_ls[i:i + len(t)] = t
208         i += 4
209     return flat_ls
210
211
212 path_reference_mode = EnumProperty(
213         name="Path Mode",
214         description="Method used to reference paths",
215         items=(('AUTO', "Auto", "Use Relative paths with subdirectories only"),
216                ('ABSOLUTE', "Absolute", "Always write absolute paths"),
217                ('RELATIVE', "Relative", "Always write relative patsh (where possible)"),
218                ('MATCH', "Match", "Match Absolute/Relative setting with input path"),
219                ('STRIP', "Strip Path", "Filename only"),
220                ('COPY', "Copy", "copy the file to the destination path (or subdirectory)"),
221                ),
222         default='AUTO'
223         )
224
225
226 def path_reference(filepath, base_src, base_dst, mode='AUTO', copy_subdir="", copy_set=None):
227     """
228     Return a filepath relative to a destination directory, for use with
229     exporters.
230
231     :arg filepath: the file path to return, supporting blenders relative '//' prefix.
232     :type filepath: string
233     :arg base_src: the directory the *filepath* is relative too (normally the blend file).
234     :type base_src: string
235     :arg base_dst: the directory the *filepath* will be referenced from (normally the export path).
236     :type base_dst: string
237     :arg mode: the method used get the path in ['AUTO', 'ABSOLUTE', 'RELATIVE', 'MATCH', 'STRIP', 'COPY']
238     :type mode: string
239     :arg copy_subdir: the subdirectory of *base_dst* to use when mode='COPY'.
240     :type copy_subdir: string
241     :arg copy_set: collect from/to pairs when mode='COPY', pass to *path_reference_copy* when exportign is done.
242     :type copy_set: set
243     :return: the new filepath.
244     :rtype: string
245     """
246     import os
247     is_relative = filepath.startswith("//")
248     filepath_abs = os.path.normpath(bpy.path.abspath(filepath, base_src))
249
250     if mode in ('ABSOLUTE', 'RELATIVE', 'STRIP'):
251         pass
252     elif mode == 'MATCH':
253         mode = 'RELATIVE' if is_relative else 'ABSOLUTE'
254     elif mode == 'AUTO':
255         mode = 'RELATIVE' if bpy.path.is_subdir(filepath, base_dst) else 'ABSOLUTE'
256     elif mode == 'COPY':
257         if copy_subdir:
258             subdir_abs = os.path.join(os.path.normpath(base_dst), copy_subdir)
259         else:
260             subdir_abs = os.path.normpath(base_dst)
261
262         filepath_cpy = os.path.join(subdir_abs, os.path.basename(filepath))
263
264         copy_set.add((filepath_abs, filepath_cpy))
265
266         filepath_abs = filepath_cpy
267         mode = 'RELATIVE'
268     else:
269         Excaption("invalid mode given %r" % mode)
270
271     if mode == 'ABSOLUTE':
272         return filepath_abs
273     elif mode == 'RELATIVE':
274         return os.path.relpath(filepath_abs, base_dst)
275     elif mode == 'STRIP':
276         return os.path.basename(filepath_abs)
277
278
279 def path_reference_copy(copy_set, report=print):
280     """
281     Execute copying files of path_reference
282
283     :arg copy_set: set of (from, to) pairs to copy.
284     :type copy_set: set
285     :arg report: function used for reporting warnings, takes a string argument.
286     :type report: function
287     """
288     if not copy_set:
289         return
290
291     import os
292     import shutil
293
294     for file_src, file_dst in copy_set:
295         if not os.path.exists(file_src):
296             report("missing %r, not copying" % file_src)
297         elif os.path.exists(file_dst) and os.path.samefile(file_src, file_dst):
298             pass
299         else:
300             dir_to = os.path.dirname(file_dst)
301
302             if not os.path.isdir(dir_to):
303                 os.makedirs(dir_to)
304
305             shutil.copy(file_src, file_dst)