ID Management: Sanitize and clarify our ID creation/copy tags #90610

New Issue

Bastien Montagne · 2021-08-11T16:31:18+02:00

Bastien Montagne commented

2021-08-11 16:31:18 +02:00

Some of our ID creation/copying code and flags are currently still fuzzy and not really correct, especially when changes proposed in #88555 (ID Management: Sanitize and clarify our ID tags) become real. This concerns 'out of G_MAIN' IDs mostly.

IMPORTANT: This task is a sister of #88555 (ID Management: Sanitize and clarify our ID tags), both will be worked on together.

`LIB_ID_CREATE_LOCALIZE`

This ID creation flag is only used in two places, and its name is extremely confusing since it actually sets NO_MAIN flag, not LOCALIZED one. It should simply be removed.

`LIB_ID_COPY_LOCALIZE`

Should be updated to set LOCALIZED flag instead of NO_MAIN one: LIB_ID_CREATE_LOCAL | LIB_ID_CREATE_NO_USER_REFCOUNT | LIB_ID_CREATE_NO_DEG_TAG | LIB_ID_COPY_NO_PREVIEW | LIB_ID_COPY_NO_LIB_OVERRIDE

A new LIB_ID_COPY_NO_MAIN set of flags should be added with default behavior to create a NO_MAIN ID, probably LIB_ID_CREATE_NO_MAIN | LIB_ID_CREATE_NO_DEG_TAG | LIB_ID_COPY_NO_PREVIEW | LIB_ID_COPY_CACHES | LIB_ID_COPY_NO_LIB_OVERRIDE (would leave NO_REF_COUNT out of the default set of flags).

`ntreeLocalize`

This special function needs to be removed, this specific behavior should be strictly handled through calls to generic BKE_id_copy_ex and dedicated code in ntree_copy_data IDType callback.

Not sure where the recursive copying of sub-trees should be handled though, either in BKE_id_copy_ex or BKE_libblock_copy_ex, in a similar way to how we deal with animation data currently, or from ntree_copy_data, as done e.g. for shapekeys for meshes and other obdata?
Would rather keep this 'localize' behavior in the ntree_copy_data i think, at least for now. We need a full rethink of how we handle recursive 'deep' copying of IDs anyway, current code is dodgy at best here, and often fully broken (ref. #72659 (Making 'singleuser' for a group with too smart NodeCustomGroup breaks user counters of both source and target nodes) and similar).

Some of our ID creation/copying code and flags are currently still fuzzy and not really correct, especially when changes proposed in #88555 (ID Management: Sanitize and clarify our ID tags) become real. This concerns 'out of `G_MAIN`' IDs mostly. IMPORTANT: This task is a sister of #88555 (ID Management: Sanitize and clarify our ID tags), both will be worked on together. ## `LIB_ID_CREATE_LOCALIZE` This ID creation flag is only used in two places, and its name is extremely confusing since it actually sets `NO_MAIN` flag, not `LOCALIZED` one. It should simply be removed. ## `LIB_ID_COPY_LOCALIZE` Should be updated to set `LOCALIZED` flag instead of `NO_MAIN` one: `LIB_ID_CREATE_LOCAL | LIB_ID_CREATE_NO_USER_REFCOUNT | LIB_ID_CREATE_NO_DEG_TAG | LIB_ID_COPY_NO_PREVIEW | LIB_ID_COPY_NO_LIB_OVERRIDE` A new `LIB_ID_COPY_NO_MAIN` set of flags should be added with default behavior to create a `NO_MAIN` ID, probably `LIB_ID_CREATE_NO_MAIN | LIB_ID_CREATE_NO_DEG_TAG | LIB_ID_COPY_NO_PREVIEW | LIB_ID_COPY_CACHES | LIB_ID_COPY_NO_LIB_OVERRIDE` (would leave `NO_REF_COUNT` out of the default set of flags). ## `ntreeLocalize` This special function needs to be removed, this specific behavior should be strictly handled through calls to generic `BKE_id_copy_ex` and dedicated code in `ntree_copy_data` IDType callback. Not sure where the recursive copying of sub-trees should be handled though, either in `BKE_id_copy_ex` or `BKE_libblock_copy_ex`, in a similar way to how we deal with animation data currently, or from `ntree_copy_data`, as done e.g. for shapekeys for meshes and other obdata? *Would rather keep this 'localize' behavior in the `ntree_copy_data` i think, at least for now. We need a full rethink of how we handle recursive 'deep' copying of IDs anyway, current code is dodgy at best here, and often fully broken (ref. #72659 (Making 'singleuser' for a group with too smart NodeCustomGroup breaks user counters of both source and target nodes) and similar).*

Bastien Montagne commented

2021-08-11 16:31:18 +02:00

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

Bastien Montagne commented

2021-08-11 16:31:18 +02:00

Added subscriber: @mont29

Brecht Van Lommel commented

2021-11-02 19:07:15 +01:00

Added subscriber: @brecht

Brecht Van Lommel commented

2021-11-02 19:07:15 +01:00

This seems fine.

Philipp Oeser removed the

Download

What's New

Blender Studio

Manual

Developers Blog

Documentation

Benchmark

Blender Conference

Development Fund

One-time Donations

ID Management: Sanitize and clarify our ID creation/copy tags #90610

LIB_ID_CREATE_LOCALIZE

LIB_ID_COPY_LOCALIZE

ntreeLocalize

`LIB_ID_CREATE_LOCALIZE`

`LIB_ID_COPY_LOCALIZE`

`ntreeLocalize`