- make ToolSettings.mesh_selection_mode into an array of 3 bools rather then an enum...
[blender-staging.git] / release / scripts / op / mesh_skin.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., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
16 #
17 # ##### END GPL LICENSE BLOCK #####
18
19 # <pep8 compliant>
20
21 # import Blender
22 import time, functools
23 import bpy
24 # from Blender import Window
25 from Mathutils import MidpointVecs, Vector
26 from Mathutils import AngleBetweenVecs as _AngleBetweenVecs_
27 # import BPyMessages
28
29 # from Blender.Draw import PupMenu
30
31 BIG_NUM = 1<<30
32
33 global CULL_METHOD
34 CULL_METHOD = 0
35
36 def AngleBetweenVecs(a1,a2):
37     import math
38     try:
39         return math.degrees(_AngleBetweenVecs_(a1,a2))
40     except:
41         return 180.0
42
43 class edge(object):
44     __slots__ = 'v1', 'v2', 'co1', 'co2', 'length', 'removed', 'match', 'cent', 'angle', 'next', 'prev', 'normal', 'fake'
45     def __init__(self, v1,v2):
46         self.v1 = v1
47         self.v2 = v2
48         co1, co2= v1.co, v2.co
49         self.co1= co1
50         self.co2= co2
51
52         # uv1 uv2 vcol1 vcol2 # Add later
53         self.length = (co1 - co2).length
54         self.removed = 0        # Have we been culled from the eloop
55         self.match = None       # The other edge were making a face with
56
57         self.cent= MidpointVecs(co1, co2)
58         self.angle= 0.0
59         self.fake= False
60
61 class edgeLoop(object):
62     __slots__ = 'centre', 'edges', 'normal', 'closed', 'backup_edges'
63     def __init__(self, loop, me, closed): # Vert loop
64         # Use next and prev, nextDist, prevDist
65
66         # Get Loops centre.
67         fac= len(loop)
68         verts = me.verts
69         self.centre= functools.reduce(lambda a,b: a+verts[b].co/fac, loop, Vector())
70
71         # Convert Vert loop to Edges.
72         self.edges = [edge(verts[loop[vIdx-1]], verts[loop[vIdx]]) for vIdx in range(len(loop))]
73
74         if not closed:
75             self.edges[0].fake = True # fake edge option
76
77         self.closed = closed
78
79
80         # Assign linked list
81         for eIdx in range(len(self.edges)-1):
82             self.edges[eIdx].next = self.edges[eIdx+1]
83             self.edges[eIdx].prev = self.edges[eIdx-1]
84         # Now last
85         self.edges[-1].next = self.edges[0]
86         self.edges[-1].prev = self.edges[-2]
87
88
89
90         # GENERATE AN AVERAGE NORMAL FOR THE WHOLE LOOP.
91         self.normal = Vector()
92         for e in self.edges:
93             n = (self.centre-e.co1).cross(self.centre-e.co2)
94             # Do we realy need tot normalize?
95             n.normalize()
96             self.normal += n
97
98             # Generate the angle
99             va= e.cent - e.prev.cent
100             vb= e.next.cent - e.cent
101
102             e.angle= AngleBetweenVecs(va, vb)
103
104         # Blur the angles
105         #for e in self.edges:
106         #       e.angle= (e.angle+e.next.angle)/2
107
108         # Blur the angles
109         #for e in self.edges:
110         #       e.angle= (e.angle+e.prev.angle)/2
111
112         self.normal.normalize()
113
114         # Generate a normal for each edge.
115         for e in self.edges:
116
117             n1 = e.co1
118             n2 = e.co2
119             n3 = e.prev.co1
120
121             a = n1-n2
122             b = n1-n3
123             normal1 = a.cross(b)
124             normal1.normalize()
125
126             n1 = e.co2
127             n3 = e.next.co2
128             n2 = e.co1
129
130             a = n1-n2
131             b = n1-n3
132
133             normal2 = a.cross(b)
134             normal2.normalize()
135
136             # Reuse normal1 var
137             normal1 += normal1 + normal2
138             normal1.normalize()
139
140             e.normal = normal1
141             #print e.normal
142
143
144
145     def backup(self):
146         # Keep a backup of the edges
147         self.backup_edges = self.edges[:]
148
149     def restore(self):
150         self.edges = self.backup_edges[:]
151         for e in self.edges:
152             e.removed = 0
153
154     def reverse(self):
155         self.edges.reverse()
156         self.normal.negate()
157
158         for e in self.edges:
159             e.normal.negate()
160             e.v1, e.v2 = e.v2, e.v1
161             e.co1, e.co2 = e.co2, e.co1
162             e.next, e.prev = e.prev, e.next
163
164
165     def removeSmallest(self, cullNum, otherLoopLen):
166         '''
167         Removes N Smallest edges and backs up the loop,
168         this is so we can loop between 2 loops as if they are the same length,
169         backing up and restoring incase the loop needs to be skinned with another loop of a different length.
170         '''
171         global CULL_METHOD
172         if CULL_METHOD == 1: # Shortest edge
173             eloopCopy = self.edges[:]
174
175             # Length sort, smallest first
176             try:        eloopCopy.sort(key = lambda e1: e1.length)
177             except:     eloopCopy.sort(lambda e1, e2: cmp(e1.length, e2.length ))
178
179             # Dont use atm
180             #eloopCopy.sort(lambda e1, e2: cmp(e1.angle*e1.length, e2.angle*e2.length)) # Length sort, smallest first
181             #eloopCopy.sort(lambda e1, e2: cmp(e1.angle, e2.angle)) # Length sort, smallest first
182
183             remNum = 0
184             for i, e in enumerate(eloopCopy):
185                 if not e.fake:
186                     e.removed = 1
187                     self.edges.remove( e ) # Remove from own list, still in linked list.
188                     remNum += 1
189
190                     if not remNum < cullNum:
191                         break
192
193         else: # CULL METHOD is even
194
195             culled = 0
196
197             step = int(otherLoopLen / float(cullNum)) * 2
198
199             currentEdge = self.edges[0]
200             while culled < cullNum:
201
202                 # Get the shortest face in the next STEP
203                 step_count= 0
204                 bestAng= 360.0
205                 smallestEdge= None
206                 while step_count<=step or smallestEdge==None:
207                     step_count+=1
208                     if not currentEdge.removed: # 0 or -1 will not be accepted
209                         if currentEdge.angle<bestAng and not currentEdge.fake:
210                             smallestEdge= currentEdge
211                             bestAng= currentEdge.angle
212
213                     currentEdge = currentEdge.next
214
215                 # In that stepping length we have the smallest edge.remove it
216                 smallestEdge.removed = 1
217                 self.edges.remove(smallestEdge)
218
219                 # Start scanning from the edge we found? - result is over fanning- no good.
220                 #currentEdge= smallestEdge.next
221
222                 culled+=1
223
224
225 # Returns face edges.
226 # face must have edge data.
227
228 def mesh_faces_extend(me, faces, mat_idx = 0):
229     orig_facetot = len(me.faces)
230     new_facetot = len(faces)
231     me.add_geometry(0, 0, new_facetot)
232     tot = orig_facetot+new_facetot
233     me_faces = me.faces
234     i= 0
235     while i < new_facetot:
236
237         f = [v.index for v in faces[i]]
238         if len(f)==4:
239             if f[3]==0:
240                 f = f[1], f[2], f[3], f[0]
241         else:
242             f = f[0], f[1], f[2], 0
243
244         mf = me_faces[orig_facetot+i]
245         mf.verts_raw =  f
246         mf.material_index = mat_idx
247         i+=1
248 # end utils
249
250
251 def getSelectedEdges(context, me, ob):
252     MESH_MODE = tuple(context.tool_settings.mesh_selection_mode)
253     context.tool_settings.mesh_selection_mode = False, True, False
254
255     if not MESH_MODE[2]:
256         edges= [ ed for ed in me.edges if ed.selected ]
257         # print len(edges), len(me.edges)
258         context.scene.tool_settings.mesh_selection_mode = MESH_MODE
259         return edges
260
261     else:
262         # value is [edge, face_sel_user_in]
263         edge_dict=  dict((ed.key, [ed, 0]) for ed in me.edges)
264
265         for f in me.faces:
266             if f.selected:
267                 for edkey in f.edge_keys:
268                     edge_dict[edkey][1] += 1
269
270         context.tool_settings.mesh_selection_mode = MESH_MODE
271         return [ ed_data[0] for ed_data in edge_dict.values() if ed_data[1] == 1 ]
272
273
274
275 def getVertLoops(selEdges, me):
276     '''
277     return a list of vert loops, closed and open [(loop, closed)...]
278     '''
279
280     mainVertLoops = []
281     # second method
282     tot = len(me.verts)
283     vert_siblings = [[] for i in range(tot)]
284     vert_used = [False] * tot
285
286     for ed in selEdges:
287         i1, i2 = ed.key
288         vert_siblings[i1].append(i2)
289         vert_siblings[i2].append(i1)
290
291     # find the first used vert and keep looping.
292     for i in range(tot):
293         if vert_siblings[i] and not vert_used[i]:
294             sbl = vert_siblings[i] # siblings
295
296             if len(sbl) > 2:
297                 return None
298
299             vert_used[i] = True
300
301             # do an edgeloop seek
302             if len(sbl) == 2:
303                 contextVertLoop= [sbl[0], i, sbl[1]] # start the vert loop
304                 vert_used[contextVertLoop[ 0]] = True
305                 vert_used[contextVertLoop[-1]] = True
306             else:
307                 contextVertLoop= [i, sbl[0]]
308                 vert_used[contextVertLoop[ 1]] = True
309
310             # Always seek up
311             ok = True
312             while ok:
313                 ok = False
314                 closed = False
315                 sbl = vert_siblings[contextVertLoop[-1]]
316                 if len(sbl) == 2:
317                     next = sbl[not sbl.index( contextVertLoop[-2] )]
318                     if vert_used[next]:
319                         closed = True
320                         # break
321                     else:
322                         contextVertLoop.append( next ) # get the vert that isnt the second last
323                         vert_used[next] = True
324                         ok = True
325
326             # Seek down as long as the starting vert was not at the edge.
327             if not closed and len(vert_siblings[i]) == 2:
328
329                 ok = True
330                 while ok:
331                     ok = False
332                     sbl = vert_siblings[contextVertLoop[0]]
333                     if len(sbl) == 2:
334                         next = sbl[not sbl.index( contextVertLoop[1] )]
335                         if vert_used[next]:
336                             closed = True
337                         else:
338                             contextVertLoop.insert(0, next) # get the vert that isnt the second last
339                             vert_used[next] = True
340                             ok = True
341
342             mainVertLoops.append((contextVertLoop, closed))
343
344
345     verts = me.verts
346     # convert from indicies to verts
347     # mainVertLoops = [([verts[i] for i in contextVertLoop], closed) for contextVertLoop, closed in  mainVertLoops]
348     # print len(mainVertLoops)
349     return mainVertLoops
350
351
352
353 def skin2EdgeLoops(eloop1, eloop2, me, ob, MODE):
354
355     new_faces= [] #
356
357     # Make sure e1 loops is bigger then e2
358     if len(eloop1.edges) != len(eloop2.edges):
359         if len(eloop1.edges) < len(eloop2.edges):
360             eloop1, eloop2 = eloop2, eloop1
361
362         eloop1.backup() # were about to cull faces
363         CULL_FACES = len(eloop1.edges) - len(eloop2.edges)
364         eloop1.removeSmallest(CULL_FACES, len(eloop1.edges))
365     else:
366         CULL_FACES = 0
367     # First make sure poly vert loops are in sync with eachother.
368
369     # The vector allong which we are skinning.
370     skinVector = eloop1.centre - eloop2.centre
371
372     loopDist = skinVector.length
373
374     # IS THE LOOP FLIPPED, IF SO FLIP BACK. we keep it flipped, its ok,
375     if eloop1.closed or eloop2.closed:
376         angleBetweenLoopNormals = AngleBetweenVecs(eloop1.normal, eloop2.normal)
377         if angleBetweenLoopNormals > 90:
378             eloop2.reverse()
379
380
381         DIR= eloop1.centre - eloop2.centre
382
383         # if eloop2.closed:
384         bestEloopDist = BIG_NUM
385         bestOffset = 0
386         # Loop rotation offset to test.1
387         eLoopIdxs = list(range(len(eloop1.edges)))
388         for offset in range(len(eloop1.edges)):
389             totEloopDist = 0 # Measure this total distance for thsi loop.
390
391             offsetIndexLs = eLoopIdxs[offset:] + eLoopIdxs[:offset] # Make offset index list
392
393
394             # e1Idx is always from 0uu to N, e2Idx is offset.
395             for e1Idx, e2Idx in enumerate(offsetIndexLs):
396                 e1= eloop1.edges[e1Idx]
397                 e2= eloop2.edges[e2Idx]
398
399
400                 # Include fan connections in the measurement.
401                 OK= True
402                 while OK or e1.removed:
403                     OK= False
404
405                     # Measure the vloop distance ===============
406                     diff= ((e1.cent - e2.cent).length) #/ nangle1
407
408                     ed_dir= e1.cent-e2.cent
409                     a_diff= AngleBetweenVecs(DIR, ed_dir)/18 # 0 t0 18
410
411                     totEloopDist += (diff * (1+a_diff)) / (1+loopDist)
412
413                     # Premeture break if where no better off
414                     if totEloopDist > bestEloopDist:
415                         break
416
417                     e1=e1.next
418
419             if totEloopDist < bestEloopDist:
420                 bestOffset = offset
421                 bestEloopDist = totEloopDist
422
423         # Modify V2 LS for Best offset
424         eloop2.edges = eloop2.edges[bestOffset:] + eloop2.edges[:bestOffset]
425
426     else:
427         # Both are open loops, easier to calculate.
428
429
430         # Make sure the fake edges are at the start.
431         for i, edloop in enumerate((eloop1, eloop2)):
432             # print "LOOPO"
433             if edloop.edges[0].fake:
434                 # alredy at the start
435                 #print "A"
436                 pass
437             elif edloop.edges[-1].fake:
438                 # put the end at the start
439                 edloop.edges.insert(0, edloop.edges.pop())
440                 #print "B"
441
442             else:
443                 for j, ed in enumerate(edloop.edges):
444                     if ed.fake:
445                         #print "C"
446                         edloop.edges = edloop.edges = edloop.edges[j:] + edloop.edges[:j]
447                         break
448         # print "DONE"
449         ed1, ed2 = eloop1.edges[0], eloop2.edges[0]
450
451         if not ed1.fake or not ed2.fake:
452             raise "Error"
453
454         # Find the join that isnt flipped (juts like detecting a bow-tie face)
455         a1 = (ed1.co1 - ed2.co1).length + (ed1.co2 - ed2.co2).length
456         a2 = (ed1.co1 - ed2.co2).length + (ed1.co2 - ed2.co1).length
457
458         if a1 > a2:
459             eloop2.reverse()
460             # make the first edge the start edge still
461             eloop2.edges.insert(0, eloop2.edges.pop())
462
463
464
465
466     for loopIdx in range(len(eloop2.edges)):
467         e1 = eloop1.edges[loopIdx]
468         e2 = eloop2.edges[loopIdx]
469
470         # Remember the pairs for fan filling culled edges.
471         e1.match = e2; e2.match = e1
472
473         if not (e1.fake or e2.fake):
474             new_faces.append([e1.v1, e1.v2, e2.v2, e2.v1])
475
476     # FAN FILL MISSING FACES.
477     if CULL_FACES:
478         # Culled edges will be in eloop1.
479         FAN_FILLED_FACES = 0
480
481         contextEdge = eloop1.edges[0] # The larger of teh 2
482         while FAN_FILLED_FACES < CULL_FACES:
483             while contextEdge.next.removed == 0:
484                 contextEdge = contextEdge.next
485
486             vertFanPivot = contextEdge.match.v2
487
488             while contextEdge.next.removed == 1:
489                 #if not contextEdge.next.fake:
490                 new_faces.append([contextEdge.next.v1, contextEdge.next.v2, vertFanPivot])
491
492                 # Should we use another var?, this will work for now.
493                 contextEdge.next.removed = 1
494
495                 contextEdge = contextEdge.next
496                 FAN_FILLED_FACES += 1
497
498         # may need to fan fill backwards 1 for non closed loops.
499
500         eloop1.restore() # Add culled back into the list.
501
502     return new_faces
503
504 def main(context):
505     global CULL_METHOD
506
507     ob = context.object
508
509     is_editmode = (ob.mode=='EDIT')
510     if is_editmode: bpy.ops.object.mode_set(mode='OBJECT', toggle=False)
511     if ob == None or ob.type != 'MESH':
512         raise Exception("BPyMessages.Error_NoMeshActive()")
513         return
514
515     me = ob.data
516
517     time1 = time.time()
518     selEdges = getSelectedEdges(context, me, ob)
519     vertLoops = getVertLoops(selEdges, me) # list of lists of edges.
520     if vertLoops == None:
521         raise Exception('Error%t|Selection includes verts that are a part of more then 1 loop')
522         if is_editmode: bpy.ops.object.mode_set(mode='EDIT', toggle=False)
523         return
524     # print len(vertLoops)
525
526
527     if len(vertLoops) > 2:
528         choice = PupMenu('Loft '+str(len(vertLoops))+' edge loops%t|loop|segment')
529         if choice == -1:
530             if is_editmode: bpy.ops.object.mode_set(mode='EDIT', toggle=False)
531             return
532
533     elif len(vertLoops) < 2:
534         raise Exception('Error%t|No Vertloops found!')
535         if is_editmode: bpy.ops.object.mode_set(mode='EDIT', toggle=False)
536         return
537     else:
538         choice = 2
539
540
541     # The line below checks if any of the vert loops are differenyt in length.
542     if False in [len(v[0]) == len(vertLoops[0][0]) for v in vertLoops]:
543 #XXX            CULL_METHOD = PupMenu('Small to large edge loop distrobution method%t|remove edges evenly|remove smallest edges')
544 #XXX            if CULL_METHOD == -1:
545 #XXX                    if is_editmode: Window.EditMode(1)
546 #XXX                    return
547
548         CULL_METHOD = 1 # XXX FIXME
549
550
551
552
553         if CULL_METHOD ==1: # RESET CULL_METHOD
554             CULL_METHOD = 0 # shortest
555         else:
556             CULL_METHOD = 1 # even
557
558
559     time1 = time.time()
560     # Convert to special edge data.
561     edgeLoops = []
562     for vloop, closed in vertLoops:
563         edgeLoops.append(edgeLoop(vloop, me, closed))
564
565
566     # VERT LOOP ORDERING CODE
567     # "Build a worm" list - grow from Both ends
568     edgeOrderedList = [edgeLoops.pop()]
569
570     # Find the closest.
571     bestSoFar = BIG_NUM
572     bestIdxSoFar = None
573     for edLoopIdx, edLoop in enumerate(edgeLoops):
574         l =(edgeOrderedList[-1].centre - edLoop.centre).length
575         if l < bestSoFar:
576             bestIdxSoFar = edLoopIdx
577             bestSoFar = l
578
579     edgeOrderedList.append( edgeLoops.pop(bestIdxSoFar) )
580
581     # Now we have the 2 closest, append to either end-
582     # Find the closest.
583     while edgeLoops:
584         bestSoFar = BIG_NUM
585         bestIdxSoFar = None
586         first_or_last = 0 # Zero is first
587         for edLoopIdx, edLoop in enumerate(edgeLoops):
588             l1 =(edgeOrderedList[-1].centre - edLoop.centre).length
589
590             if l1 < bestSoFar:
591                 bestIdxSoFar = edLoopIdx
592                 bestSoFar = l1
593                 first_or_last = 1 # last
594
595             l2 =(edgeOrderedList[0].centre - edLoop.centre).length
596             if l2 < bestSoFar:
597                 bestIdxSoFar = edLoopIdx
598                 bestSoFar = l2
599                 first_or_last = 0 # last
600
601         if first_or_last: # add closest Last
602             edgeOrderedList.append( edgeLoops.pop(bestIdxSoFar) )
603         else: # Add closest First
604             edgeOrderedList.insert(0, edgeLoops.pop(bestIdxSoFar) )      # First
605
606     faces = []
607
608     for i in range(len(edgeOrderedList)-1):
609         faces.extend( skin2EdgeLoops(edgeOrderedList[i], edgeOrderedList[i+1], me, ob, 0) )
610     if choice == 1 and len(edgeOrderedList) > 2: # Loop
611         faces.extend( skin2EdgeLoops(edgeOrderedList[0], edgeOrderedList[-1], me, ob, 0) )
612
613     # REMOVE SELECTED FACES.
614     MESH_MODE= ob.mode
615     if MESH_MODE == 'EDGE' or MESH_MODE == 'VERTEX': pass
616     elif MESH_MODE == 'FACE':
617         try: me.faces.delete(1, [ f for f in me.faces if f.sel ])
618         except: pass
619
620     if 1: # 2.5
621         mesh_faces_extend(me, faces, ob.active_material_index)
622         me.update(calc_edges=True)
623     else:
624         me.faces.extend(faces, smooth = True)
625
626     print('\nSkin done in %.4f sec.' % (time.time()-time1))
627
628     if is_editmode: bpy.ops.object.mode_set(mode='EDIT', toggle=False)
629
630
631 class MESH_OT_skin(bpy.types.Operator):
632     '''Bridge face loops.'''
633
634     bl_idname = "mesh.skin"
635     bl_label = "Add Torus"
636     bl_register = True
637     bl_undo = True
638
639     '''
640     loft_method = EnumProperty(attr="loft_method", items=[(), ()], description="", default= True)
641
642     '''
643
644     def execute(self, context):
645         main(context)
646         return ('FINISHED',)
647
648
649 # Register the operator
650 bpy.ops.add(MESH_OT_skin)
651
652 # Add to a menu
653 import dynamic_menu
654 menu_item = dynamic_menu.add(bpy.types.VIEW3D_MT_edit_mesh_faces, (lambda self, context: self.layout.operator("mesh.skin", text="Bridge Faces")) )
655
656 if __name__ == "__main__":
657     bpy.ops.mesh.skin()