merge from trunk #37722
[blender-staging.git] / release / scripts / modules / bpy_extras / mesh_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     "mesh_linked_faces",
23     "edge_face_count_dict",
24     "edge_face_count",
25     "edge_loops_from_faces",
26     "edge_loops_from_edges",
27     "ngon_tesselate",
28 )
29
30
31 def mesh_linked_faces(mesh):
32     """
33     Splits the mesh into connected faces, use this for seperating cubes from
34     other mesh elements within 1 mesh datablock.
35
36     :arg mesh: the mesh used to group with.
37     :type mesh: :class:`Mesh`
38     :return: lists of lists containing faces.
39     :rtype: list
40     """
41
42     # Build vert face connectivity
43     vert_faces = [[] for i in range(len(mesh.vertices))]
44     for f in mesh.faces:
45         for v in f.vertices:
46             vert_faces[v].append(f)
47
48     # sort faces into connectivity groups
49     face_groups = [[f] for f in mesh.faces]
50     face_mapping = list(range(len(mesh.faces)))  # map old, new face location
51
52     # Now clump faces iterativly
53     ok = True
54     while ok:
55         ok = False
56
57         for i, f in enumerate(mesh.faces):
58             mapped_index = face_mapping[f.index]
59             mapped_group = face_groups[mapped_index]
60
61             for v in f.vertices:
62                 for nxt_f in vert_faces[v]:
63                     if nxt_f != f:
64                         nxt_mapped_index = face_mapping[nxt_f.index]
65
66                         # We are not a part of the same group
67                         if mapped_index != nxt_mapped_index:
68                             ok = True
69
70                             # Assign mapping to this group so they all map to this group
71                             for grp_f in face_groups[nxt_mapped_index]:
72                                 face_mapping[grp_f.index] = mapped_index
73
74                             # Move faces into this group
75                             mapped_group.extend(face_groups[nxt_mapped_index])
76
77                             # remove reference to the list
78                             face_groups[nxt_mapped_index] = None
79
80     # return all face groups that are not null
81     # this is all the faces that are connected in their own lists.
82     return [fg for fg in face_groups if fg]
83
84
85 def edge_face_count_dict(mesh):
86     """
87     :return: dict of edge keys with their value set to the number of
88        faces using each edge.
89     :rtype: dict
90     """
91     face_edge_keys = [face.edge_keys for face in mesh.faces]
92     face_edge_count = {}
93     for face_keys in face_edge_keys:
94         for key in face_keys:
95             try:
96                 face_edge_count[key] += 1
97             except:
98                 face_edge_count[key] = 1
99
100     return face_edge_count
101
102
103 def edge_face_count(mesh):
104     """
105     :return: list face users for each item in mesh.edges.
106     :rtype: list
107     """
108     edge_face_count_dict = edge_face_count_dict(mesh)
109     get = dict.get
110     return [get(edge_face_count_dict, ed.key, 0) for ed in mesh.edges]
111
112
113 def edge_loops_from_faces(mesh, faces=None, seams=()):
114     """
115     Edge loops defined by faces
116
117     Takes me.faces or a list of faces and returns the edge loops
118     These edge loops are the edges that sit between quads, so they dont touch
119     1 quad, note: not connected will make 2 edge loops,
120     both only containing 2 edges.
121
122     return a list of edge key lists
123     [[(0, 1), (4, 8), (3, 8)], ...]
124
125     :arg mesh: the mesh used to get edge loops from.
126     :type mesh: :class:`Mesh`
127     :arg faces: optional face list to only use some of the meshes faces.
128     :type faces: :class:`MeshFaces`, sequence or or NoneType
129     :return: return a list of edge vertex index lists.
130     :rtype: list
131     """
132
133     OTHER_INDEX = 2, 3, 0, 1  # opposite face index
134
135     if faces is None:
136         faces = mesh.faces
137
138     edges = {}
139
140     for f in faces:
141 #        if len(f) == 4:
142         if f.vertices_raw[3] != 0:
143             edge_keys = f.edge_keys
144             for i, edkey in enumerate(f.edge_keys):
145                 edges.setdefault(edkey, []).append(edge_keys[OTHER_INDEX[i]])
146
147     for edkey in seams:
148         edges[edkey] = []
149
150     # Collect edge loops here
151     edge_loops = []
152
153     for edkey, ed_adj in edges.items():
154         if 0 < len(ed_adj) < 3:  # 1 or 2
155             # Seek the first edge
156             context_loop = [edkey, ed_adj[0]]
157             edge_loops.append(context_loop)
158             if len(ed_adj) == 2:
159                 other_dir = ed_adj[1]
160             else:
161                 other_dir = None
162
163             ed_adj[:] = []
164
165             flipped = False
166
167             while 1:
168                 # from knowing the last 2, look for th next.
169                 ed_adj = edges[context_loop[-1]]
170                 if len(ed_adj) != 2:
171
172                     if other_dir and flipped == False:  # the original edge had 2 other edges
173                         flipped = True  # only flip the list once
174                         context_loop.reverse()
175                         ed_adj[:] = []
176                         context_loop.append(other_dir)  # save 1 lookiup
177
178                         ed_adj = edges[context_loop[-1]]
179                         if len(ed_adj) != 2:
180                             ed_adj[:] = []
181                             break
182                     else:
183                         ed_adj[:] = []
184                         break
185
186                 i = ed_adj.index(context_loop[-2])
187                 context_loop.append(ed_adj[not  i])
188
189                 # Dont look at this again
190                 ed_adj[:] = []
191
192     return edge_loops
193
194
195 def edge_loops_from_edges(mesh, edges=None):
196     """
197     Edge loops defined by edges
198
199     Takes me.edges or a list of edges and returns the edge loops
200
201     return a list of vertex indices.
202     [ [1, 6, 7, 2], ...]
203
204     closed loops have matching start and end values.
205     """
206     line_polys = []
207
208     # Get edges not used by a face
209     if edges is None:
210         edges = mesh.edges
211
212     if not hasattr(edges, "pop"):
213         edges = edges[:]
214
215     edge_dict = {ed.key: ed for ed in mesh.edges if ed.select}
216
217     while edges:
218         current_edge = edges.pop()
219         vert_end, vert_start = current_edge.vertices[:]
220         line_poly = [vert_start, vert_end]
221
222         ok = True
223         while ok:
224             ok = False
225             #for i, ed in enumerate(edges):
226             i = len(edges)
227             while i:
228                 i -= 1
229                 ed = edges[i]
230                 v1, v2 = ed.vertices
231                 if v1 == vert_end:
232                     line_poly.append(v2)
233                     vert_end = line_poly[-1]
234                     ok = 1
235                     del edges[i]
236                     # break
237                 elif v2 == vert_end:
238                     line_poly.append(v1)
239                     vert_end = line_poly[-1]
240                     ok = 1
241                     del edges[i]
242                     #break
243                 elif v1 == vert_start:
244                     line_poly.insert(0, v2)
245                     vert_start = line_poly[0]
246                     ok = 1
247                     del edges[i]
248                     # break
249                 elif v2 == vert_start:
250                     line_poly.insert(0, v1)
251                     vert_start = line_poly[0]
252                     ok = 1
253                     del edges[i]
254                     #break
255         line_polys.append(line_poly)
256
257     return line_polys
258
259
260 def ngon_tesselate(from_data, indices, fix_loops=True):
261     '''
262     Takes a polyline of indices (fgon)
263     and returns a list of face indicie lists.
264     Designed to be used for importers that need indices for an fgon to create from existing verts.
265
266     from_data: either a mesh, or a list/tuple of vectors.
267     indices: a list of indices to use this list is the ordered closed polyline to fill, and can be a subset of the data given.
268     fix_loops: If this is enabled polylines that use loops to make multiple polylines are delt with correctly.
269     '''
270
271     from mathutils.geometry import tesselate_polygon
272     from mathutils import Vector
273     vector_to_tuple = Vector.to_tuple
274
275     if not indices:
276         return []
277
278     def mlen(co):
279         return abs(co[0]) + abs(co[1]) + abs(co[2])  # manhatten length of a vector, faster then length
280
281     def vert_treplet(v, i):
282         return v, vector_to_tuple(v, 6), i, mlen(v)
283
284     def ed_key_mlen(v1, v2):
285         if v1[3] > v2[3]:
286             return v2[1], v1[1]
287         else:
288             return v1[1], v2[1]
289
290     if not PREF_FIX_LOOPS:
291         '''
292         Normal single concave loop filling
293         '''
294         if type(from_data) in (tuple, list):
295             verts = [Vector(from_data[i]) for ii, i in enumerate(indices)]
296         else:
297             verts = [from_data.vertices[i].co for ii, i in enumerate(indices)]
298
299         for i in range(len(verts) - 1, 0, -1):  # same as reversed(xrange(1, len(verts))):
300             if verts[i][1] == verts[i - 1][0]:
301                 verts.pop(i - 1)
302
303         fill = fill_polygon([verts])
304
305     else:
306         '''
307         Seperate this loop into multiple loops be finding edges that are used twice
308         This is used by lightwave LWO files a lot
309         '''
310
311         if type(from_data) in (tuple, list):
312             verts = [vert_treplet(Vector(from_data[i]), ii) for ii, i in enumerate(indices)]
313         else:
314             verts = [vert_treplet(from_data.vertices[i].co, ii) for ii, i in enumerate(indices)]
315
316         edges = [(i, i - 1) for i in range(len(verts))]
317         if edges:
318             edges[0] = (0, len(verts) - 1)
319
320         if not verts:
321             return []
322
323         edges_used = set()
324         edges_doubles = set()
325         # We need to check if any edges are used twice location based.
326         for ed in edges:
327             edkey = ed_key_mlen(verts[ed[0]], verts[ed[1]])
328             if edkey in edges_used:
329                 edges_doubles.add(edkey)
330             else:
331                 edges_used.add(edkey)
332
333         # Store a list of unconnected loop segments split by double edges.
334         # will join later
335         loop_segments = []
336
337         v_prev = verts[0]
338         context_loop = [v_prev]
339         loop_segments = [context_loop]
340
341         for v in verts:
342             if v != v_prev:
343                 # Are we crossing an edge we removed?
344                 if ed_key_mlen(v, v_prev) in edges_doubles:
345                     context_loop = [v]
346                     loop_segments.append(context_loop)
347                 else:
348                     if context_loop and context_loop[-1][1] == v[1]:
349                         #raise "as"
350                         pass
351                     else:
352                         context_loop.append(v)
353
354                 v_prev = v
355         # Now join loop segments
356
357         def join_seg(s1, s2):
358             if s2[-1][1] == s1[0][1]:
359                 s1, s2 = s2, s1
360             elif s1[-1][1] == s2[0][1]:
361                 pass
362             else:
363                 return False
364
365             # If were stuill here s1 and s2 are 2 segments in the same polyline
366             s1.pop()  # remove the last vert from s1
367             s1.extend(s2)  # add segment 2 to segment 1
368
369             if s1[0][1] == s1[-1][1]:  # remove endpoints double
370                 s1.pop()
371
372             s2[:] = []  # Empty this segment s2 so we dont use it again.
373             return True
374
375         joining_segments = True
376         while joining_segments:
377             joining_segments = False
378             segcount = len(loop_segments)
379
380             for j in range(segcount - 1, -1, -1):  # reversed(range(segcount)):
381                 seg_j = loop_segments[j]
382                 if seg_j:
383                     for k in range(j - 1, -1, -1):  # reversed(range(j)):
384                         if not seg_j:
385                             break
386                         seg_k = loop_segments[k]
387
388                         if seg_k and join_seg(seg_j, seg_k):
389                             joining_segments = True
390
391         loop_list = loop_segments
392
393         for verts in loop_list:
394             while verts and verts[0][1] == verts[-1][1]:
395                 verts.pop()
396
397         loop_list = [verts for verts in loop_list if len(verts) > 2]
398         # DONE DEALING WITH LOOP FIXING
399
400         # vert mapping
401         vert_map = [None] * len(indices)
402         ii = 0
403         for verts in loop_list:
404             if len(verts) > 2:
405                 for i, vert in enumerate(verts):
406                     vert_map[i + ii] = vert[2]
407                 ii += len(verts)
408
409         fill = tesselate_polygon([[v[0] for v in loop] for loop in loop_list])
410         #draw_loops(loop_list)
411         #raise 'done loop'
412         # map to original indices
413         fill = [[vert_map[i] for i in reversed(f)] for f in fill]
414
415     if not fill:
416         print('Warning Cannot scanfill, fallback on a triangle fan.')
417         fill = [[0, i - 1, i] for i in range(2, len(indices))]
418     else:
419         # Use real scanfill.
420         # See if its flipped the wrong way.
421         flip = None
422         for fi in fill:
423             if flip != None:
424                 break
425             for i, vi in enumerate(fi):
426                 if vi == 0 and fi[i - 1] == 1:
427                     flip = False
428                     break
429                 elif vi == 1 and fi[i - 1] == 0:
430                     flip = True
431                     break
432
433         if not flip:
434             for i, fi in enumerate(fill):
435                 fill[i] = tuple([ii for ii in reversed(fi)])
436
437     return fill