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