c03d5850237c9fc490ed861a0778fc9a763b590b
[blender-staging.git] / release / scripts / templates / operator.py
1 import bpy
2
3 def write_some_data(context, path, use_some_setting):
4         pass
5
6 from bpy.props import *
7
8 class ExportSomeData(bpy.types.Operator):
9         '''This appiers in the tooltip of the operator and in the generated docs.'''
10         bl_idname = "export.some_data" # this is important since its how bpy.ops.export.some_data is constructed
11         bl_label = "Export Some Data"
12         
13         # List of operator properties, the attributes will be assigned
14         # to the class instance from the operator settings before calling.
15         
16         # TODO, add better example props
17         path = StringProperty(name="File Path", description="File path used for exporting the PLY file", maxlen= 1024, default= "")
18         use_some_setting = BoolProperty(name="Apply Modifiers", description="Apply Modifiers to the exported mesh", default= True)
19         
20         def poll(self, context):
21                 return context.active_object != None
22         
23         def execute(self, context):
24                 if not self.is_property_set("path"):
25                         raise Exception("filename not set")
26                 
27                 write(self.path, context, use_setting, SOME_SETTING = self.use_some_setting)
28
29                 return ('FINISHED',)
30         
31         def invoke(self, context, event):
32                 wm = context.manager
33                 
34                 if True:
35                         # File selector
36                         wm.add_fileselect(self.__operator__) # will run self.execute()
37                         return ('RUNNING_MODAL',)
38                 else if 0:
39                         # Redo popup
40                         wm.invoke_props_popup(self.__operator__, event) # 
41                         return ('RUNNING_MODAL',)
42                 else if 0:
43                         return self.execute(context)
44
45
46 bpy.ops.add(ExportSomeData)
47
48 # Only needed if you want to add into a dynamic menu
49 import dynamic_menu
50 menu_func = lambda self, context: self.layout.itemO("export.some_data", text="Example Exporter...")
51 menu_item = dynamic_menu.add(bpy.types.INFO_MT_file_export, menu_func)
52
53 # Use for running this script directly
54 if __name__ == "__main__":
55         bpy.ops.export.some_data(path="/tmp/test.ply")