Unified object and geometry I/O handling #68935
Open
opened 2019-08-20 22:46:18 +02:00 by Dalai Felinto
·
28 comments
No Branch/Tag Specified
temp-sculpt-dyntopo
main
temp-sculpt-dyntopo-hive-alloc
asset-shelf
blender-v3.6-release
brush-assets-project
blender-v3.3-release
tmp-usd-python-mtl
asset-browser-frontend-split
node-group-operators
blender-v2.93-release
universal-scene-description
temp-sculpt-attr-api
blender-v3.5-release
realtime-clock
sculpt-dev
gpencil-next
bevelv2
microfacet_hair
blender-projects-basics
xr-dev
principled-v2
v3.3.7
v2.93.18
v3.5.1
v3.3.6
v2.93.17
v3.5.0
v2.93.16
v3.3.5
v3.3.4
v2.93.15
v2.93.14
v3.3.3
v2.93.13
v2.93.12
v3.4.1
v3.3.2
v3.4.0
v3.3.1
v2.93.11
v3.3.0
v3.2.2
v2.93.10
v3.2.1
v3.2.0
v2.83.20
v2.93.9
v3.1.2
v3.1.1
v3.1.0
v2.83.19
v2.93.8
v3.0.1
v2.93.7
v3.0.0
v2.93.6
v2.93.5
v2.83.18
v2.93.4
v2.93.3
v2.83.17
v2.93.2
v2.93.1
v2.83.16
v2.93.0
v2.83.15
v2.83.14
v2.83.13
v2.92.0
v2.83.12
v2.91.2
v2.83.10
v2.91.0
v2.83.9
v2.83.8
v2.83.7
v2.90.1
v2.83.6.1
v2.83.6
v2.90.0
v2.83.5
v2.83.4
v2.83.3
v2.83.2
v2.83.1
v2.83
v2.82a
v2.82
v2.81a
v2.81
v2.80
v2.80-rc3
v2.80-rc2
v2.80-rc1
v2.79b
v2.79a
v2.79
v2.79-rc2
v2.79-rc1
v2.78c
v2.78b
v2.78a
v2.78
v2.78-rc2
v2.78-rc1
v2.77a
v2.77
v2.77-rc2
v2.77-rc1
v2.76b
v2.76a
v2.76
v2.76-rc3
v2.76-rc2
v2.76-rc1
v2.75a
v2.75
v2.75-rc2
v2.75-rc1
v2.74
v2.74-rc4
v2.74-rc3
v2.74-rc2
v2.74-rc1
v2.73a
v2.73
v2.73-rc1
v2.72b
2.72b
v2.72a
v2.72
v2.72-rc1
v2.71
v2.71-rc2
v2.71-rc1
v2.70a
v2.70
v2.70-rc2
v2.70-rc
v2.69
v2.68a
v2.68
v2.67b
v2.67a
v2.67
v2.66a
v2.66
v2.65a
v2.65
v2.64a
v2.64
v2.63a
v2.63
v2.61
v2.60a
v2.60
v2.59
v2.58a
v2.58
v2.57b
v2.57a
v2.57
v2.56a
v2.56
v2.55
v2.54
v2.53
v2.52
v2.51
v2.50
v2.49b
v2.49a
v2.49
v2.48a
v2.48
v2.47
v2.46
v2.45
v2.44
v2.43
v2.42a
v2.42
v2.41
v2.40
v2.37a
v2.37
v2.36
v2.35a
v2.35
v2.34
v2.33a
v2.33
v2.32
v2.31a
v2.31
v2.30
v2.28c
v2.28a
v2.28
v2.27
v2.26
v2.25
Labels
Clear labels
Issues relating to security: https://wiki.blender.org/wiki/Process/Vulnerability_Reports
Apply labels
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
Compositing
Interest
Core
Interest
Cycles
Interest
Dependency Graph
Interest
Development Management
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
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
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
Issues relating to security: https://wiki.blender.org/wiki/Process/Vulnerability_Reports
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 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
Compositing
Interest
Core
Interest
Cycles
Interest
Dependency Graph
Interest
Development Management
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
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
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
Milestone
Set milestone
Clear milestone
No items
No Milestone
Projects
Set Project
Clear projects
No project
Assignees
Assign users
Clear assignees
No Assignees
21 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#68935
Reference in New Issue
There is no content yet.
Delete Branch "%!s(<nil>)"
Deleting a branch is permanent. Although the deleted branch may exist for a short time before cleaning up, in most cases it CANNOT be undone. Continue?
Motivation
Currently I/O for objects and geometry is primarily handled through import and exporter operators. But there are plans to extend this to:
For this we need a unified system to handle I/O for various file formats, to provide consistent functionality across these areas and avoid code duplication.
It will also make a better user interface for the import operator possible, with a single
File > Import
menu entry where you can then pick a file and see the appropriate options, without having to determine the file format first. Drag & drop similarly should be able to recognize the file type automatically.Design Proposal
Add new
IOHandler
type that can be subclassed, similar to operators or render engines (maybe a better name can be found).It would include:
The precise functionality needs to be determined by looking at the various use cases. But a few general points:
Can be stored as ID properties. Potentially the defined properties may depend on the use case, for example an import operator may have additional properties relating to how it affects the scene, compared to collection I/O which may be more local.
** This could work similar to library linking .blend files. That is, importing would populate its own main database with datablocks. The operator, geometry node, assets system would then receive this main database and use, copy or link the datablocks as appropriate for each. This gives each use case more control over the ownership, and by not affecting the main .blend database there should be no side effects from running the import method.
Exporters typically export depsgraph evaluated scene data. They also have options for exporting only selections or the entire scene. There is some potential here for an abstraction that provides the relevant subset of evaluated scene data to the exporter, but the right API for this is not obvious. On the other hand for syncing with Omniverse or other collaborative tools, the data you import and export needs to match, so then you might be exporting original scene data? This might be something we do for USD only and after the basic I/O handler is in place, it's unclear if this would be part of the same system and how it would fit in.
Currently assets must always be datablocks from .blend files, but ideally any importable file would be indexable by the asset browsers as well. For this it's important to be able to quickly read metadata, maybe read or generate a preview image. Being able to get the file as a set of datablocks in a database could allow reusing existing code more. Even image files could be read as an image datablock for example. However the asset system might already have plans for its own abstractions here, we need to check how it fits.
Added subscriber: @dfelinto
Added subscriber: @Jaydead
Added subscriber: @lsscpp
Added subscriber: @zodiac98177
Nice! Another thing that can be really handy is to be able to see shortcut folders as they are currently not available and when you try to import something you have to fish throughout your regular folders to get to that specific one to which you have a shortcut on your desktop but can't really use in Blender at the moment.
Added subscriber: @GeRo
Added subscriber: @xdanic
Added subscriber: @Ozeki
Removed subscriber: @Ozeki
This should be valid also for exporting
Added subscriber: @donmccurdy
Added subscriber: @Mentales
Added subscriber: @JulianEisel
This popped up on my radar...
Making the File Browser more dynamic (show settings based on active file type) is quite important I think, not just for importers but for the VSE as well. Unfortunately it's not easy to do since a lot of File Browser code assumes the old design.
For drag and drop, this also isn't as easy as it may seem, see #44670 for details and an explanation of how it should be done in my opinion.
Added subscriber: @john-astudillo
genial, esto es muy necesario.
Added subscriber: @IihT2cWA9xiP30BsYphz3EiEISNoScoe
Added subscriber: @TheRedWaxPolice
Added subscriber: @SonnyCampbell_Unity
Unifying I/O importing and drag and dropto Unified object and geometry I/O handlingAdded subscriber: @mod_moder
Added subscriber: @RedMser
Added subscriber: @erik85
One thing to keep in mind is that multiple plugins could use the same file formats so there needs to be some option for that too.
Since the asset system is mentioned here:
While it's true that the asset system currently requires assets to be data-blocks (as in IDs), we're moving away from that more and more. The asset system design foresees to only represent assets as a package for arbitrary data (important step: {1efc94bb2f7b}), with enough information to present it to the user and invoke the wanted behavior via some callbacks/interfaces. For example assets can already be loaded from the asset index json files, and only when actually dragging in the asset we call the ID link/append code.
Asset libraries are un-opinionated containers, so add-ons (or core code of course) can populate them however they like. They could just include IO files, or the user manually tells Blender to treat certain files as assets. This code would also provide the callbacks (e.g. for importing/applying the asset, regenerating the preview, visualizing drag & drop, etc).
Fast access to asset metadata is indeed important. If the file format supports metadata well this can be used. For others we discussed sidecar files.
Other thing,
IOHandler
sounds a bit ambiguous, could also be some file system interface, socket connection or some other data communication system. MaybeImportExportFormatHandler
or so.Added subscriber: @JanErik
Added subscriber: @lichtwerk
Added subscriber: @kevindietrich
Added subscriber: @AlexeyAdamitsky