1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016
|
# SPDX-FileCopyrightText: 2009-2023 Blender Authors
#
# SPDX-License-Identifier: GPL-2.0-or-later
import bpy
from bpy.types import (
Menu,
Operator,
OperatorFileListElement,
Panel,
WindowManager,
)
from bpy.props import (
BoolProperty,
CollectionProperty,
StringProperty,
)
from bpy.app.translations import (
pgettext_rpt as rpt_,
pgettext_data as data_,
)
from bl_ui.utils import PresetPanel
# For preset popover menu
WindowManager.preset_name = StringProperty(
name="Preset Name",
description="Name for new preset",
default=data_("New Preset"),
)
# -----------------------------------------------------------------------------
# Private Implementation
def _call_preset_cb(fn, context, filepath, *, deprecated="4.2"):
# Allow "None" so the caller doesn't have to assign a variable and check it.
if fn is None:
return
if hasattr(fn, "__self__"):
args_offset = 1
else:
args_offset = 0
# Support a `filepath` argument, optional for backwards compatibility.
fn_arg_count = getattr(getattr(fn, "__code__", None), "co_argcount", None)
if fn_arg_count == 2 + args_offset:
args = (context, filepath)
else:
print("Deprecated since Blender {:s}, a filepath argument should be included in: {!r}".format(deprecated, fn))
args = (context, )
try:
fn(*args)
except Exception as ex:
print("Internal error running", fn, str(ex))
def _is_path_readonly(path):
from bpy.utils import (
is_path_builtin,
is_path_extension,
)
# Consider extension repository paths read-only because they should not be manipulated
# since the only way to restore the preset is to re-install the extension.
return is_path_builtin(path) or is_path_extension(path)
# -----------------------------------------------------------------------------
# Main Preset Implementation
class AddPresetBase:
"""Base preset class, only for subclassing
subclasses must define
- preset_values
- preset_subdir """
# bl_idname = "script.preset_base_add"
# bl_label = "Add a Python Preset"
# only because invoke_props_popup requires. Also do not add to search menu.
bl_options = {'REGISTER', 'INTERNAL'}
name: StringProperty(
name="Name",
description="Name of the preset, used to make the path name",
maxlen=64,
options={'SKIP_SAVE'},
)
remove_name: BoolProperty(
default=False,
options={'HIDDEN', 'SKIP_SAVE'},
)
remove_active: BoolProperty(
default=False,
options={'HIDDEN', 'SKIP_SAVE'},
)
@staticmethod
def as_filename(name): # could reuse for other presets
# lazy init maketrans
def maketrans_init():
cls = AddPresetBase
attr = "_as_filename_trans"
trans = getattr(cls, attr, None)
if trans is None:
trans = str.maketrans({char: "_" for char in " !@#$%^&*(){}:\";'[]<>,.\\/?"})
setattr(cls, attr, trans)
return trans
name = name.strip()
name = bpy.path.display_name_to_filepath(name)
trans = maketrans_init()
# Strip surrounding "_" as they are displayed as spaces.
return name.translate(trans).strip("_")
def execute(self, context):
import os
if hasattr(self, "pre_cb"):
self.pre_cb(context)
preset_menu_class = getattr(bpy.types, self.preset_menu)
is_xml = getattr(preset_menu_class, "preset_type", None) == 'XML'
is_preset_add = not (self.remove_name or self.remove_active)
if is_xml:
ext = ".xml"
else:
ext = ".py"
name = self.name.strip() if is_preset_add else self.name
if is_preset_add:
if not name:
return {'FINISHED'}
# Reset preset name
wm = bpy.data.window_managers[0]
if name == wm.preset_name:
wm.preset_name = data_("New Preset")
filename = self.as_filename(name)
target_path = os.path.join("presets", self.preset_subdir)
target_path = bpy.utils.user_resource('SCRIPTS', path=target_path, create=True)
if not target_path:
self.report({'WARNING'}, "Failed to create presets path")
return {'CANCELLED'}
filepath = os.path.join(target_path, filename) + ext
if hasattr(self, "add"):
self.add(context, filepath)
else:
print("Writing Preset: {!r}".format(filepath))
if is_xml:
import rna_xml
rna_xml.xml_file_write(context, filepath, preset_menu_class.preset_xml_map)
else:
def rna_recursive_attr_expand(value, rna_path_step, level):
if isinstance(value, bpy.types.PropertyGroup):
for sub_value_attr in value.bl_rna.properties.keys():
if sub_value_attr == "rna_type":
continue
sub_value = getattr(value, sub_value_attr)
rna_recursive_attr_expand(
sub_value,
"{:s}.{:s}".format(rna_path_step, sub_value_attr),
level,
)
elif type(value).__name__ == "bpy_prop_collection_idprop": # could use nicer method
file_preset.write("{:s}.clear()\n".format(rna_path_step))
for sub_value in value:
file_preset.write("item_sub_{:d} = {:s}.add()\n".format(level, rna_path_step))
rna_recursive_attr_expand(sub_value, "item_sub_{:d}".format(level), level + 1)
else:
# convert thin wrapped sequences
# to simple lists to repr()
try:
value = value[:]
except Exception:
pass
file_preset.write("{:s} = {!r}\n".format(rna_path_step, value))
file_preset = open(filepath, "w", encoding="utf-8")
file_preset.write("import bpy\n")
if hasattr(self, "preset_defines"):
for rna_path in self.preset_defines:
exec(rna_path)
file_preset.write("{:s}\n".format(rna_path))
file_preset.write("\n")
for rna_path in self.preset_values:
value = eval(rna_path)
rna_recursive_attr_expand(value, rna_path, 1)
file_preset.close()
preset_menu_class.bl_label = bpy.path.display_name(filename)
else:
if self.remove_active:
name = preset_menu_class.bl_label
# fairly sloppy but convenient.
filepath = bpy.utils.preset_find(name, self.preset_subdir, ext=ext)
if not filepath:
filepath = bpy.utils.preset_find(name, self.preset_subdir, display_name=True, ext=ext)
if not filepath:
return {'CANCELLED'}
# Do not remove bundled presets
if _is_path_readonly(filepath):
self.report({'WARNING'}, "Unable to remove default presets")
return {'CANCELLED'}
try:
if hasattr(self, "remove"):
self.remove(context, filepath)
else:
os.remove(filepath)
except Exception as ex:
self.report({'ERROR'}, rpt_("Unable to remove preset: {!r}").format(ex))
import traceback
traceback.print_exc()
return {'CANCELLED'}
# XXX, stupid!
preset_menu_class.bl_label = "Presets"
_call_preset_cb(getattr(self, "post_cb", None), context, filepath, deprecated="4.3")
return {'FINISHED'}
def check(self, _context):
self.name = self.as_filename(self.name.strip())
def invoke(self, context, _event):
if not (self.remove_active or self.remove_name):
wm = context.window_manager
return wm.invoke_props_dialog(self)
else:
return self.execute(context)
class ExecutePreset(Operator):
"""Load a preset"""
bl_idname = "script.execute_preset"
bl_label = "Execute a Python Preset"
filepath: StringProperty(
subtype='FILE_PATH',
options={'SKIP_SAVE'},
)
menu_idname: StringProperty(
name="Menu ID Name",
description="ID name of the menu this was called from",
options={'SKIP_SAVE'},
)
def execute(self, context):
from os.path import basename, splitext
filepath = self.filepath
# change the menu title to the most recently chosen option
preset_class = getattr(bpy.types, self.menu_idname)
preset_class.bl_label = bpy.path.display_name(basename(filepath), title_case=False)
ext = splitext(filepath)[1].lower()
if ext not in {".py", ".xml"}:
self.report({'ERROR'}, rpt_("Unknown file type: {!r}").format(ext))
return {'CANCELLED'}
_call_preset_cb(getattr(preset_class, "reset_cb", None), context, filepath)
if ext == ".py":
try:
bpy.utils.execfile(filepath)
except Exception as ex:
self.report({'ERROR'}, "Failed to execute the preset: " + repr(ex))
elif ext == ".xml":
import rna_xml
preset_xml_map = preset_class.preset_xml_map
preset_xml_secure_types = getattr(preset_class, "preset_xml_secure_types", None)
rna_xml.xml_file_run(context, filepath, preset_xml_map, secure_types=preset_xml_secure_types)
_call_preset_cb(getattr(preset_class, "post_cb", None), context, filepath)
return {'FINISHED'}
class AddPresetRender(AddPresetBase, Operator):
"""Add or remove a Render Preset"""
bl_idname = "render.preset_add"
bl_label = "Add Render Preset"
preset_menu = "RENDER_PT_format_presets"
preset_defines = [
"scene = bpy.context.scene"
]
preset_values = [
"scene.render.fps",
"scene.render.fps_base",
"scene.render.pixel_aspect_x",
"scene.render.pixel_aspect_y",
"scene.render.resolution_percentage",
"scene.render.resolution_x",
"scene.render.resolution_y",
]
preset_subdir = "render"
class AddPresetCamera(AddPresetBase, Operator):
"""Add or remove a Camera Preset"""
bl_idname = "camera.preset_add"
bl_label = "Add Camera Preset"
preset_menu = "CAMERA_PT_presets"
preset_defines = [
"cam = bpy.context.camera"
]
preset_subdir = "camera"
use_focal_length: BoolProperty(
name="Include Focal Length",
description="Include focal length into the preset",
options={'SKIP_SAVE'},
)
@property
def preset_values(self):
preset_values = [
"cam.sensor_width",
"cam.sensor_height",
"cam.sensor_fit",
]
if self.use_focal_length:
preset_values.append("cam.lens")
preset_values.append("cam.lens_unit")
return preset_values
class AddPresetCameraSafeAreas(AddPresetBase, Operator):
"""Add or remove a Safe Areas Preset"""
bl_idname = "camera.safe_areas_preset_add"
bl_label = "Add Safe Area Preset"
preset_menu = "CAMERA_PT_safe_areas_presets"
preset_defines = [
"safe_areas = bpy.context.scene.safe_areas"
]
preset_values = [
"safe_areas.title",
"safe_areas.action",
"safe_areas.title_center",
"safe_areas.action_center",
]
preset_subdir = "safe_areas"
class AddPresetCloth(AddPresetBase, Operator):
"""Add or remove a Cloth Preset"""
bl_idname = "cloth.preset_add"
bl_label = "Add Cloth Preset"
preset_menu = "CLOTH_PT_presets"
preset_defines = [
"cloth = bpy.context.cloth"
]
preset_values = [
"cloth.settings.quality",
"cloth.settings.mass",
"cloth.settings.air_damping",
"cloth.settings.bending_model",
"cloth.settings.tension_stiffness",
"cloth.settings.compression_stiffness",
"cloth.settings.shear_stiffness",
"cloth.settings.bending_stiffness",
"cloth.settings.tension_damping",
"cloth.settings.compression_damping",
"cloth.settings.shear_damping",
"cloth.settings.bending_damping",
]
preset_subdir = "cloth"
class AddPresetFluid(AddPresetBase, Operator):
"""Add or remove a Fluid Preset"""
bl_idname = "fluid.preset_add"
bl_label = "Add Fluid Preset"
preset_menu = "FLUID_PT_presets"
preset_defines = [
"fluid = bpy.context.fluid"
]
preset_values = [
"fluid.domain_settings.viscosity_base",
"fluid.domain_settings.viscosity_exponent",
]
preset_subdir = "fluid"
class AddPresetHairDynamics(AddPresetBase, Operator):
"""Add or remove a Hair Dynamics Preset"""
bl_idname = "particle.hair_dynamics_preset_add"
bl_label = "Add Hair Dynamics Preset"
preset_menu = "PARTICLE_PT_hair_dynamics_presets"
preset_defines = [
"psys = bpy.context.particle_system",
"cloth = bpy.context.particle_system.cloth",
"settings = bpy.context.particle_system.cloth.settings",
"collision = bpy.context.particle_system.cloth.collision_settings",
]
preset_subdir = "hair_dynamics"
preset_values = [
"settings.quality",
"settings.mass",
"settings.bending_stiffness",
"psys.settings.bending_random",
"settings.bending_damping",
"settings.air_damping",
"settings.internal_friction",
"settings.density_target",
"settings.density_strength",
"settings.voxel_cell_size",
"settings.pin_stiffness",
]
class AddPresetTextEditor(AddPresetBase, Operator):
"""Add or remove a Text Editor Preset"""
bl_idname = "text_editor.preset_add"
bl_label = "Add Text Editor Preset"
preset_menu = "USERPREF_PT_text_editor_presets"
preset_defines = [
"filepaths = bpy.context.preferences.filepaths"
]
preset_values = [
"filepaths.text_editor",
"filepaths.text_editor_args",
]
preset_subdir = "text_editor"
class AddPresetTrackingCamera(AddPresetBase, Operator):
"""Add or remove a Tracking Camera Intrinsics Preset"""
bl_idname = "clip.camera_preset_add"
bl_label = "Add Camera Preset"
preset_menu = "CLIP_PT_camera_presets"
preset_defines = [
"camera = bpy.context.edit_movieclip.tracking.camera"
]
preset_subdir = "tracking_camera"
use_focal_length: BoolProperty(
name="Include Focal Length",
description="Include focal length into the preset",
options={'SKIP_SAVE'},
default=True,
)
@property
def preset_values(self):
preset_values = [
"camera.sensor_width",
"camera.pixel_aspect",
"camera.k1",
"camera.k2",
"camera.k3",
]
if self.use_focal_length:
preset_values.append("camera.units")
preset_values.append("camera.focal_length")
return preset_values
class AddPresetTrackingTrackColor(AddPresetBase, Operator):
"""Add or remove a Clip Track Color Preset"""
bl_idname = "clip.track_color_preset_add"
bl_label = "Add Track Color Preset"
preset_menu = "CLIP_PT_track_color_presets"
preset_defines = [
"track = bpy.context.edit_movieclip.tracking.tracks.active"
]
preset_values = [
"track.color",
"track.use_custom_color",
]
preset_subdir = "tracking_track_color"
class AddPresetTrackingSettings(AddPresetBase, Operator):
"""Add or remove a motion tracking settings preset"""
bl_idname = "clip.tracking_settings_preset_add"
bl_label = "Add Tracking Settings Preset"
preset_menu = "CLIP_PT_tracking_settings_presets"
preset_defines = [
"settings = bpy.context.edit_movieclip.tracking.settings"
]
preset_values = [
"settings.default_correlation_min",
"settings.default_pattern_size",
"settings.default_search_size",
"settings.default_frames_limit",
"settings.default_pattern_match",
"settings.default_margin",
"settings.default_motion_model",
"settings.use_default_brute",
"settings.use_default_normalization",
"settings.use_default_mask",
"settings.use_default_red_channel",
"settings.use_default_green_channel",
"settings.use_default_blue_channel",
"settings.default_weight",
]
preset_subdir = "tracking_settings"
class AddPresetEEVEERaytracing(AddPresetBase, Operator):
"""Add or remove an EEVEE ray-tracing preset"""
bl_idname = "render.eevee_raytracing_preset_add"
bl_label = "Add Raytracing Preset"
preset_menu = "RENDER_PT_eevee_next_raytracing_presets"
preset_defines = [
"eevee = bpy.context.scene.eevee",
"options = eevee.ray_tracing_options",
]
preset_values = [
"eevee.ray_tracing_method",
"options.resolution_scale",
"options.trace_max_roughness",
"options.screen_trace_quality",
"options.screen_trace_thickness",
"options.use_denoise",
"options.denoise_spatial",
"options.denoise_temporal",
"options.denoise_bilateral",
"eevee.fast_gi_method",
"eevee.fast_gi_resolution",
"eevee.fast_gi_ray_count",
"eevee.fast_gi_step_count",
"eevee.fast_gi_quality",
"eevee.fast_gi_distance",
"eevee.fast_gi_thickness_near",
"eevee.fast_gi_thickness_far",
"eevee.fast_gi_bias",
]
preset_subdir = "eevee/raytracing"
class AddPresetColorManagementWhiteBalance(AddPresetBase, Operator):
"""Add or remove a white balance preset"""
bl_idname = "render.color_management_white_balance_preset_add"
bl_label = "Add White Balance Preset"
preset_menu = "RENDER_PT_color_management_white_balance_presets"
preset_defines = [
"view_settings = bpy.context.scene.view_settings",
]
preset_values = [
"view_settings.white_balance_temperature",
"view_settings.white_balance_tint",
]
preset_subdir = "color_management/white_balance"
class AddPresetNodeColor(AddPresetBase, Operator):
"""Add or remove a Node Color Preset"""
bl_idname = "node.node_color_preset_add"
bl_label = "Add Node Color Preset"
preset_menu = "NODE_PT_node_color_presets"
preset_defines = [
"node = bpy.context.active_node"
]
preset_values = [
"node.color",
"node.use_custom_color",
]
preset_subdir = "node_color"
class AddPresetInterfaceTheme(AddPresetBase, Operator):
"""Add a custom theme to the preset list"""
bl_idname = "wm.interface_theme_preset_add"
bl_label = "Add Theme"
preset_menu = "USERPREF_MT_interface_theme_presets"
preset_subdir = "interface_theme"
def post_cb(self, context, filepath):
# Ensure the saved preset is considered "active" after saving.
# Typically handled by the classes `bl_label` however themes use the `filepath` instead.
context.preferences.themes[0].filepath = filepath
class RemovePresetInterfaceTheme(AddPresetBase, Operator):
"""Remove a custom theme from the preset list"""
bl_idname = "wm.interface_theme_preset_remove"
bl_label = "Remove Theme"
preset_menu = "USERPREF_MT_interface_theme_presets"
preset_subdir = "interface_theme"
remove_active: BoolProperty(
default=True,
options={'HIDDEN', 'SKIP_SAVE'},
)
# NOTE: leave poll unset as file-system scanning should be avoided
# while redrawing as it may involve remote file-system access.
def invoke(self, context, event):
filepath = context.preferences.themes[0].filepath
if (not filepath) or _is_path_readonly(filepath):
self.report({'ERROR'}, "Built-in themes cannot be removed")
return {'CANCELLED'}
return context.window_manager.invoke_confirm(self, event, title="Remove Custom Theme", confirm_text="Delete")
def post_cb(self, context, _filepath):
# Without this, the name & colors are kept after removing the theme.
# Even though the theme is removed from the list, it's seems like a bug to keep it displayed after removal.
bpy.ops.preferences.reset_default_theme()
class SavePresetInterfaceTheme(AddPresetBase, Operator):
"""Save a custom theme in the preset list"""
bl_idname = "wm.interface_theme_preset_save"
bl_label = "Save Theme"
preset_menu = "USERPREF_MT_interface_theme_presets"
preset_subdir = "interface_theme"
remove_active: BoolProperty(
default=True,
options={'HIDDEN', 'SKIP_SAVE'},
)
# NOTE: leave poll unset as file-system scanning should be avoided
# while redrawing as it may involve remote file-system access.
def execute(self, context):
import rna_xml
filepath = context.preferences.themes[0].filepath
if (not filepath) or _is_path_readonly(filepath):
self.report({'ERROR'}, "Built-in themes cannot be overwritten")
return {'CANCELLED'}
preset_menu_class = getattr(bpy.types, self.preset_menu)
try:
rna_xml.xml_file_write(context, filepath, preset_menu_class.preset_xml_map)
except Exception as ex:
self.report({'ERROR'}, "Unable to overwrite preset: {:s}".format(str(ex)))
import traceback
traceback.print_exc()
return {'CANCELLED'}
context.preferences.themes[0].filepath = filepath
return {'FINISHED'}
def invoke(self, context, event):
filepath = context.preferences.themes[0].filepath
if (not filepath) or _is_path_readonly(filepath):
self.report({'ERROR'}, "Built-in themes cannot be overwritten")
return {'CANCELLED'}
return context.window_manager.invoke_confirm(self, event, title="Overwrite Custom Theme?", confirm_text="Save")
class AddPresetKeyconfig(AddPresetBase, Operator):
"""Add a custom keymap configuration to the preset list"""
bl_idname = "wm.keyconfig_preset_add"
bl_label = "Add Custom Keymap Configuration"
preset_menu = "USERPREF_MT_keyconfigs"
preset_subdir = "keyconfig"
def add(self, _context, filepath):
bpy.ops.preferences.keyconfig_export(filepath=filepath)
bpy.utils.keyconfig_set(filepath)
class RemovePresetKeyconfig(AddPresetBase, Operator):
"""Remove a custom keymap configuration from the preset list"""
bl_idname = "wm.keyconfig_preset_remove"
bl_label = "Remove Keymap Configuration"
preset_menu = "USERPREF_MT_keyconfigs"
preset_subdir = "keyconfig"
remove_active: BoolProperty(
default=True,
options={'HIDDEN', 'SKIP_SAVE'},
)
# NOTE: leave poll unset as file-system scanning should be avoided
# while redrawing as it may involve remote file-system access.
def pre_cb(self, context):
keyconfigs = bpy.context.window_manager.keyconfigs
preset_menu_class = getattr(bpy.types, self.preset_menu)
preset_menu_class.bl_label = keyconfigs.active.name
def post_cb(self, context, _filepath):
keyconfigs = bpy.context.window_manager.keyconfigs
keyconfigs.remove(keyconfigs.active)
def invoke(self, context, event):
keyconfigs = bpy.context.window_manager.keyconfigs
name = keyconfigs.active.name
filepath = bpy.utils.preset_find(name, self.preset_subdir, ext=".py")
if (not filepath) or _is_path_readonly(filepath):
self.report({'ERROR'}, "Built-in keymap configurations cannot be removed")
return {'CANCELLED'}
return context.window_manager.invoke_confirm(
self, event, title="Remove Keymap Configuration", confirm_text="Delete")
class AddPresetOperator(AddPresetBase, Operator):
"""Add or remove an Operator Preset"""
bl_idname = "wm.operator_preset_add"
bl_label = "Operator Preset"
preset_menu = "WM_MT_operator_presets"
operator: StringProperty(
name="Operator",
maxlen=64,
options={'HIDDEN', 'SKIP_SAVE'},
)
preset_defines = [
"op = bpy.context.active_operator",
]
@property
def preset_subdir(self):
return AddPresetOperator.operator_path(self.operator)
@property
def preset_values(self):
properties_blacklist = Operator.bl_rna.properties.keys()
prefix, suffix = self.operator.split("_OT_", 1)
op = getattr(getattr(bpy.ops, prefix.lower()), suffix)
operator_rna = op.get_rna_type()
del op
ret = []
for prop_id, prop in operator_rna.properties.items():
if not prop.is_skip_preset:
if prop_id not in properties_blacklist:
ret.append("op.{:s}".format(prop_id))
return ret
@staticmethod
def operator_path(operator):
import os
prefix, suffix = operator.split("_OT_", 1)
return os.path.join("operator", "{:s}.{:s}".format(prefix.lower(), suffix))
class WM_MT_operator_presets(Menu):
bl_label = "Operator Presets"
def draw(self, context):
self.operator = context.active_operator.bl_idname
# dummy 'default' menu item
layout = self.layout
layout.operator("wm.operator_defaults")
layout.separator()
Menu.draw_preset(self, context)
@property
def preset_subdir(self):
return AddPresetOperator.operator_path(self.operator)
preset_operator = "script.execute_preset"
class WM_PT_operator_presets(PresetPanel, Panel):
bl_label = "Operator Presets"
preset_add_operator = "wm.operator_preset_add"
preset_operator = "script.execute_preset"
@property
def preset_subdir(self):
return AddPresetOperator.operator_path(self.operator)
@property
def preset_add_operator_properties(self):
return {"operator": self.operator}
def draw(self, context):
self.operator = context.active_operator.bl_idname
PresetPanel.draw(self, context)
class WM_OT_operator_presets_cleanup(Operator):
"""Remove outdated operator properties from presets that may cause problems"""
bl_idname = "wm.operator_presets_cleanup"
bl_label = "Clean Up Operator Presets"
operator: StringProperty(name="operator")
properties: CollectionProperty(name="properties", type=OperatorFileListElement)
def _cleanup_preset(self, filepath, properties_exclude):
import os
import re
if not (os.path.isfile(filepath) and os.path.splitext(filepath)[1].lower() == ".py"):
return
with open(filepath, "r", encoding="utf-8") as fh:
lines = fh.read().splitlines(True)
if not lines:
return
regex_exclude = re.compile("(" + "|".join([re.escape("op." + prop) for prop in properties_exclude]) + ")\\b")
lines = [line for line in lines if not regex_exclude.match(line)]
with open(filepath, "w", encoding="utf-8") as fh:
fh.write("".join(lines))
def _cleanup_operators_presets(self, operators, properties_exclude):
import os
base_preset_directory = bpy.utils.user_resource('SCRIPTS', path="presets", create=False)
if not base_preset_directory:
return
for operator in operators:
operator_path = AddPresetOperator.operator_path(operator)
directory = os.path.join(base_preset_directory, operator_path)
if not os.path.isdir(directory):
continue
for filename in os.listdir(directory):
self._cleanup_preset(os.path.join(directory, filename), properties_exclude)
def execute(self, context):
properties_exclude = []
operators = []
if self.operator:
operators.append(self.operator)
for prop in self.properties:
properties_exclude.append(prop.name)
else:
# Cleanup by default I/O Operators Presets
operators = [
"WM_OT_alembic_export",
"WM_OT_alembic_import",
"WM_OT_collada_export",
"WM_OT_collada_import",
"WM_OT_gpencil_export_svg",
"WM_OT_gpencil_export_pdf",
"WM_OT_gpencil_import_svg",
"WM_OT_obj_export",
"WM_OT_obj_import",
"WM_OT_ply_export",
"WM_OT_ply_import",
"WM_OT_stl_export",
"WM_OT_stl_import",
"WM_OT_usd_export",
"WM_OT_usd_import",
]
properties_exclude = [
"filepath",
"directory",
"files",
"filename",
]
self._cleanup_operators_presets(operators, properties_exclude)
return {'FINISHED'}
class AddPresetGpencilBrush(AddPresetBase, Operator):
"""Add or remove grease pencil brush preset"""
bl_idname = "scene.gpencil_brush_preset_add"
bl_label = "Add Grease Pencil Brush Preset"
preset_menu = "VIEW3D_PT_gpencil_brush_presets"
preset_defines = [
"brush = bpy.context.tool_settings.gpencil_paint.brush",
"settings = brush.gpencil_settings",
]
preset_values = [
"settings.input_samples",
"settings.active_smooth_factor",
"settings.angle",
"settings.angle_factor",
"settings.use_settings_stabilizer",
"brush.smooth_stroke_radius",
"brush.smooth_stroke_factor",
"settings.pen_smooth_factor",
"settings.pen_smooth_steps",
"settings.pen_subdivision_steps",
"settings.use_settings_random",
"settings.random_pressure",
"settings.random_strength",
"settings.uv_random",
"settings.pen_jitter",
"settings.use_jitter_pressure",
"settings.use_trim",
]
preset_subdir = "gpencil_brush"
class AddPresetGpencilMaterial(AddPresetBase, Operator):
"""Add or remove grease pencil material preset"""
bl_idname = "scene.gpencil_material_preset_add"
bl_label = "Add Grease Pencil Material Preset"
preset_menu = "MATERIAL_PT_gpencil_material_presets"
preset_defines = [
"material = bpy.context.object.active_material",
"gpcolor = material.grease_pencil",
]
preset_values = [
"gpcolor.mode",
"gpcolor.stroke_style",
"gpcolor.color",
"gpcolor.stroke_image",
"gpcolor.pixel_size",
"gpcolor.mix_stroke_factor",
"gpcolor.alignment_mode",
"gpcolor.alignment_rotation",
"gpcolor.fill_style",
"gpcolor.fill_color",
"gpcolor.fill_image",
"gpcolor.gradient_type",
"gpcolor.mix_color",
"gpcolor.mix_factor",
"gpcolor.flip",
"gpcolor.texture_offset",
"gpcolor.texture_scale",
"gpcolor.texture_angle",
"gpcolor.texture_clamp",
"gpcolor.mix_factor",
"gpcolor.show_stroke",
"gpcolor.show_fill",
]
preset_subdir = "gpencil_material"
classes = (
AddPresetCamera,
AddPresetCloth,
AddPresetFluid,
AddPresetHairDynamics,
AddPresetInterfaceTheme,
RemovePresetInterfaceTheme,
SavePresetInterfaceTheme,
AddPresetKeyconfig,
RemovePresetKeyconfig,
AddPresetNodeColor,
AddPresetOperator,
AddPresetRender,
AddPresetCameraSafeAreas,
AddPresetTextEditor,
AddPresetTrackingCamera,
AddPresetTrackingSettings,
AddPresetTrackingTrackColor,
AddPresetGpencilBrush,
AddPresetGpencilMaterial,
AddPresetEEVEERaytracing,
AddPresetColorManagementWhiteBalance,
ExecutePreset,
WM_MT_operator_presets,
WM_PT_operator_presets,
WM_OT_operator_presets_cleanup,
)
|