Library Override - 'Cherry-Picked' Properties #95816

Open
opened 2022-02-16 13:15:17 +01:00 by Bastien Montagne · 14 comments

General Idea


The idea behind this task is to help with collaboration between the different pipeline stages artists. In a nutshell, the artists creating an asset will be able to define which properties should be typically editable by the artists using this asset.

While the primary goal of this task is to handle the library overrides case, this feature should not be limited to them, not even to overrides in general.

The main two ideas are:

  • Defining a set of 'cherry-picked' properties for each data-block, when creating the asset. Then add a 'filtered' mode to the properties editor, that would only show those favorite properties. This filtered mode would be enabled by default for library override data-blocks.
  • Non-cherry-picked properties remain editable, but there will be tools (in the Outliner, and RNA/python API) to quickly detect and revert those if they are edited.

NOTE: This design is the latest evolution of the 'restrictive workflow' idea.


UI/UX, Workflow


A new filtered option will be added to the Properties editor, only enabled by default for linked/overridden IDs, when they do define a set of cherry-picked properties.

overrides_favorites_propertyeditor.png

A new mode will be added to the Outliner, to help visualizing and bulk-editing 'cherry-picked' properties.

overrides_favorites_outliner.png

Creation

Defining which properties are cherry-picked (and therefore shown by default when the data is linked and overridden) will happen during asset creation.

Whole data-blocks may also be defined as 'cherry-picked', in which case all of their properties will be shown/editable.

The main place to define them will be the properties editor (from an entry in the contextual menu on the relevant widgets). The same option could also be added to the contextual menu of the 'Data API' view in the Outliner, for completeness.

Visualizing/editing defined favorite properties can happen either from the Properties editor itself, by toggling the filtered mode on, and/or using some visual feedback on their widgets (specific color, hashed-grayed-out...), or from the dedicated mode in the overrides Outliner view.

Usage

By default, users of a linked/overridden data-block which has cherry-picked defined, would only see these in the properties editor.

They can toggle the filter off though, if they want to have access to other properties.

The Outliner Overrides views will show a warning when a non-cherry-picked property has been edited.

Technical Implementation


While they have a lot in common with liboverrides, 'cherry-picked properties' should be implemented in a separate data structure/BKE module, as they also can extend beyond liboverrides scope. The idea of 'liboverride templates' is then not used here.

Proposal is then to have a new optional struct (through pointer) in ID, with a general flag (e.g. to define the ID as fully editable), and a 'allow' list of RNA paths (+ flags potentially) for the 'cherry-picked properties'.

The basic management code would be in a new BKE module (BKE_lib_cherrypicked_properties or so). Ideally some generic handling could be factored out of this module, the liboverride one, and potentially the future dynamic override one, in the future.

An RNA-based API will be added for scripts control.

Changes to the outliner and properties editor code needs to be defined.

Changes to the existing liboverride code is expected to be minimal. One side task may be to clean up the 'half-dead' code of the initial 'template' implementation, could simplify slightly the liboverride code.

Tasks


  • Decide on actual name: "Favorite Properties"? "Exposed Properties"? "Principal Properties"? "Cherry-Picked" properties
  • Create an Icon for them (with ON/partially ON/OFF variants). For now, the 'eye' one could be used.
    Could be e.g. some mix of 'heart' and 'system' icons? {F12890805}
  • Create the low-level BKE code and DNA data structures.
  • Create the RNA API.
  • Add the Properties editor filtered view.
    • Add a 'only show' mode (i.e. fully hide the filtered out properties)?
    • Add a specific 'grayed-out' mode (e.g. using a hash-pattern grayed-out)?
  • Add a visual feed-back in library file about which properties are cherry-picked (could be e.g. a new 'column' next to the 'animation' one, or a specific background/border color for the widgets).
  • Add the 'Cherry-Picked' view to the Outliner (or as a new mode for the 'Blender File' view?).
  • Add entries to the contextual menu in Properties and Outliner editors (including high-level management operators).
