tested working revision 36710 index_visualizer & screencast keys.
[blender-addons-contrib.git] / mesh_select_vertex_groups.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 bl_info = {
20     'name': 'Select Vertex Groups',
21     'author': 'Martin Ellison',
22     'version': (1, 0),
23     'blender': (2, 5, 4),
24     'api': 36710,
25     'location': 'Toolbox',
26     'description': 'Finds all the vertex groups that chosen verts are in, & any verts that are not in any group',
27     'warning': '', # used for warning icon and text in addons panel
28     'wiki_url': '',
29     'tracker_url': 'https://projects.blender.org/tracker/index.php?'\
30         'func=detail&aid=22025',
31     'category': 'Mesh'}
32
33 """
34 This script finds all the vertex groups that chosen vertexes are in, and any vertexes that are not in any vertex group.
35
36 This is useful for cleaning up a mesh if vertex groups under animation go off to the wrong place (because they are in a vertex group that they should not be in, or not in the vertex group that they should be in).
37
38 How to use:
39 1. select a mesh and get into edit mode.
40 2. by default it will use all vertexes; alternatively, select vertexes of interest and click on 'use selected vertexes'. Note that subsequent selections and deselections of vertexes will not change the set of vertexes to be used, you need to click on these buttons again to do that.
41 3. click on 'select' and 'deselect' buttons for listed vertex groups, and for no vertex group, to select and deselect vertexes.
42
43 This only lists vertex groups that have used vertexes.
44
45 You may want to use the mesh select/deselect all (keyboard A) operator to start.
46
47 Once you have the right vertexes selected, you can use the standard vertex groups property editor to add them to or remove them from the desired vertex groups.
48 """
49
50
51 import bpy
52 from bpy.props import *
53
54 global use_selected_only, used_vertexes, the_mesh, vertex_usage
55 use_selected_only = False
56 used_vertexes = set()
57 the_mesh = None
58 vertex_usage = ''
59
60 class UseAll(bpy.types.Operator):
61     bl_idname = "mesh.primitive_fvg_useall"
62     bl_label = "Use all Vertexes"
63     bl_register = True
64     bl_undo = True
65     #limit = FloatProperty(name="limit", description="Ignore weights under this limit.", default= 0.01, min = 0.0, max = 1.0, soft_min=0.0, soft_max=1.0)
66
67     def execute(self, context):
68         global use_selected_only
69         use_selected_only = False
70         bpy.ops.object.editmode_toggle()
71         set_used()
72         bpy.ops.object.editmode_toggle()
73         return {'FINISHED'}
74
75 class UseSelected(bpy.types.Operator):
76     bl_idname = "mesh.primitive_fvg_useselected"
77     bl_label = "Use Selected Vertexes"
78     bl_register = True
79     bl_undo = True
80
81     def execute(self, context):
82         global use_selected_only
83         use_selected_only = True
84         bpy.ops.object.editmode_toggle()
85         set_used()
86         bpy.ops.object.editmode_toggle()
87         return {'FINISHED'}
88
89 class SelectFound(bpy.types.Operator):
90     bl_idname = "mesh.primitive_fvg_selfound"
91     bl_label = "Select"
92     bl_register = True
93     bl_undo = True
94     vertexgroup = bpy.props.StringProperty(name = 'vertexgroup', description = 'vertexgroup', default = '', options = set())
95
96     def execute(self, context):
97         global the_mesh
98         bpy.ops.object.editmode_toggle()
99         vertexgroup = self.properties.vertexgroup
100         fv = found_verts(vertexgroup)
101         for v in fv: v.select = True
102         bpy.ops.object.editmode_toggle()
103         return {'FINISHED'}
104
105 class DeselectFound(bpy.types.Operator):
106     bl_idname = "mesh.primitive_fvg_deselfound"
107     bl_label = "Deselect"
108     bl_register = True
109     bl_undo = True
110     vertexgroup = bpy.props.StringProperty(name = 'vertexgroup', description = 'vertexgroup', default = '', options = set())
111
112     def execute(self, context):
113         global the_mesh
114         bpy.ops.object.editmode_toggle()
115         vertexgroup = self.properties.vertexgroup
116         fv = found_verts(vertexgroup)
117         for v in fv: v.select = False
118         bpy.ops.object.editmode_toggle()
119         return {'FINISHED'}
120
121 def set_used():
122         global use_selected_only, used_vertexes, the_mesh, vertex_usage
123         obj = bpy.context.active_object
124         used_vertexes = set()
125         if use_selected_only:
126                 for v in obj.data.vertices:
127                         if v.select: used_vertexes.add(v.index)
128         else:
129                 for v in obj.data.vertices: used_vertexes.add(v.index)
130         the_mesh = obj
131         vertex_usage = '%d vertexes used' % (len(used_vertexes))
132
133
134 def make_groups(limit):
135         global used_vertexes
136         vgp = []
137         vgdict = {}
138         vgused = {}
139         obj = bpy.context.active_object
140         all_in_group = True
141         for vg in obj.vertex_groups:
142                 vgdict[vg.index] = vg.name
143         for v in obj.data.vertices:
144                 in_group = False
145                 if v.index in used_vertexes:
146                         for g in v.groups:
147                                 gr = g.group
148                                 w = g.weight
149                                 if w > limit:
150                                         if not gr in vgused: vgused[gr] = 0
151                                         vgused[gr] += 1
152                                         in_group = True
153                 if not in_group: all_in_group = False
154         if not all_in_group:
155                 vgp.append(("no group", "(No group)"))
156         for gn in vgused.keys():
157                 name = vgdict[gn]
158                 vgp.append((name, '%s has %d vertexes' % (name, vgused[gn]) ))
159         print("%d groups found\n" % len(vgp))
160         return vgp
161
162 def found_verts(vertex_group):
163         global used_vertexes
164         vgfound = []
165         obj = bpy.context.active_object
166         if vertex_group == 'no group':
167                 for v in obj.data.vertices:
168                         if v.index in used_vertexes and len(v.groups) == 0:
169                                 vgfound.append(v)
170         else:
171                 vgnum = -1
172                 for vg in obj.vertex_groups:
173                         if vg.name == vertex_group: vgnum = vg.index
174                 for v in obj.data.vertices:
175                         if v.index in used_vertexes:
176                                 found = False
177                                 for g in v.groups:
178                                         if g.group == vgnum: found = True
179                                 if found: vgfound.append(v)
180         print('%d vertexes found for %s' % (len(vgfound), vertex_group))
181         return vgfound
182
183
184 class VIEW3D_PT_FixVertexGroups(bpy.types.Panel):
185     bl_space_type = "VIEW_3D"
186     bl_region_type = "TOOLS"
187     bl_label = "Select Vertex Groups"
188
189     @classmethod
190     def poll(self, context):
191         if bpy.context.active_object:
192            obj = bpy.context.active_object
193            if obj.type == 'MESH' and obj.mode == 'EDIT': return True
194         return False
195
196     def draw(self, context):
197         global use_selected_only, used_vertexes, the_mesh, vertex_usage
198
199         if bpy.context.active_object:
200            obj = bpy.context.active_object
201            if obj.type == 'MESH' and obj.mode == 'EDIT':
202                 layout = self.layout
203                 use_all = layout.operator("mesh.primitive_fvg_useall", "Use all vertexes")
204                 layout.operator("mesh.primitive_fvg_useselected", "Use selected vertexes")
205                 if use_selected_only:
206                     layout.label(text = 'Using selected vertexes.')
207                 else:
208                     layout.label(text = 'Using all vertexes.')
209                 layout.label(vertex_usage)
210                 if len(used_vertexes) == 0 or obj is not the_mesh: set_used()
211                 #layout.prop(use_all, 'limit', slider = True)
212                 #groups = make_groups(use_all.limitval)
213                 groups = make_groups(0.01)
214                 for gp in groups:
215                         layout.label(text = gp[1])
216                         row = layout.row()
217                         sel_op = row.operator("mesh.primitive_fvg_selfound", "Select")
218                         sel_op.vertexgroup = gp[0]
219                         desel_op = row.operator("mesh.primitive_fvg_deselfound", "Deselect")
220                         desel_op.vertexgroup = gp[0]
221
222 classes = [UseAll, UseSelected, SelectFound, DeselectFound]
223
224 def register():
225     bpy.utils.register_module(__name__)
226     pass
227
228 def unregister():
229     bpy.utils.unregister_module(__name__)
230     pass
231
232 if __name__ == "__main__":
233     print('------ executing --------')
234     register()