Layout Panels support in popups #121674

New Issue

Guillermo Venegas · 2024-05-10T22:44:30+02:00

Guillermo Venegas commented

2024-05-10 22:44:30 +02:00

This is to document the support and some limitations of using Layout Panels in
popups, and to refer to possible future reports:

In 4.2 is being added the support of Layout Panels to popups, this allows to have more dynamic popups
with collapsible sections.

Since these popups are now more dynamic, popup layout needs to be rebuilt if a panel is open/closed
and not all popups support this kind of refreshing, listed below are the popups that support layout
panels and those that don't:

Popups that support layout panels:

UILayout.popover
WindowManager.invoke_props_popup
WindowManager.invoke_props_dialog
WindowManager.invoke_popup
Redo Popover
bpy.ops.wm.call_panel with keep_open=True

Popups that don't support layout panels:

While trying to use layout panels in these popups would normally just fail to add them, if a custom
these popups tries to use a internal implementation that skips some checks, blender will crash

For example, extending the script in the report #121458, this can crash

import bpy

tree = bpy.data.node_groups["Geometry Nodes"]


def draw(self, context):
    self.layout.label(text="--- Hi ---------")
    tree.nodes.active.draw_buttons_ext(context, self.layout)
    
class Op(bpy.types.Operator):
    bl_idname = "aa.op"
    bl_label = "Operator"
    def execute(self, context):
        return {'FINISHED'}
    def invoke(self, context, event):
		# Any of the following alternatives would crash
#        context.window_manager.popup_menu(draw)
#        context.window_manager.popup_menu_pie(draw_func=draw, event=event)
        context.window_manager.popover(draw)
        return {'RUNNING_MODAL'} 

bpy.utils.register_class(Op)

kmANe = bpy.context.window_manager.keyconfigs.addon.keymaps.new(name="Node Editor", space_type='NODE_EDITOR')
kmANe.keymap_items.new(idname=Op.bl_idname, type='D', value='PRESS')

This is to document the support and some limitations of using `Layout Panels` in popups, and to refer to possible future reports: --- In 4.2 is being added the support of `Layout Panels` to popups, this allows to have more dynamic popups with collapsible sections. Since these popups are now more dynamic, popup layout needs to be rebuilt if a panel is open/closed and not all popups support this kind of refreshing, listed below are the popups that support layout panels and those that don't: **Popups that support layout panels:** * [`UILayout.popover`](https://docs.blender.org/api/current/bpy.types.UILayout.html#bpy.types.UILayout.popover) * [`WindowManager.invoke_props_popup`](https://docs.blender.org/api/current/bpy.types.WindowManager.html#bpy.types.WindowManager.invoke_props_popup) * [`WindowManager.invoke_props_dialog`](https://docs.blender.org/api/current/bpy.types.WindowManager.html#bpy.types.WindowManager.invoke_props_dialog) * [`WindowManager.invoke_popup`](https://docs.blender.org/api/current/bpy.types.WindowManager.html#bpy.types.WindowManager.invoke_popup) * `Redo Popover` * [`bpy.ops.wm.call_panel`](https://docs.blender.org/api/current/bpy.ops.wm.html#bpy.ops.wm.call_panel) with `keep_open=True` **Popups that don't support layout panels:** * [`WindowManager.popover`](https://docs.blender.org/api/current/bpy.types.WindowManager.html#bpy.types.WindowManager.popover) * [`WindowManager.popover_begin__internal`](https://docs.blender.org/api/current/bpy.types.WindowManager.html#bpy.types.WindowManager.popover_begin__internal) * [`WindowManager.popup_menu`](https://docs.blender.org/api/current/bpy.types.WindowManager.html#bpy.types.WindowManager.popup_menu) * [`WindowManager.popmenu_begin__internal`](https://docs.blender.org/api/current/bpy.types.WindowManager.html#bpy.types.WindowManager.popmenu_begin__internal) * [`WindowManager.popup_menu_pie`](https://docs.blender.org/api/current/bpy.types.WindowManager.html#bpy.types.WindowManager.popup_menu_pie) * [`WindowManager.piemenu_begin__internal`](https://docs.blender.org/api/current/bpy.types.WindowManager.html#bpy.types.WindowManager.piemenu_begin__internal) * [`bpy.ops.wm.call_panel`](https://docs.blender.org/api/current/bpy.ops.wm.html#bpy.ops.wm.call_panel) with `keep_open=False` While trying to use layout panels in these popups would normally just fail to add them, if a custom these popups tries to use a internal implementation that skips some checks, blender will crash For example, extending the script in the report #121458, this can crash ```python import bpy tree = bpy.data.node_groups["Geometry Nodes"] def draw(self, context): self.layout.label(text="--- Hi ---------") tree.nodes.active.draw_buttons_ext(context, self.layout) class Op(bpy.types.Operator): bl_idname = "aa.op" bl_label = "Operator" def execute(self, context): return {'FINISHED'} def invoke(self, context, event): # Any of the following alternatives would crash # context.window_manager.popup_menu(draw) # context.window_manager.popup_menu_pie(draw_func=draw, event=event) context.window_manager.popover(draw) return {'RUNNING_MODAL'} bpy.utils.register_class(Op) kmANe = bpy.context.window_manager.keyconfigs.addon.keymaps.new(name="Node Editor", space_type='NODE_EDITOR') kmANe.keymap_items.new(idname=Op.bl_idname, type='D', value='PRESS') ```

Guillermo Venegas added the

Type

Design

label 2024-05-10 22:44:30 +02:00

Iliya Katushenock added this to the User Interface project 2024-05-10 22:46:19 +02:00

Sign in to join this conversation.

No Label

Download

What's New

Blender Studio

Manual

Developers Blog

Documentation

Benchmark

Blender Conference

Development Fund

One-time Donations

Layout Panels support in popups #121674

`Layout Panels` support in `popups` #121674