Rationalize the existing drag/drop handling code with the new FileHandlerType support #117621

Open
opened 2024-01-29 05:50:08 +01:00 by Jesse Yurkovich · 1 comment

Problem

Blender has two pieces of machinery that handles drag/drop support for files. The original code which directly calls WM_dropbox_add for each interested Editor and the new FileHandlerType code which allows dynamic, runtime, registration of drag/drop handlers.

These two are in conflict with one another as the original set of dropboxes will typically "steal" processing away from later handlers. E.g. It's not possible to write a FileHandler that handles .py file types for the text editor. Nor would it be possible to write a FileHandler that handles Image types for the 3DViewport etc.

Possible solution

FileHandlers already have a conflict resolution mechanism if more than one handler can process a given file type. We should explore what it would take to implement the original dropboxes in terms of FileHandlers.

Pending tasks

TODO's

  • If there are multiple FileHandlers enabled for Image drop in the viewport, the dropped image location may not be as expected after the user interacts with the conflict resolution popup dialog since the mouse location would most likely change. PR feedback was to look into saving the initial event coordinates in this case.
### Problem Blender has two pieces of machinery that handles drag/drop support for files. The original code which directly calls `WM_dropbox_add` for each interested Editor and the new `FileHandlerType` code which allows dynamic, runtime, registration of drag/drop handlers. These two are in conflict with one another as the original set of dropboxes will typically "steal" processing away from later handlers. E.g. It's not possible to write a FileHandler that handles `.py` file types for the text editor. Nor would it be possible to write a FileHandler that handles Image types for the 3DViewport etc. ### Possible solution FileHandlers already have a conflict resolution mechanism if more than one handler can process a given file type. We should explore what it would take to implement the original dropboxes in terms of FileHandlers. ### Pending tasks * [x] Image drops in the 3d viewport (commit 8b6a21c122eebf043732630cd55e77edf6236efa, PR blender/blender!117728) * [x] Image drops in the Image editor (commit b97ac126f8489fbd4730a95d14a70ad446ca5f4d, PR blender/blender!117707) * [ ] Image drops in the Node editor which should support multiple at a time ### TODO's * [ ] If there are multiple FileHandlers enabled for Image drop in the viewport, the dropped image location may not be as expected after the user interacts with the conflict resolution popup dialog since the mouse location would most likely change. PR feedback was to look into saving the initial event coordinates in this case.
Jesse Yurkovich added the
Module
User Interface
Type
Design
labels 2024-01-29 05:50:08 +01:00
Contributor

There are some that are easy to port (#117728)
Others require a little more work to improve usability (#117707)

There are some that are easy to port (https://projects.blender.org/blender/blender/pulls/117728) Others require a little more work to improve usability (https://projects.blender.org/blender/blender/pulls/117707)
Sign in to join this conversation.
No Label
Interest
Alembic
Interest
Animation & Rigging
Interest
Asset Browser
Interest
Asset Browser Project Overview
Interest
Audio
Interest
Automated Testing
Interest
Blender Asset Bundle
Interest
BlendFile
Interest
Collada
Interest
Compatibility
Interest
Compositing
Interest
Core
Interest
Cycles
Interest
Dependency Graph
Interest
Development Management
Interest
EEVEE
Interest
EEVEE & Viewport
Interest
Freestyle
Interest
Geometry Nodes
Interest
Grease Pencil
Interest
ID Management
Interest
Images & Movies
Interest
Import Export
Interest
Line Art
Interest
Masking
Interest
Metal
Interest
Modeling
Interest
Modifiers
Interest
Motion Tracking
Interest
Nodes & Physics
Interest
OpenGL
Interest
Overlay
Interest
Overrides
Interest
Performance
Interest
Physics
Interest
Pipeline, Assets & IO
Interest
Platforms, Builds & Tests
Interest
Python API
Interest
Render & Cycles
Interest
Render Pipeline
Interest
Sculpt, Paint & Texture
Interest
Text Editor
Interest
Translations
Interest
Triaging
Interest
Undo
Interest
USD
Interest
User Interface
Interest
UV Editing
Interest
VFX & Video
Interest
Video Sequencer
Interest
Virtual Reality
Interest
Vulkan
Interest
Wayland
Interest
Workbench
Interest: X11
Legacy
Blender 2.8 Project
Legacy
Milestone 1: Basic, Local Asset Browser
Legacy
OpenGL Error
Meta
Good First Issue
Meta
Papercut
Meta
Retrospective
Meta
Security
Module
Animation & Rigging
Module
Core
Module
Development Management
Module
EEVEE & Viewport
Module
Grease Pencil
Module
Modeling
Module
Nodes & Physics
Module
Pipeline, Assets & IO
Module
Platforms, Builds & Tests
Module
Python API
Module
Render & Cycles
Module
Sculpt, Paint & Texture
Module
Triaging
Module
User Interface
Module
VFX & Video
Platform
FreeBSD
Platform
Linux
Platform
macOS
Platform
Windows
Priority
High
Priority
Low
Priority
Normal
Priority
Unbreak Now!
Status
Archived
Status
Confirmed
Status
Duplicate
Status
Needs Info from Developers
Status
Needs Information from User
Status
Needs Triage
Status
Resolved
Type
Bug
Type
Design
Type
Known Issue
Type
Patch
Type
Report
Type
To Do
No Milestone
No project
No Assignees
2 Participants
Notifications
Due Date
The due date is invalid or out of range. Please use the format 'yyyy-mm-dd'.

No due date set.

Dependencies

No dependencies set.

Reference: blender/blender#117621
No description provided.