General Idea **** The idea behind this task is to help with collaboration between the different pipeline stages artists. In a nutshell, the artists creating an asset will be able to define which properties should be typically editable by the artists using this asset. While the primary goal of this task is to handle the library overrides case, this feature should not be limited to them, not even to overrides in general. The main two ideas are: * Defining a set of 'cherry-picked' properties for each data-block, when creating the asset. Then add a 'filtered' mode to the properties editor, that would only show those favorite properties. This filtered mode would be enabled by default for library override data-blocks. * Non-cherry-picked properties remain editable, but there will be tools (in the Outliner, and RNA/python API) to quickly detect and revert those if they are edited. NOTE: This design is the latest evolution of the 'restrictive workflow' idea. ------------------------------- UI/UX, Workflow **** A new filtered option will be added to the Properties editor, only enabled by default for linked/overridden IDs, when they do define a set of cherry-picked properties. ![overrides_favorites_propertyeditor.png](https://archive.blender.org/developer/F12869781/overrides_favorites_propertyeditor.png) A new mode will be added to the Outliner, to help visualizing and bulk-editing 'cherry-picked' properties. ![overrides_favorites_outliner.png](https://archive.blender.org/developer/F12869783/overrides_favorites_outliner.png) Creation ---------- Defining which properties are cherry-picked (and therefore shown by default when the data is linked and overridden) will happen during asset creation. Whole data-blocks may also be defined as 'cherry-picked', in which case all of their properties will be shown/editable. The main place to define them will be the properties editor (from an entry in the contextual menu on the relevant widgets). The same option could also be added to the contextual menu of the 'Data API' view in the Outliner, for completeness. Visualizing/editing defined favorite properties can happen either from the Properties editor itself, by toggling the filtered mode on, and/or using some visual feedback on their widgets (specific color, hashed-grayed-out...), or from the dedicated mode in the overrides Outliner view. Usage ------- By default, users of a linked/overridden data-block which has cherry-picked defined, would only see these in the properties editor. They can toggle the filter off though, if they want to have access to other properties. The Outliner Overrides views will show a warning when a non-cherry-picked property has been edited. Technical Implementation **** While they have a lot in common with liboverrides, 'cherry-picked properties' should be implemented in a separate data structure/BKE module, as they also can extend beyond liboverrides scope. The idea of 'liboverride templates' is then not used here. Proposal is then to have a new optional struct (through pointer) in ID, with a general flag (e.g. to define the ID as fully editable), and a 'allow' list of RNA paths (+ flags potentially) for the 'cherry-picked properties'. The basic management code would be in a new BKE module (`BKE_lib_cherrypicked_properties` or so). *Ideally some generic handling could be factored out of this module, the liboverride one, and potentially the future dynamic override one, in the future.* An RNA-based API will be added for scripts control. Changes to the outliner and properties editor code needs to be defined. Changes to the existing liboverride code is expected to be minimal. One side task may be to clean up the 'half-dead' code of the initial 'template' implementation, could simplify slightly the liboverride code. Tasks **** - [x] Decide on actual name: ~~"Favorite Properties"? "Exposed Properties"? "Principal Properties"?~~ "Cherry-Picked" properties - [ ] Create an Icon for them (with ON/partially ON/OFF variants). For now, the 'eye' one could be used. *Could be e.g. some mix of 'heart' and 'system' icons? {[F12890805](https://archive.blender.org/developer/F12890805/favorite_props_icon_proposal.png)}* - [ ] Create the low-level BKE code and DNA data structures. - [ ] Create the RNA API. - [ ] Add the Properties editor filtered view. - [ ] Add a 'only show' mode (i.e. fully hide the filtered out properties)? - [ ] Add a specific 'grayed-out' mode (e.g. using a hash-pattern grayed-out)? - [ ] Add a visual feed-back in library file about which properties are cherry-picked (could be e.g. a new 'column' next to the 'animation' one, or a specific background/border color for the widgets). - [ ] Add the 'Cherry-Picked' view to the Outliner (or as a new mode for the 'Blender File' view?). - [ ] Add entries to the contextual menu in Properties and Outliner editors (including high-level management operators).
Author
Owner

Changed status from 'Needs Triage' to: 'Confirmed'

Changed status from 'Needs Triage' to: 'Confirmed'
Author
Owner

Added subscriber: @mont29

Added subscriber: @mont29

#86812 was marked as duplicate of this issue

#86812 was marked as duplicate of this issue
Author
Owner

Added subscribers: @Jeroen-Bakker, @RedMser, @lichtwerk

Added subscribers: @Jeroen-Bakker, @RedMser, @lichtwerk
Bastien Montagne changed title from Library Override - 'Favorite' Properties to Library Override - 'Cherry-Picked' Properties 2022-05-17 16:34:05 +02:00

Added subscriber: @Emi_Martinez

Added subscriber: @Emi_Martinez

Added subscriber: @AlexeyAdamitsky

Added subscriber: @AlexeyAdamitsky

I'd like to contribute an icon for the task.

Figma_MCIO4rvXbf.png
100%

Figma_06q6uQJbKs.png
200%

There are two versions: outline and filled. They have small differences but I am open to adjust any of them for the final design.

It's my first contribution so I'm might need some guidance how to proceed further and who to contact regarding this if it's something worth exploring further.

I'd like to contribute an icon for the task. ![Figma_MCIO4rvXbf.png](https://archive.blender.org/developer/F13126197/Figma_MCIO4rvXbf.png) 100% ![Figma_06q6uQJbKs.png](https://archive.blender.org/developer/F13126200/Figma_06q6uQJbKs.png) 200% There are two versions: outline and filled. They have small differences but I am open to adjust any of them for the final design. It's my first contribution so I'm might need some guidance how to proceed further and who to contact regarding this if it's something worth exploring further.

Added subscriber: @dfelinto

Added subscriber: @dfelinto

@AlexeyAdamitsky thanks. We changed the name and in a way the purpose of this a bit. Now it is closer to "cherry-pick". In that sense the concept of a heart (and/or cogs) doesn't apply anymore.

On an icon level I also find that the cogs don't work when reduced (when the icon is seeing at the UI. The teeth of the cog end up just adding a fuzzy noise.

@AlexeyAdamitsky thanks. We changed the name and in a way the purpose of this a bit. Now it is closer to "cherry-pick". In that sense the concept of a heart (and/or cogs) doesn't apply anymore. On an icon level I also find that the cogs don't work when reduced (when the icon is seeing at the UI. The teeth of the cog end up just adding a fuzzy noise.

@dfelinto Those are valid points. Let's explore another concept. I re-read the design brief and decided to go a little bit more straight forward with the icons borrowing from existing solutions.

Left to right: on, off, partially on status.

Figma_YbpOSV7viq.png
100%

Figma_Etb0Z7PG38.png
200%

Let me know if this is a good direction or not. Meanwhile, I'll explore about another original icon design.

@dfelinto Those are valid points. Let's explore another concept. I re-read the design brief and decided to go a little bit more straight forward with the icons borrowing from existing solutions. Left to right: on, off, partially on status. ![Figma_YbpOSV7viq.png](https://archive.blender.org/developer/F13135155/Figma_YbpOSV7viq.png) 100% ![Figma_Etb0Z7PG38.png](https://archive.blender.org/developer/F13135158/Figma_Etb0Z7PG38.png) 200% Let me know if this is a good direction or not. Meanwhile, I'll explore about another original icon design.

Added subscriber: @Logan-Gardner

Added subscriber: @Logan-Gardner

I decided to clean up one of the ideas. Rearranging some elements to simplify the icon even further to remove some visual noise. I think it works pretty well for the task.

100%
Figma_JwXdVMkyKz.png
200%
Figma_ZhUZNmyzeX.png
400%
Figma_oWftJ00LgR.png

I'll keep exploring other ideas in my spare time.

I decided to clean up one of the ideas. Rearranging some elements to simplify the icon even further to remove some visual noise. I think it works pretty well for the task. 100% ![Figma_JwXdVMkyKz.png](https://archive.blender.org/developer/F13265536/Figma_JwXdVMkyKz.png) 200% ![Figma_ZhUZNmyzeX.png](https://archive.blender.org/developer/F13265538/Figma_ZhUZNmyzeX.png) 400% ![Figma_oWftJ00LgR.png](https://archive.blender.org/developer/F13265540/Figma_oWftJ00LgR.png) I'll keep exploring other ideas in my spare time.

Added subscriber: @pauanyu_blender

Added subscriber: @pauanyu_blender

Added subscriber: @satishgoda1

Added subscriber: @satishgoda1
Philipp Oeser removed the
Interest
Core
label 2023-02-09 14:42:51 +01:00
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
8 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#95816
No description provided.