naming changes
[blender.git] / release / scripts / op / wm.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
23 from bpy.props import *
24
25
26 class MESH_OT_delete_edgeloop(bpy.types.Operator):
27     '''Delete an edge loop by merging the faces on each side to a single face loop'''
28     bl_idname = "mesh.delete_edgeloop"
29     bl_label = "Delete Edge Loop"
30
31     def execute(self, context):
32         bpy.ops.transform.edge_slide(value=1.0)
33         bpy.ops.mesh.select_more()
34         bpy.ops.mesh.remove_doubles()
35
36         return {'FINISHED'}
37
38 rna_path_prop = StringProperty(name="Context Attributes",
39         description="rna context string", maxlen=1024, default="")
40
41 rna_reverse_prop = BoolProperty(name="Reverse",
42         description="Cycle backwards", default=False)
43
44 rna_relative_prop = BoolProperty(name="Relative",
45         description="Apply relative to the current value (delta)",
46         default=False)
47
48
49 def context_path_validate(context, data_path):
50     import sys
51     try:
52         value = eval("context.%s" % data_path)
53     except AttributeError:
54         if "'NoneType'" in str(sys.exc_info()[1]):
55             # One of the items in the rna path is None, just ignore this
56             value = Ellipsis
57         else:
58             # We have a real error in the rna path, dont ignore that
59             raise
60
61     return value
62
63
64 def execute_context_assign(self, context):
65     if context_path_validate(context, self.properties.data_path) is Ellipsis:
66         return {'PASS_THROUGH'}
67
68     if getattr(self.properties, "relative", False):
69         exec("context.%s+=self.properties.value" % self.properties.data_path)
70     else:
71         exec("context.%s=self.properties.value" % self.properties.data_path)
72
73     return {'FINISHED'}
74
75
76 class WM_OT_context_set_boolean(bpy.types.Operator):
77     '''Set a context value.'''
78     bl_idname = "wm.context_set_boolean"
79     bl_label = "Context Set Boolean"
80     bl_options = {'UNDO'}
81
82     data_path = rna_path_prop
83     value = BoolProperty(name="Value",
84             description="Assignment value", default=True)
85
86     execute = execute_context_assign
87
88
89 class WM_OT_context_set_int(bpy.types.Operator): # same as enum
90     '''Set a context value.'''
91     bl_idname = "wm.context_set_int"
92     bl_label = "Context Set"
93     bl_options = {'UNDO'}
94
95     data_path = rna_path_prop
96     value = IntProperty(name="Value", description="Assign value", default=0)
97     relative = rna_relative_prop
98
99     execute = execute_context_assign
100
101
102 class WM_OT_context_scale_int(bpy.types.Operator): # same as enum
103     '''Scale an int context value.'''
104     bl_idname = "wm.context_scale_int"
105     bl_label = "Context Set"
106     bl_options = {'UNDO'}
107
108     data_path = rna_path_prop
109     value = FloatProperty(name="Value", description="Assign value", default=1.0)
110     always_step = BoolProperty(name="Always Step",
111         description="Always adjust the value by a minimum of 1 when 'value' is not 1.0.",
112         default=True)
113
114     def execute(self, context):
115         if context_path_validate(context, self.properties.data_path) is Ellipsis:
116             return {'PASS_THROUGH'}
117
118         value = self.properties.value
119         data_path = self.properties.data_path
120
121         if value == 1.0: # nothing to do
122             return {'CANCELLED'}
123
124         if getattr(self.properties, "always_step", False):
125             if value > 1.0:
126                 add = "1"
127                 func = "max"
128             else:
129                 add = "-1"
130                 func = "min"
131             exec("context.%s = %s(round(context.%s * value), context.%s + %s)" % (data_path, func, data_path, data_path, add))
132         else:
133             exec("context.%s *= value" % self.properties.data_path)
134
135         return {'FINISHED'}
136
137
138 class WM_OT_context_set_float(bpy.types.Operator): # same as enum
139     '''Set a context value.'''
140     bl_idname = "wm.context_set_float"
141     bl_label = "Context Set Float"
142     bl_options = {'UNDO'}
143
144     data_path = rna_path_prop
145     value = FloatProperty(name="Value",
146             description="Assignment value", default=0.0)
147     relative = rna_relative_prop
148
149     execute = execute_context_assign
150
151
152 class WM_OT_context_set_string(bpy.types.Operator): # same as enum
153     '''Set a context value.'''
154     bl_idname = "wm.context_set_string"
155     bl_label = "Context Set String"
156     bl_options = {'UNDO'}
157
158     data_path = rna_path_prop
159     value = StringProperty(name="Value",
160             description="Assign value", maxlen=1024, default="")
161
162     execute = execute_context_assign
163
164
165 class WM_OT_context_set_enum(bpy.types.Operator):
166     '''Set a context value.'''
167     bl_idname = "wm.context_set_enum"
168     bl_label = "Context Set Enum"
169     bl_options = {'UNDO'}
170
171     data_path = rna_path_prop
172     value = StringProperty(name="Value",
173             description="Assignment value (as a string)",
174             maxlen=1024, default="")
175
176     execute = execute_context_assign
177
178
179 class WM_OT_context_set_value(bpy.types.Operator):
180     '''Set a context value.'''
181     bl_idname = "wm.context_set_value"
182     bl_label = "Context Set Value"
183     bl_options = {'UNDO'}
184
185     data_path = rna_path_prop
186     value = StringProperty(name="Value",
187             description="Assignment value (as a string)",
188             maxlen=1024, default="")
189
190     def execute(self, context):
191         if context_path_validate(context, self.properties.data_path) is Ellipsis:
192             return {'PASS_THROUGH'}
193         exec("context.%s=%s" % (self.properties.data_path, self.properties.value))
194         return {'FINISHED'}
195
196
197 class WM_OT_context_toggle(bpy.types.Operator):
198     '''Toggle a context value.'''
199     bl_idname = "wm.context_toggle"
200     bl_label = "Context Toggle"
201     bl_options = {'UNDO'}
202
203     data_path = rna_path_prop
204
205     def execute(self, context):
206
207         if context_path_validate(context, self.properties.data_path) is Ellipsis:
208             return {'PASS_THROUGH'}
209
210         exec("context.%s=not (context.%s)" %
211             (self.properties.data_path, self.properties.data_path))
212
213         return {'FINISHED'}
214
215
216 class WM_OT_context_toggle_enum(bpy.types.Operator):
217     '''Toggle a context value.'''
218     bl_idname = "wm.context_toggle_enum"
219     bl_label = "Context Toggle Values"
220     bl_options = {'UNDO'}
221
222     data_path = rna_path_prop
223     value_1 = StringProperty(name="Value", \
224                 description="Toggle enum", maxlen=1024, default="")
225
226     value_2 = StringProperty(name="Value", \
227                 description="Toggle enum", maxlen=1024, default="")
228
229     def execute(self, context):
230
231         if context_path_validate(context, self.properties.data_path) is Ellipsis:
232             return {'PASS_THROUGH'}
233
234         exec("context.%s = ['%s', '%s'][context.%s!='%s']" % \
235             (self.properties.data_path, self.properties.value_1,\
236              self.properties.value_2, self.properties.data_path,
237              self.properties.value_2))
238
239         return {'FINISHED'}
240
241
242 class WM_OT_context_cycle_int(bpy.types.Operator):
243     '''Set a context value. Useful for cycling active material,
244     vertex keys, groups' etc.'''
245     bl_idname = "wm.context_cycle_int"
246     bl_label = "Context Int Cycle"
247     bl_options = {'UNDO'}
248
249     data_path = rna_path_prop
250     reverse = rna_reverse_prop
251
252     def execute(self, context):
253         data_path = self.properties.data_path
254         value = context_path_validate(context, data_path)
255         if value is Ellipsis:
256             return {'PASS_THROUGH'}
257
258         if self.properties.reverse:
259             value -= 1
260         else:
261             value += 1
262
263         exec("context.%s=value" % data_path)
264
265         if value != eval("context.%s" % data_path):
266             # relies on rna clamping int's out of the range
267             if self.properties.reverse:
268                 value = (1 << 32)
269             else:
270                 value = - (1 << 32)
271
272             exec("context.%s=value" % data_path)
273
274         return {'FINISHED'}
275
276
277 class WM_OT_context_cycle_enum(bpy.types.Operator):
278     '''Toggle a context value.'''
279     bl_idname = "wm.context_cycle_enum"
280     bl_label = "Context Enum Cycle"
281     bl_options = {'UNDO'}
282
283     data_path = rna_path_prop
284     reverse = rna_reverse_prop
285
286     def execute(self, context):
287
288         value = context_path_validate(context, self.properties.data_path)
289         if value is Ellipsis:
290             return {'PASS_THROUGH'}
291
292         orig_value = value
293
294         # Have to get rna enum values
295         rna_struct_str, rna_prop_str = self.properties.data_path.rsplit('.', 1)
296         i = rna_prop_str.find('[')
297
298         # just incse we get "context.foo.bar[0]"
299         if i != -1:
300             rna_prop_str = rna_prop_str[0:i]
301
302         rna_struct = eval("context.%s.rna_type" % rna_struct_str)
303
304         rna_prop = rna_struct.properties[rna_prop_str]
305
306         if type(rna_prop) != bpy.types.EnumProperty:
307             raise Exception("expected an enum property")
308
309         enums = rna_struct.properties[rna_prop_str].items.keys()
310         orig_index = enums.index(orig_value)
311
312         # Have the info we need, advance to the next item
313         if self.properties.reverse:
314             if orig_index == 0:
315                 advance_enum = enums[-1]
316             else:
317                 advance_enum = enums[orig_index-1]
318         else:
319             if orig_index == len(enums) - 1:
320                 advance_enum = enums[0]
321             else:
322                 advance_enum = enums[orig_index + 1]
323
324         # set the new value
325         exec("context.%s=advance_enum" % self.properties.data_path)
326         return {'FINISHED'}
327
328 doc_id = StringProperty(name="Doc ID",
329         description="", maxlen=1024, default="", options={'HIDDEN'})
330
331 doc_new = StringProperty(name="Edit Description",
332         description="", maxlen=1024, default="")
333
334
335 class WM_OT_context_modal_mouse(bpy.types.Operator):
336     '''Adjust arbitrary values with mouse input'''
337     bl_idname = "wm.context_modal_mouse"
338     bl_label = "Context Modal Mouse"
339
340     data_path_iter = StringProperty(description="The data path relative to the context, must point to an iterable.")
341     data_path_item = StringProperty(description="The data path from each iterable to the value (int or float)")
342     input_scale = FloatProperty(default=0.01, description="Scale the mouse movement by this value before applying the delta")
343     invert = BoolProperty(default=False, description="Invert the mouse input")
344     initial_x = IntProperty(options={'HIDDEN'})
345
346     def _values_store(self, context):
347         data_path_iter = self.properties.data_path_iter
348         data_path_item = self.properties.data_path_item
349
350         self._values = values = {}
351
352         for item in getattr(context, data_path_iter):
353             try:
354                 value_orig = eval("item." + data_path_item)
355             except:
356                 continue
357
358             # check this can be set, maybe this is library data.
359             try:
360                 exec("item.%s = %s" % (data_path_item, value_orig))
361             except:
362                 continue
363
364             values[item] = value_orig
365
366     def _values_delta(self, delta):
367         delta *= self.properties.input_scale
368         if self.properties.invert:
369             delta = - delta
370
371         data_path_item = self.properties.data_path_item
372         for item, value_orig in self._values.items():
373             if type(value_orig) == int:
374                 exec("item.%s = int(%d)" % (data_path_item, round(value_orig + delta)))
375             else:
376                 exec("item.%s = %f" % (data_path_item, value_orig + delta))
377
378     def _values_restore(self):
379         data_path_item = self.properties.data_path_item
380         for item, value_orig in self._values.items():
381             exec("item.%s = %s" % (data_path_item, value_orig))
382
383         self._values.clear()
384
385     def _values_clear(self):
386         self._values.clear()
387
388     def modal(self, context, event):
389         event_type = event.type
390
391         if event_type == 'MOUSEMOVE':
392             delta = event.mouse_x - self.properties.initial_x
393             self._values_delta(delta)
394
395         elif 'LEFTMOUSE' == event_type:
396             self._values_clear()
397             return {'FINISHED'}
398
399         elif event_type in ('RIGHTMOUSE', 'ESC'):
400             self._values_restore()
401             return {'FINISHED'}
402
403         return {'RUNNING_MODAL'}
404
405     def invoke(self, context, event):
406         self._values_store(context)
407
408         if not self._values:
409             self.report({'WARNING'}, "Nothing to operate on: %s[ ].%s" %
410                     (self.properties.data_path_iter, self.properties.data_path_item))
411
412             return {'CANCELLED'}
413         else:
414             self.properties.initial_x = event.mouse_x
415
416             context.manager.add_modal_handler(self)
417             return {'RUNNING_MODAL'}
418
419
420 class WM_OT_url_open(bpy.types.Operator):
421     "Open a website in the Webbrowser"
422     bl_idname = "wm.url_open"
423     bl_label = ""
424
425     url = StringProperty(name="URL", description="URL to open")
426
427     def execute(self, context):
428         import webbrowser
429         webbrowser.open(self.properties.url)
430         return {'FINISHED'}
431
432
433 class WM_OT_doc_view(bpy.types.Operator):
434     '''Load online reference docs'''
435     bl_idname = "wm.doc_view"
436     bl_label = "View Documentation"
437
438     doc_id = doc_id
439     _prefix = 'http://www.blender.org/documentation/250PythonDoc'
440
441     def _nested_class_string(self, class_string):
442         ls = []
443         class_obj = getattr(bpy.types, class_string, None).bl_rna
444         while class_obj:
445             ls.insert(0, class_obj)
446             class_obj = class_obj.nested
447         return '.'.join([class_obj.identifier for class_obj in ls])
448
449     def execute(self, context):
450         id_split = self.properties.doc_id.split('.')
451         if len(id_split) == 1: # rna, class
452             url = '%s/bpy.types.%s.html' % (self._prefix, id_split[0])
453         elif len(id_split) == 2: # rna, class.prop
454             class_name, class_prop = id_split
455
456             if hasattr(bpy.types, class_name.upper() + '_OT_' + class_prop):
457                 url = '%s/bpy.ops.%s.html#bpy.ops.%s.%s' % \
458                         (self._prefix, class_name, class_name, class_prop)
459             else:
460                 # It so happens that epydoc nests these, not sphinx
461                 # class_name_full = self._nested_class_string(class_name)
462                 url = '%s/bpy.types.%s.html#bpy.types.%s.%s' % \
463                         (self._prefix, class_name, class_name, class_prop)
464
465         else:
466             return {'PASS_THROUGH'}
467
468         import webbrowser
469         webbrowser.open(url)
470
471         return {'FINISHED'}
472
473
474 class WM_OT_doc_edit(bpy.types.Operator):
475     '''Load online reference docs'''
476     bl_idname = "wm.doc_edit"
477     bl_label = "Edit Documentation"
478
479     doc_id = doc_id
480     doc_new = doc_new
481
482     _url = "http://www.mindrones.com/blender/svn/xmlrpc.php"
483
484     def _send_xmlrpc(self, data_dict):
485         print("sending data:", data_dict)
486
487         import xmlrpc.client
488         user = 'blenderuser'
489         pwd = 'blender>user'
490
491         docblog = xmlrpc.client.ServerProxy(self._url)
492         docblog.metaWeblog.newPost(1, user, pwd, data_dict, 1)
493
494     def execute(self, context):
495
496         doc_id = self.properties.doc_id
497         doc_new = self.properties.doc_new
498
499         class_name, class_prop = doc_id.split('.')
500
501         if not doc_new:
502             self.report({'ERROR'}, "No input given for '%s'" % doc_id)
503             return {'CANCELLED'}
504
505         # check if this is an operator
506         op_name = class_name.upper() + '_OT_' + class_prop
507         op_class = getattr(bpy.types, op_name, None)
508
509         # Upload this to the web server
510         upload = {}
511
512         if op_class:
513             rna = op_class.bl_rna
514             doc_orig = rna.description
515             if doc_orig == doc_new:
516                 return {'RUNNING_MODAL'}
517
518             print("op - old:'%s' -> new:'%s'" % (doc_orig, doc_new))
519             upload["title"] = 'OPERATOR %s:%s' % (doc_id, doc_orig)
520         else:
521             rna = getattr(bpy.types, class_name).bl_rna
522             doc_orig = rna.properties[class_prop].description
523             if doc_orig == doc_new:
524                 return {'RUNNING_MODAL'}
525
526             print("rna - old:'%s' -> new:'%s'" % (doc_orig, doc_new))
527             upload["title"] = 'RNA %s:%s' % (doc_id, doc_orig)
528
529         upload["description"] = doc_new
530
531         self._send_xmlrpc(upload)
532
533         return {'FINISHED'}
534
535     def draw(self, context):
536         layout = self.layout
537         props = self.properties
538         layout.label(text="Descriptor ID: '%s'" % props.doc_id)
539         layout.prop(props, "doc_new", text="")
540
541     def invoke(self, context, event):
542         wm = context.manager
543         return wm.invoke_props_dialog(self, width=600)
544
545
546 import rna_prop_ui
547
548 classes = [
549     MESH_OT_delete_edgeloop,
550
551     WM_OT_context_set_boolean,
552     WM_OT_context_set_int,
553     WM_OT_context_scale_int,
554     WM_OT_context_set_float,
555     WM_OT_context_set_string,
556     WM_OT_context_set_enum,
557     WM_OT_context_set_value,
558     WM_OT_context_toggle,
559     WM_OT_context_toggle_enum,
560     WM_OT_context_cycle_enum,
561     WM_OT_context_cycle_int,
562     WM_OT_context_modal_mouse,
563
564     WM_OT_url_open,
565
566     WM_OT_doc_view,
567     WM_OT_doc_edit,
568
569     # experemental!
570     rna_prop_ui.WM_OT_properties_edit,
571     rna_prop_ui.WM_OT_properties_add,
572     rna_prop_ui.WM_OT_properties_remove]
573
574
575 def register():
576     register = bpy.types.register
577     for cls in classes:
578         register(cls)
579
580
581 def unregister():
582     unregister = bpy.types.unregister
583     for cls in classes:
584         unregister(cls)
585
586 if __name__ == "__main__":
587     register()