[Bf-blender-cvs] [95046526875] blender2.8: UI: move tool definitions to classes
Campbell Barton
noreply at git.blender.org
Fri Apr 27 13:57:01 CEST 2018
Commit: 9504652687529ebcdc47aa08314560de1e1473de
Author: Campbell Barton
Date: Fri Apr 27 13:23:29 2018 +0200
Branches: blender2.8
https://developer.blender.org/rB9504652687529ebcdc47aa08314560de1e1473de
UI: move tool definitions to classes
Originally it was nice to have a small list of definitions
with tools inline.
However we need to be able to define drawing functions for tools
which Python can't easily inline.
Use function for keymap definition,
support creating a function from a tuple as well
(handy for simple key-maps).
===================================================================
M release/scripts/startup/bl_ui/space_toolsystem_common.py
M release/scripts/startup/bl_ui/space_toolsystem_toolbar.py
===================================================================
diff --git a/release/scripts/startup/bl_ui/space_toolsystem_common.py b/release/scripts/startup/bl_ui/space_toolsystem_common.py
index c2ac5d7124f..094bc56cf9a 100644
--- a/release/scripts/startup/bl_ui/space_toolsystem_common.py
+++ b/release/scripts/startup/bl_ui/space_toolsystem_common.py
@@ -24,6 +24,7 @@ from bpy.types import (
__all__ = (
"ToolSelectPanelHelper",
+ "ToolDef",
)
# Support reloading icons.
@@ -37,6 +38,59 @@ if "_icon_cache" in locals():
# (filename -> icon_value) map
_icon_cache = {}
+def _keymap_fn_from_seq(keymap_data):
+
+ # standalone
+ def _props_assign_recursive(rna_props, py_props):
+ for prop_id, value in py_props.items():
+ if isinstance(value, dict):
+ _props_assign_recursive(getattr(rna_props, prop_id), value)
+ else:
+ setattr(rna_props, prop_id, value)
+
+ def keymap_fn(km):
+ for op_idname, op_props_dict, kmi_kwargs in keymap_fn.keymap_data:
+ kmi = km.keymap_items.new(op_idname, **kmi_kwargs)
+ kmi_props = kmi.properties
+ if op_props_dict:
+ _props_assign_recursive(kmi.properties, op_props_dict)
+ keymap_fn.keymap_data = keymap_data
+ return keymap_fn
+
+
+class ToolDef:
+ """
+ Tool definition,
+ This class is never instanced, it's used as definition for tool types.
+
+ Since we want to define functions here, it's more convenient to declare class-methods
+ then functions in a dict or tuple.
+ """
+ __slots__ = ()
+
+ def __new__(cls, *args, **kwargs):
+ raise RuntimeError("%s should not be instantiated" % cls)
+
+ def __init_subclass__(cls):
+ # All classes must have a name
+ assert(cls.text is not None)
+ # We must have a key-map or widget (otherwise the tool does nothing!)
+ assert(cls.keymap is not None or cls.widget is not None)
+
+ if type(cls.keymap) is tuple:
+ cls.keymap = _keymap_fn_from_seq(cls.keymap)
+
+
+ # The name to display in the interface.
+ text = None
+ # The name of the icon to use (found in ``release/datafiles/icons``) or None for no icon.
+ icon = None
+ # An optional manipulator group to activate when the tool is set or None for no widget.
+ widget = None
+ # An optional triple of: ``(operator_id, operator_properties, keymap_item_args)``.
+ keymap = None
+
+
class ToolSelectPanelHelper:
"""
Generic Class, can be used for any toolbar.
@@ -48,19 +102,7 @@ class ToolSelectPanelHelper:
- tools_from_context(context):
Returns tools available in this context.
- Each tool is a dict:
- ``(text=tool_name, icon=icon_name, widget=manipulator_group_idname, keymap=keymap_actions)``
- For a separator in the toolbar, use ``None``.
-
- Where:
- ``tool_name``
- is the name to display in the interface.
- ``icon_name``
- is the name of the icon to use (found in ``release/datafiles/icons``).
- ``manipulator_group_idname``
- is an optional manipulator group to activate when the tool is set.
- ``keymap_actions``
- an optional triple of: ``(operator_id, operator_properties, keymap_item_args)``
+ Each tool is a 'ToolDef' or None for a separator in the toolbar, use ``None``.
"""
@staticmethod
@@ -88,15 +130,11 @@ class ToolSelectPanelHelper:
else:
return 0
- @staticmethod
- def _tool_is_group(tool):
- return type(tool) is not dict
-
@staticmethod
def _tools_flatten(tools):
for item in tools:
if item is not None:
- if ToolSelectPanelHelper._tool_is_group(item):
+ if type(item) is tuple:
for sub_item in item:
if sub_item is not None:
yield sub_item
@@ -107,12 +145,11 @@ class ToolSelectPanelHelper:
def _tool_vars_from_def(cls, item, context_mode):
# For now be strict about whats in this dict
# prevent accidental adding unknown keys.
- assert(len(item) == 4)
- text = item["text"]
- icon_name = item["icon"]
- mp_idname = item["widget"]
- actions = item["keymap"]
- if actions is None:
+ text = item.text
+ icon_name = item.icon
+ mp_idname = item.widget
+ keymap_fn = item.keymap
+ if keymap_fn is None:
km, km_idname = (None, None)
else:
km_test = cls._tool_keymap.get((context_mode, text))
@@ -138,15 +175,7 @@ class ToolSelectPanelHelper:
)
@classmethod
- def _km_action_simple(cls, kc, context_mode, text, actions):
-
- # standalone
- def props_assign_recursive(rna_props, py_props):
- for prop_id, value in py_props.items():
- if isinstance(value, dict):
- props_assign_recursive(getattr(rna_props, prop_id), value)
- else:
- setattr(rna_props, prop_id, value)
+ def _km_action_simple(cls, kc, context_mode, text, keymap_fn):
if context_mode is None:
context_mode = "All"
@@ -155,11 +184,7 @@ class ToolSelectPanelHelper:
if km is not None:
return km, km_idname
km = kc.keymaps.new(km_idname, space_type=cls.bl_space_type, region_type='WINDOW')
- for op_idname, op_props_dict, kmi_kwargs in actions:
- kmi = km.keymap_items.new(op_idname, **kmi_kwargs)
- kmi_props = kmi.properties
- if op_props_dict:
- props_assign_recursive(kmi.properties, op_props_dict)
+ keymap_fn(km)
return km, km_idname
@classmethod
@@ -189,14 +214,14 @@ class ToolSelectPanelHelper:
for item_parent in tools:
if item_parent is None:
continue
- for item in item_parent if (cls._tool_is_group(item_parent)) else (item_parent,):
+ for item in item_parent if (type(item_parent) is tuple) else (item_parent,):
if item is None:
continue
- actions = item["keymap"]
- if actions is not None:
- text = item["text"]
- icon_name = item["icon"]
- km, km_idname = cls._km_action_simple(kc, context_mode, text, actions)
+ keymap_data = item.keymap
+ if keymap_data is not None:
+ text = item.text
+ icon_name = item.icon
+ km, km_idname = cls._km_action_simple(kc, context_mode, text, keymap_data)
cls._tool_keymap[context_mode, text] = km, km_idname
def draw(self, context):
@@ -231,7 +256,7 @@ class ToolSelectPanelHelper:
col.scale_y = scale_y
continue
- if self._tool_is_group(item):
+ if type(item) is tuple:
is_active = False
i = 0
for i, sub_item in enumerate(item):
@@ -246,9 +271,9 @@ class ToolSelectPanelHelper:
if is_active:
# not ideal, write this every time :S
- self._tool_group_active[item[0]["text"]] = index
+ self._tool_group_active[item[0].text] = index
else:
- index = self._tool_group_active.get(item[0]["text"], 0)
+ index = self._tool_group_active.get(item[0].text, 0)
item = item[index]
use_menu = True
@@ -262,7 +287,7 @@ class ToolSelectPanelHelper:
if use_menu:
props = col.operator_menu_hold(
"wm.tool_set",
- text=item["text"] if show_text else "",
+ text=item.text if show_text else "",
depress=is_active,
menu="WM_MT_toolsystem_submenu",
icon_value=icon_value,
@@ -270,7 +295,7 @@ class ToolSelectPanelHelper:
else:
props = col.operator(
"wm.tool_set",
- text=item["text"] if show_text else "",
+ text=item.text if show_text else "",
depress=is_active,
icon_value=icon_value,
)
@@ -282,7 +307,6 @@ class ToolSelectPanelHelper:
def tools_from_context(cls, context):
return (cls._tools[None], cls._tools.get(context.mode, ()))
-
@staticmethod
def _active_tool(context, with_icon=False):
"""
@@ -318,7 +342,7 @@ class ToolSelectPanelHelper:
layout.label("No Tool Found")
return
# Indent until we have better icon scaling.
- layout.label(" " + item["text"], icon_value=icon_value)
+ layout.label(" " + item.text, icon_value=icon_value)
# The purpose of this menu is to be a generic popup to select between tools
@@ -341,7 +365,7 @@ class WM_MT_toolsystem_submenu(Menu):
for item_items in cls.tools_from_context(context):
for item_group in item_items:
- if (item_group is not None) and ToolSelectPanelHelper._tool_is_group(item_group):
+ if type(item_group) is tuple:
if index_button < len(item_group):
item = item_group[index_button]
tool_def, icon_name = cls._tool_vars_from_def(item, context_mode)
@@ -370,7 +394,7 @@ class WM_MT_toolsystem_submenu(Menu):
icon_value = ToolSelectPanelHelper._icon_value_from_icon_handle(icon_name)
props = layout.operator(
"wm.tool_set",
- text=item["text"],
+ text=item.text,
icon_value=icon_value,
)
props.keymap = tool_d
@@ Diff output truncated at 10240 characters. @@
More information about the Bf-blender-cvs
mailing list