blender/blender

Implement Asset Traits #105808

New Issue

Closed

opened 2023-03-15 19:41:19 +01:00 by Julian Eisel · 6 comments

Julian Eisel commented

2023-03-15 19:41:19 +01:00

Member

Asset traits would be keywords that are stored in the asset metadata, and provide information about the type of an asset. For example {"ID", "Node Tree", "Geometry Nodes"}, or {"ID", "Brush", "Sculpt Mode"}. Unlike tags, they are managed by Blender or add-ons, not by the user.

Comprehensive design task: #105807

Implementation

Store list of traits in AssetMetaData
RNA access
File read/write
Index read/write
Code to add/remove traits
IDTypeInfo.refine_asset_traits() callback?
Versioning for old assets?
Make ID type a runtime only trait? (Can be cheaply read from the ID type)
Optimized lookups in a hash inside AssetRepresentation?

Plenty of code can be copied from tags.

Asset traits would be keywords that are stored in the asset metadata, and provide information about the type of an asset. For example `{"ID", "Node Tree", "Geometry Nodes"}`, or `{"ID", "Brush", "Sculpt Mode"}`. Unlike tags, they are managed by Blender or add-ons, not by the user. Comprehensive design task: #105807 ---- ## Implementation - [ ] Store list of traits in `AssetMetaData` - [ ] RNA access - [ ] File read/write - [ ] Index read/write - [ ] Code to add/remove traits - [ ] `IDTypeInfo.refine_asset_traits()` callback? - [ ] Versioning for old assets? - [ ] Make ID type a runtime only trait? (Can be cheaply read from the ID type) - [ ] Optimized lookups in a hash inside `AssetRepresentation`? Plenty of code can be copied from tags.

Julian Eisel added the

label 2023-03-15 19:41:19 +01:00

Julian Eisel commented

2023-03-15 19:43:55 +01:00

Author

Member

@Harley wanted to look into implementing the basics for this.

@Harley wanted to look into implementing the basics for this.

Harley Acheson was assigned by Julian Eisel

2023-03-15 19:44:04 +01:00

Julian Eisel added this to the Brush Assets & Asset Shelf project 2023-03-15 19:44:11 +01:00

Julian Eisel added the

Pipeline, Assets & IO

labels 2023-03-15 19:44:28 +01:00

Harley Acheson referenced this issue

2023-03-16 20:10:41 +01:00

Assets: Implement Traits #105841

Harley Acheson commented

2023-03-16 20:15:05 +01:00

Member

PR #105841 should be doing the first five items, string list of traits in AssetMetaData,
RNA access, File read/write, Index read/write, Code to add/remove traits.

It currently displays in the interface somewhat identically to "tags" so have "add" and "remove" that we (I assume) don't need or want. But I needed that for testing so assume it can be removed once confirmed correct. Currently unclear on the rest of the TODO items, but will take a look around to see if any make sense to me.

PR #105841 should be doing the first five items, string list of traits in AssetMetaData, RNA access, File read/write, Index read/write, Code to add/remove traits. It currently displays in the interface somewhat identically to "tags" so have "add" and "remove" that we (I assume) don't need or want. But I needed that for testing so assume it can be removed once confirmed correct. Currently unclear on the rest of the TODO items, but will take a look around to see if any make sense to me.

Julian Eisel commented

2023-03-20 17:17:54 +01:00

Author

Member

Clarification for the remaining points:

IDTypeInfo.refine_asset_traits() callback?

I'd imagine an API to enable something like this:

void brush_asset_refine_asset_traits(ID *id, AssetTraitList *traits)
{
  /* Trait "ID" and "Brush" are already added. */
  
  /* Note that a brush may support multiple modes. */

  if (/* supports sculpt mode */ ...) {
    AS_asset_trait_ensure(traits, N_("Sculpt"));
  }
  if (/* supports texture paint mode */...) {
    AS_asset_trait_ensure(traits, N_("Texture Paint"));
  }
}

Actually, this callback should be defined in AssetTypeInfo, not IDTypeInfo.

It's not entirely clear when this would be called, I think for now doing it when marking as asset is enough. Doing it on file save for every asset would be the most reliable. But would rather avoid having to do that for potentially 100s of assets on every save.

Versioning for old assets?

There's the question if we should add asset traits for existing assets in versioning. E.g. "Object" and "ID" for object assets. Open question still. It's easy to add this later also.

Make ID type a runtime only trait? (Can be cheaply read from the ID type)

Currently the "ID" and id type traits are redundant. All asset must be IDs and the ID type is read from the .blend file anyway. So instead of storing this in the asset metadata itself, we can just create these traits when loading an asset library.

