remove ifdef'd bevel code, current bevel works better then the previous code.
[blender.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-80 compliant>
20
21 __all__ = (
22     "mesh_linked_uv_islands",
23     "mesh_linked_tessfaces",
24     "edge_face_count_dict",
25     "edge_face_count",
26     "edge_loops_from_tessfaces",
27     "edge_loops_from_edges",
28     "ngon_tessellate",
29     "face_random_points",
30     )
31
32
33 def mesh_linked_uv_islands(mesh):
34     """
35     Splits the mesh into connected polygons, use this for seperating cubes from
36     other mesh elements within 1 mesh datablock.
37
38     :arg mesh: the mesh used to group with.
39     :type mesh: :class:`bpy.types.Mesh`
40     :return: lists of lists containing polygon indices
41     :rtype: list
42     """
43     uv_loops = [luv.uv[:] for luv in mesh.uv_layers.active.data]
44     poly_loops = [poly.loop_indices for poly in mesh.polygons]
45     luv_hash = {}
46     luv_hash_get = luv_hash.get
47     luv_hash_ls = [None] * len(uv_loops)
48     for pi, poly_indices in enumerate(poly_loops):
49         for li in poly_indices:
50             uv = uv_loops[li]
51             uv_hub = luv_hash_get(uv)
52             if uv_hub is None:
53                 uv_hub = luv_hash[uv] = [pi]
54             else:
55                 uv_hub.append(pi)
56             luv_hash_ls[li] = uv_hub
57
58     poly_islands = []
59
60     # 0 = none, 1 = added, 2 = searched
61     poly_tag = [0] * len(poly_loops)
62
63     while True:
64         poly_index = -1
65         for i in range(len(poly_loops)):
66             if poly_tag[i] == 0:
67                 poly_index = i
68                 break
69
70         if poly_index != -1:
71             island = [poly_index]
72             poly_tag[poly_index] = 1
73             poly_islands.append(island)
74         else:
75             break  # we're done
76
77         added = True
78         while added:
79             added = False
80             for poly_index in island[:]:
81                 if poly_tag[poly_index] == 1:
82                     for li in poly_loops[poly_index]:
83                         for poly_index_shared in luv_hash_ls[li]:
84                             if poly_tag[poly_index_shared] == 0:
85                                 added = True
86                                 poly_tag[poly_index_shared] = 1
87                                 island.append(poly_index_shared)
88                     poly_tag[poly_index] = 2
89
90     return poly_islands
91
92
93 def mesh_linked_tessfaces(mesh):
94     """
95     Splits the mesh into connected faces, use this for seperating cubes from
96     other mesh elements within 1 mesh datablock.
97
98     :arg mesh: the mesh used to group with.
99     :type mesh: :class:`bpy.types.Mesh`
100     :return: lists of lists containing faces.
101     :rtype: list
102     """
103
104     # Build vert face connectivity
105     vert_faces = [[] for i in range(len(mesh.vertices))]
106     for f in mesh.tessfaces:
107         for v in f.vertices:
108             vert_faces[v].append(f)
109
110     # sort faces into connectivity groups
111     face_groups = [[f] for f in mesh.tessfaces]
112     # map old, new face location
113     face_mapping = list(range(len(mesh.tessfaces)))
114
115     # Now clump faces iteratively
116     ok = True
117     while ok:
118         ok = False
119
120         for i, f in enumerate(mesh.tessfaces):
121             mapped_index = face_mapping[f.index]
122             mapped_group = face_groups[mapped_index]
123
124             for v in f.vertices:
125                 for nxt_f in vert_faces[v]:
126                     if nxt_f != f:
127                         nxt_mapped_index = face_mapping[nxt_f.index]
128
129                         # We are not a part of the same group
130                         if mapped_index != nxt_mapped_index:
131                             ok = True
132
133                             # Assign mapping to this group so they
134                             # all map to this group
135                             for grp_f in face_groups[nxt_mapped_index]:
136                                 face_mapping[grp_f.index] = mapped_index
137
138                             # Move faces into this group
139                             mapped_group.extend(face_groups[nxt_mapped_index])
140
141                             # remove reference to the list
142                             face_groups[nxt_mapped_index] = None
143
144     # return all face groups that are not null
145     # this is all the faces that are connected in their own lists.
146     return [fg for fg in face_groups if fg]
147
148
149 def edge_face_count_dict(mesh):
150     """
151     :return: dict of edge keys with their value set to the number of
152        faces using each edge.
153     :rtype: dict
154     """
155     face_edge_keys = [face.edge_keys for face in mesh.tessfaces]
156     face_edge_count = {}
157     for face_keys in face_edge_keys:
158         for key in face_keys:
159             try:
160                 face_edge_count[key] += 1
161             except:
162                 face_edge_count[key] = 1
163
164     return face_edge_count
165
166
167 def edge_face_count(mesh):
168     """
169     :return: list face users for each item in mesh.edges.
170     :rtype: list
171     """
172     edge_face_count = edge_face_count_dict(mesh)
173     get = dict.get
174     return [get(edge_face_count, ed.key, 0) for ed in mesh.edges]
175
176
177 def edge_loops_from_tessfaces(mesh, tessfaces=None, seams=()):
178     """
179     Edge loops defined by faces
180
181     Takes me.tessfaces or a list of faces and returns the edge loops
182     These edge loops are the edges that sit between quads, so they dont touch
183     1 quad, note: not connected will make 2 edge loops,
184     both only containing 2 edges.
185
186     return a list of edge key lists
187     [[(0, 1), (4, 8), (3, 8)], ...]
188
189     :arg mesh: the mesh used to get edge loops from.
190     :type mesh: :class:`bpy.types.Mesh`
191     :arg tessfaces: optional face list to only use some of the meshes faces.
192     :type tessfaces: :class:`bpy.types.MeshTessFace`, sequence or or NoneType
193     :return: return a list of edge vertex index lists.
194     :rtype: list
195     """
196
197     OTHER_INDEX = 2, 3, 0, 1  # opposite face index
198
199     if tessfaces is None:
200         tessfaces = mesh.tessfaces
201
202     edges = {}
203
204     for f in tessfaces:
205         if len(f.vertices) == 4:
206             edge_keys = f.edge_keys
207             for i, edkey in enumerate(f.edge_keys):
208                 edges.setdefault(edkey, []).append(edge_keys[OTHER_INDEX[i]])
209
210     for edkey in seams:
211         edges[edkey] = []
212
213     # Collect edge loops here
214     edge_loops = []
215
216     for edkey, ed_adj in edges.items():
217         if 0 < len(ed_adj) < 3:  # 1 or 2
218             # Seek the first edge
219             context_loop = [edkey, ed_adj[0]]
220             edge_loops.append(context_loop)
221             if len(ed_adj) == 2:
222                 other_dir = ed_adj[1]
223             else:
224                 other_dir = None
225
226             del ed_adj[:]
227
228             flipped = False
229
230             while 1:
231                 # from knowing the last 2, look for the next.
232                 ed_adj = edges[context_loop[-1]]
233                 if len(ed_adj) != 2:
234                     # the original edge had 2 other edges
235                     if other_dir and flipped is False:
236                         flipped = True  # only flip the list once
237                         context_loop.reverse()
238                         del ed_adj[:]
239                         context_loop.append(other_dir)  # save 1 look-up
240
241                         ed_adj = edges[context_loop[-1]]
242                         if len(ed_adj) != 2:
243                             del ed_adj[:]
244                             break
245                     else:
246                         del ed_adj[:]
247                         break
248
249                 i = ed_adj.index(context_loop[-2])
250                 context_loop.append(ed_adj[not  i])
251
252                 # Dont look at this again
253                 del ed_adj[:]
254
255     return edge_loops
256
257
258 def edge_loops_from_edges(mesh, edges=None):
259     """
260     Edge loops defined by edges
261
262     Takes me.edges or a list of edges and returns the edge loops
263
264     return a list of vertex indices.
265     [ [1, 6, 7, 2], ...]
266
267     closed loops have matching start and end values.
268     """
269     line_polys = []
270
271     # Get edges not used by a face
272     if edges is None:
273         edges = mesh.edges
274
275     if not hasattr(edges, "pop"):
276         edges = edges[:]
277
278     while edges:
279         current_edge = edges.pop()
280         vert_end, vert_start = current_edge.vertices[:]
281         line_poly = [vert_start, vert_end]
282
283         ok = True
284         while ok:
285             ok = False
286             #for i, ed in enumerate(edges):
287             i = len(edges)
288             while i:
289                 i -= 1
290                 ed = edges[i]
291                 v1, v2 = ed.vertices
292                 if v1 == vert_end:
293                     line_poly.append(v2)
294                     vert_end = line_poly[-1]
295                     ok = 1
296                     del edges[i]
297                     # break
298                 elif v2 == vert_end:
299                     line_poly.append(v1)
300                     vert_end = line_poly[-1]
301                     ok = 1
302                     del edges[i]
303                     #break
304                 elif v1 == vert_start:
305                     line_poly.insert(0, v2)
306                     vert_start = line_poly[0]
307                     ok = 1
308                     del edges[i]
309                     # break
310                 elif v2 == vert_start:
311                     line_poly.insert(0, v1)
312                     vert_start = line_poly[0]
313                     ok = 1
314                     del edges[i]
315                     #break
316         line_polys.append(line_poly)
317
318     return line_polys
319
320
321 def ngon_tessellate(from_data, indices, fix_loops=True):
322     """
323     Takes a polyline of indices (fgon) and returns a list of face
324     indicie lists. Designed to be used for importers that need indices for an
325     fgon to create from existing verts.
326
327     from_data: either a mesh, or a list/tuple of vectors.
328     indices: a list of indices to use this list is the ordered closed polyline
329        to fill, and can be a subset of the data given.
330     fix_loops: If this is enabled polylines that use loops to make multiple
331        polylines are delt with correctly.
332     """
333
334     from mathutils.geometry import tessellate_polygon
335     from mathutils import Vector
336     vector_to_tuple = Vector.to_tuple
337
338     if not indices:
339         return []
340
341     def mlen(co):
342         # manhatten length of a vector, faster then length
343         return abs(co[0]) + abs(co[1]) + abs(co[2])
344
345     def vert_treplet(v, i):
346         return v, vector_to_tuple(v, 6), i, mlen(v)
347
348     def ed_key_mlen(v1, v2):
349         if v1[3] > v2[3]:
350             return v2[1], v1[1]
351         else:
352             return v1[1], v2[1]
353
354     if not fix_loops:
355         """
356         Normal single concave loop filling
357         """
358         if type(from_data) in {tuple, list}:
359             verts = [Vector(from_data[i]) for ii, i in enumerate(indices)]
360         else:
361             verts = [from_data.vertices[i].co for ii, i in enumerate(indices)]
362
363         # same as reversed(range(1, len(verts))):
364         for i in range(len(verts) - 1, 0, -1):
365             if verts[i][1] == verts[i - 1][0]:
366                 verts.pop(i - 1)
367
368         fill = tessellate_polygon([verts])
369
370     else:
371         """
372         Seperate this loop into multiple loops be finding edges that are
373         used twice. This is used by lightwave LWO files a lot
374         """
375
376         if type(from_data) in {tuple, list}:
377             verts = [vert_treplet(Vector(from_data[i]), ii)
378                      for ii, i in enumerate(indices)]
379         else:
380             verts = [vert_treplet(from_data.vertices[i].co, ii)
381                      for ii, i in enumerate(indices)]
382
383         edges = [(i, i - 1) for i in range(len(verts))]
384         if edges:
385             edges[0] = (0, len(verts) - 1)
386
387         if not verts:
388             return []
389
390         edges_used = set()
391         edges_doubles = set()
392         # We need to check if any edges are used twice location based.
393         for ed in edges:
394             edkey = ed_key_mlen(verts[ed[0]], verts[ed[1]])
395             if edkey in edges_used:
396                 edges_doubles.add(edkey)
397             else:
398                 edges_used.add(edkey)
399
400         # Store a list of unconnected loop segments split by double edges.
401         # will join later
402         loop_segments = []
403
404         v_prev = verts[0]
405         context_loop = [v_prev]
406         loop_segments = [context_loop]
407
408         for v in verts:
409             if v != v_prev:
410                 # Are we crossing an edge we removed?
411                 if ed_key_mlen(v, v_prev) in edges_doubles:
412                     context_loop = [v]
413                     loop_segments.append(context_loop)
414                 else:
415                     if context_loop and context_loop[-1][1] == v[1]:
416                         #raise "as"
417                         pass
418                     else:
419                         context_loop.append(v)
420
421                 v_prev = v
422         # Now join loop segments
423
424         def join_seg(s1, s2):
425             if s2[-1][1] == s1[0][1]:
426                 s1, s2 = s2, s1
427             elif s1[-1][1] == s2[0][1]:
428                 pass
429             else:
430                 return False
431
432             # If were stuill here s1 and s2 are 2 segments in the same polyline
433             s1.pop()  # remove the last vert from s1
434             s1.extend(s2)  # add segment 2 to segment 1
435
436             if s1[0][1] == s1[-1][1]:  # remove endpoints double
437                 s1.pop()
438
439             del s2[:]  # Empty this segment s2 so we don't use it again.
440             return True
441
442         joining_segments = True
443         while joining_segments:
444             joining_segments = False
445             segcount = len(loop_segments)
446
447             for j in range(segcount - 1, -1, -1):  # reversed(range(segcount)):
448                 seg_j = loop_segments[j]
449                 if seg_j:
450                     for k in range(j - 1, -1, -1):  # reversed(range(j)):
451                         if not seg_j:
452                             break
453                         seg_k = loop_segments[k]
454
455                         if seg_k and join_seg(seg_j, seg_k):
456                             joining_segments = True
457
458         loop_list = loop_segments
459
460         for verts in loop_list:
461             while verts and verts[0][1] == verts[-1][1]:
462                 verts.pop()
463
464         loop_list = [verts for verts in loop_list if len(verts) > 2]
465         # DONE DEALING WITH LOOP FIXING
466
467         # vert mapping
468         vert_map = [None] * len(indices)
469         ii = 0
470         for verts in loop_list:
471             if len(verts) > 2:
472                 for i, vert in enumerate(verts):
473                     vert_map[i + ii] = vert[2]
474                 ii += len(verts)
475
476         fill = tessellate_polygon([[v[0] for v in loop] for loop in loop_list])
477         #draw_loops(loop_list)
478         #raise Exception("done loop")
479         # map to original indices
480         fill = [[vert_map[i] for i in reversed(f)] for f in fill]
481
482     if not fill:
483         print('Warning Cannot scanfill, fallback on a triangle fan.')
484         fill = [[0, i - 1, i] for i in range(2, len(indices))]
485     else:
486         # Use real scanfill.
487         # See if its flipped the wrong way.
488         flip = None
489         for fi in fill:
490             if flip is not None:
491                 break
492             for i, vi in enumerate(fi):
493                 if vi == 0 and fi[i - 1] == 1:
494                     flip = False
495                     break
496                 elif vi == 1 and fi[i - 1] == 0:
497                     flip = True
498                     break
499
500         if not flip:
501             for i, fi in enumerate(fill):
502                 fill[i] = tuple([ii for ii in reversed(fi)])
503
504     return fill
505
506
507 def face_random_points(num_points, tessfaces):
508     """
509     Generates a list of random points over mesh tessfaces.
510
511     :arg num_points: the number of random points to generate on each face.
512     :type int:
513     :arg tessfaces: list of the faces to generate points on.
514     :type tessfaces: :class:`bpy.types.MeshTessFace`, sequence
515     :return: list of random points over all faces.
516     :rtype: list
517     """
518
519     from random import random
520     from mathutils.geometry import area_tri
521
522     # Split all quads into 2 tris, tris remain unchanged
523     tri_faces = []
524     for f in tessfaces:
525         tris = []
526         verts = f.id_data.vertices
527         fv = f.vertices[:]
528         tris.append((verts[fv[0]].co,
529                      verts[fv[1]].co,
530                      verts[fv[2]].co,
531                     ))
532         if len(fv) == 4:
533             tris.append((verts[fv[0]].co,
534                          verts[fv[3]].co,
535                          verts[fv[2]].co,
536                         ))
537         tri_faces.append(tris)
538
539     # For each face, generate the required number of random points
540     sampled_points = [None] * (num_points * len(tessfaces))
541     for i, tf in enumerate(tri_faces):
542         for k in range(num_points):
543             # If this is a quad, we need to weight its 2 tris by their area
544             if len(tf) != 1:
545                 area1 = area_tri(*tf[0])
546                 area2 = area_tri(*tf[1])
547                 area_tot = area1 + area2
548
549                 area1 = area1 / area_tot
550                 area2 = area2 / area_tot
551
552                 vecs = tf[0 if (random() < area1) else 1]
553             else:
554                 vecs = tf[0]
555
556             u1 = random()
557             u2 = random()
558             u_tot = u1 + u2
559
560             if u_tot > 1:
561                 u1 = 1.0 - u1
562                 u2 = 1.0 - u2
563
564             side1 = vecs[1] - vecs[0]
565             side2 = vecs[2] - vecs[0]
566
567             p = vecs[0] + u1 * side1 + u2 * side2
568
569             sampled_points[num_points * i + k] = p
570
571     return sampled_points