blender/scripts/templates_py/operator_file_import.py

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

80 lines
2.3 KiB
Python
Raw Permalink Normal View History

import bpy
2012-04-17 05:47:32 +00:00
def read_some_data(context, filepath, use_some_setting):
print("running read_some_data...")
f = open(filepath, 'r', encoding='utf-8')
data = f.read()
f.close()
2012-04-17 10:25:23 +00:00
# would normally load the data here
2012-04-17 05:47:32 +00:00
print(data)
return {'FINISHED'}
2012-04-17 05:47:32 +00:00
# ImportHelper is a helper class, defines filename and
# invoke() function which calls the file selector.
2012-04-17 05:47:32 +00:00
from bpy_extras.io_utils import ImportHelper
from bpy.props import StringProperty, BoolProperty, EnumProperty
2012-04-17 05:47:32 +00:00
from bpy.types import Operator
2012-04-17 05:47:32 +00:00
class ImportSomeData(Operator, ImportHelper):
"""This appears in the tooltip of the operator and in the generated docs"""
2012-04-17 05:47:32 +00:00
bl_idname = "import_test.some_data" # important since its how bpy.ops.import_test.some_data is constructed
bl_label = "Import Some Data"
2023-09-05 00:49:20 +00:00
# ImportHelper mix-in class uses this.
filename_ext = ".txt"
filter_glob: StringProperty(
2018-06-26 17:41:37 +00:00
default="*.txt",
options={'HIDDEN'},
maxlen=255, # Max internal buffer length, longer would be clamped.
)
# List of operator properties, the attributes will be assigned
# to the class instance from the operator settings before calling.
use_setting: BoolProperty(
2018-06-26 17:41:37 +00:00
name="Example Boolean",
description="Example Tooltip",
default=True,
)
type: EnumProperty(
2018-06-26 17:41:37 +00:00
name="Example Enum",
description="Choose between two items",
items=(
('OPT_A', "First Option", "Description one"),
('OPT_B', "Second Option", "Description two"),
),
default='OPT_A',
)
def execute(self, context):
2012-04-17 05:47:32 +00:00
return read_some_data(context, self.filepath, self.use_setting)
# Only needed if you want to add into a dynamic menu.
2012-04-17 05:47:32 +00:00
def menu_func_import(self, context):
self.layout.operator(ImportSomeData.bl_idname, text="Text Import Operator")
# Register and add to the "file selector" menu (required to use F3 search "Text Import Operator" for quick access).
def register():
2012-04-17 05:47:32 +00:00
bpy.utils.register_class(ImportSomeData)
bpy.types.TOPBAR_MT_file_import.append(menu_func_import)
def unregister():
2012-04-17 05:47:32 +00:00
bpy.utils.unregister_class(ImportSomeData)
bpy.types.TOPBAR_MT_file_import.remove(menu_func_import)
if __name__ == "__main__":
register()
# test call
2012-04-17 05:47:32 +00:00
bpy.ops.import_test.some_data('INVOKE_DEFAULT')