Optimized lookups in a hash inside AssetRepresentation?

In future I expect we'll often want to do lookups inside the traits, since they give crucial type information. A list lookup is rather slow and scales bad, so we should use a hash map. This may not be entirely trivial to add though, let's first get the basics working and merged.

Clarification for the remaining points: > - [ ] `IDTypeInfo.refine_asset_traits()` callback? I'd imagine an API to enable something like this: ```C void brush_asset_refine_asset_traits(ID *id, AssetTraitList *traits) { /* Trait "ID" and "Brush" are already added. */ /* Note that a brush may support multiple modes. */ if (/* supports sculpt mode */ ...) { AS_asset_trait_ensure(traits, N_("Sculpt")); } if (/* supports texture paint mode */...) { AS_asset_trait_ensure(traits, N_("Texture Paint")); } } ``` Actually, this callback should be defined in `AssetTypeInfo`, not `IDTypeInfo`. It's not entirely clear when this would be called, I think for now doing it when marking as asset is enough. Doing it on file save for every asset would be the most reliable. But would rather avoid having to do that for potentially 100s of assets on every save. > - [ ] Versioning for old assets? There's the question if we should add asset traits for existing assets in versioning. E.g. "Object" and "ID" for object assets. Open question still. It's easy to add this later also. > - [ ] Make ID type a runtime only trait? (Can be cheaply read from the ID type) Currently the "ID" and id type traits are redundant. All asset must be IDs and the ID type is read from the .blend file anyway. So instead of storing this in the asset metadata itself, we can just create these traits when loading an asset library. > - [ ] Optimized lookups in a hash inside `AssetRepresentation`? In future I expect we'll often want to do lookups inside the traits, since they give crucial type information. A list lookup is rather slow and scales bad, so we should use a hash map. This may not be entirely trivial to add though, let's first get the basics working and merged.

Harley Acheson commented

2023-03-20 23:15:05 +01:00

Member

Hmmm... that forced me to learn about object ID and IDTypeInfo. Yikes.

I might be misunderstanding you about the "ID" trait, but right now my PR will add things like the following:

Add a "Cube" and get the following traits

ID
Object
Cube
Mesh

Add a "Collection"

ID
Collection

Add a "Charge Forcefield"

ID
Object
Charge
Empty

Hmmm... that forced me to learn about object ID and IDTypeInfo. Yikes. I might be misunderstanding you about the "ID" trait, but right now my PR will add things like the following: Add a "Cube" and get the following traits * ID * Object * Cube * Mesh Add a "Collection" * ID * Collection Add a "Charge Forcefield" * ID * Object * Charge * Empty

Julian Eisel commented

2023-03-21 17:07:45 +01:00

Author

Member

Sorry, I didn't mean to imply that you should already add such callbacks. I'd say we add them on a as needed basis.

I guess the nodes team would want to add some traits to identify the type of node tree (e.g. to display the geometry nodes icon in the asset browser), and to identify node group assets that can be used as modifiers.
For brush assets we will need this to determine which modes a brush can be used in, and to filter by that.

Sorry, I didn't mean to imply that you should already add such callbacks. I'd say we add them on a as needed basis. I guess the nodes team would want to add some traits to identify the type of node tree (e.g. to display the geometry nodes icon in the asset browser), and to identify node group assets that can be used as modifiers. For brush assets we will need this to determine which modes a brush can be used in, and to filter by that.

Julian Eisel commented

2024-05-29 14:46:20 +02:00

Author

Member

Closing this since there have been objections to the design, see #105807.

Closing this since there have been objections to the design, see #105807.

Julian Eisel closed this issue

2024-05-29 14:46:23 +02:00

Blender Bot added the

label 2024-05-29 14:46:24 +02:00

Sign in to join this conversation.

No Label

Animation & Rigging

Automated Testing

Blender Asset Bundle

Dependency Graph

Development Management

Images & Movies

Motion Tracking

Nodes & Physics

Pipeline, Assets & IO

Platforms, Builds & Tests

Render & Cycles

Render Pipeline

Sculpt, Paint & Texture

Video Sequencer

Viewport & EEVEE

Virtual Reality

Asset Browser Project

Blender 2.8 Project

Milestone 1: Basic, Local Asset Browser

Good First Issue

Animation & Rigging

Development Management

Nodes & Physics

Pipeline, Assets & IO

Platforms, Builds & Tests

Render & Cycles

Sculpt, Paint & Texture

Viewport & EEVEE

Needs Info from Developers

Needs Information from User

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#105808

No description provided.