Blender V5.3
sequencer_add_modifier_assets.cc
Go to the documentation of this file.
1/* SPDX-FileCopyrightText: 2026 Blender Authors
2 *
3 * SPDX-License-Identifier: GPL-2.0-or-later */
4
8
9#include "AS_asset_catalog.hh"
11#include "AS_asset_library.hh"
13
14#include "BLI_listbase.hh"
15#include "BLI_string_utf8.hh"
16
17#include "BKE_asset.hh"
18#include "BKE_context.hh"
19#include "BKE_idprop.hh"
20#include "BKE_lib_id.hh"
21#include "BKE_main.hh"
22#include "BKE_screen.hh"
23
24#include "BLT_translation.hh"
25
26#include "ED_asset.hh"
28#include "ED_object.hh"
29
30#include "NOD_composite.hh"
31
32#include "UI_interface.hh"
34
35#include "WM_api.hh"
36
37#include "SEQ_modifier.hh"
38#include "SEQ_relations.hh"
39#include "SEQ_select.hh"
40
41#include "sequencer_intern.hh"
42
43namespace blender::ed::vse {
44
46{
48 return asset::list::is_loaded(&all_library_ref);
49}
50
52{
53 asset::AssetFilterSettings type_filter{};
54 type_filter.id_types = FILTER_ID_NT;
55 auto meta_data_filter = [&](const AssetMetaData &meta_data) {
56 const IDProperty *tree_type = BKE_asset_metadata_idprop_find(&meta_data, "type");
57 if (tree_type == nullptr || IDP_int_get(tree_type) != NTREE_COMPOSIT) {
58 return false;
59 }
60 const IDProperty *traits_flag = BKE_asset_metadata_idprop_find(
61 &meta_data, "compositor_node_asset_traits_flag");
62 if (traits_flag == nullptr || !(IDP_int_get(traits_flag) & COMPOSIT_NODE_ASSET_STRIP_MODIFIER))
63 {
64 return false;
65 }
66 return true;
67 };
71 library, C, type_filter, meta_data_filter, ntreeType_Composite->asset_catalog_path_prefix);
72}
73
75{
76 static asset::AssetItemTree tree;
77 return &tree;
78}
79
80static void catalog_assets_draw(const bContext *C, Menu *menu)
81{
83
84 const std::optional<StringRefNull> menu_path = CTX_data_string_get(C, "asset_catalog_path");
85 if (!menu_path) {
86 return;
87 }
89 menu_path->data());
90 const asset_system::AssetCatalogTreeItem *catalog_item = tree.catalogs.find_item(
91 menu_path->data());
92 BLI_assert(catalog_item != nullptr);
93
94 if (assets.is_empty() && !catalog_item->has_children()) {
95 return;
96 }
97
98 ui::Layout &layout = *menu->layout;
99
100 bool first = true;
101 const auto ensure_separator = [&]() {
102 if (first) {
103 layout.separator();
104 first = false;
105 }
106 };
107
108 wmOperatorType *ot = WM_operatortype_find("SEQUENCER_OT_strip_modifier_add_node_group", true);
109 for (const asset_system::AssetRepresentation *asset : assets) {
110 ensure_separator();
112 }
113
114 catalog_item->foreach_child([&](const asset_system::AssetCatalogTreeItem &item) {
115 ensure_separator();
116 asset::draw_menu_for_catalog(item, "SEQUENCER_MT_add_modifier_catalog_assets", layout);
117 });
118}
119
120static bool unassigned_local_poll(const Main &bmain)
121{
122 for (const bNodeTree &group : bmain.nodetrees) {
123 /* Assets are displayed in other menus, and non-local data-blocks aren't added to this menu. */
124 if (ID_IS_ASSET(&group.id)) {
125 continue;
126 }
127 if (!group.compositor_node_asset_traits ||
129 {
130 continue;
131 }
132 return true;
133 }
134 return false;
135}
136
137static void unassigned_assets_draw(const bContext *C, Menu *menu)
138{
139 Main &bmain = *CTX_data_main(C);
141 ui::Layout &layout = *menu->layout;
142 wmOperatorType *ot = WM_operatortype_find("SEQUENCER_OT_strip_modifier_add_node_group", true);
145 }
146
147 bool first = true;
148 bool add_separator = !tree.unassigned_assets.is_empty();
149 for (const bNodeTree &group : bmain.nodetrees) {
150 /* Assets are displayed in other menus, and non-local data-blocks aren't added to this menu. */
151 if (ID_IS_ASSET(&group.id)) {
152 continue;
153 }
154 if (!group.compositor_node_asset_traits ||
156 {
157 continue;
158 }
159
160 if (add_separator) {
161 layout.separator();
162 add_separator = false;
163 }
164 if (first) {
165 layout.label(IFACE_("Non-Assets"), ICON_NONE);
166 first = false;
167 }
168
169 PointerRNA props_ptr = layout.op(
170 ot, group.id.name + 2, ICON_NONE, wm::OpCallContext::InvokeDefault, UI_ITEM_NONE);
172 }
173}
174
175static void root_catalogs_draw(const bContext *C, Menu *menu)
176{
178 Strip *strip = seq::select_active_get(scene);
179 if (!strip) {
180 return;
181 }
182 ui::Layout &layout = *menu->layout;
183
184 const bool loading_finished = all_loading_finished();
185
187 tree = build_catalog_tree(*C);
188 if (!tree.catalogs.is_empty() || loading_finished) {
189 layout.separator();
190
191 if (!loading_finished) {
192 layout.label(IFACE_("Loading Asset Libraries"), ICON_STATUS_INFO);
193 }
194
196 asset::draw_menu_for_catalog(item, "SEQUENCER_MT_add_modifier_catalog_assets", layout);
197 });
198 }
199
200 if (!tree.unassigned_assets.is_empty() || unassigned_local_poll(*CTX_data_main(C))) {
201 layout.separator();
202 layout.menu(
203 "SEQUENCER_MT_add_modifier_unassigned_assets", IFACE_("Unassigned"), ICON_FILE_HIDDEN);
204 }
205}
206
207/* -------------------------------------------------------------------- */
210
212 PointerRNA &ptr,
213 ReportList *reports)
214{
215 Main &bmain = *CTX_data_main(&C);
216 if (bNodeTree *group = reinterpret_cast<bNodeTree *>(
218 {
219 return group;
220 }
221
224 if (!asset) {
225 return nullptr;
226 }
227 return reinterpret_cast<bNodeTree *>(asset::asset_local_id_ensure_imported(bmain, *asset));
228}
229
231{
232 bNodeTree *node_group = get_asset_or_local_node_group(C, ptr, reports);
233 if (!node_group || ID_MISSING(node_group)) {
234 return nullptr;
235 }
236 if (node_group->type != NTREE_COMPOSIT) {
237 if (reports) {
238 BKE_report(reports, RPT_ERROR, "Asset is not a compositor node group");
239 }
240 return nullptr;
241 }
242 return node_group;
243}
244
246{
247 Main &bmain = *CTX_data_main(C);
249 Strip *strip = seq::select_active_get(scene);
250
251 bNodeTree *node_group = get_node_group(*C, *op->ptr, op->reports);
252 if (!node_group) {
253 return OPERATOR_CANCELLED;
254 }
255
256 auto *cmd = reinterpret_cast<SequencerCompositorModifierData *>(
258 if (!cmd) {
259 return OPERATOR_CANCELLED;
260 }
261 /* Assign the node group. */
262 cmd->node_group = node_group;
263 id_us_plus(&node_group->id);
264 /* Set the modifier name. */
265 STRNCPY_UTF8(cmd->modifier.name, DATA_(node_group->id.name + 2));
266 seq::modifier_unique_name(strip, &cmd->modifier);
267 /* Hide the datablock selector by default for assets. */
269
270 seq::modifier_persistent_uid_init(*strip, cmd->modifier);
271
273
276
277 return OPERATOR_FINISHED;
278}
279
281 wmOperatorType * /*ot*/,
282 PointerRNA *ptr)
283{
286 if (!asset) {
287 return "";
288 }
289 if (!asset->get_metadata().description) {
290 return "";
291 }
292 return TIP_(asset->get_metadata().description);
293}
294
296{
297 ot->name = "Add Strip Modifier";
298 ot->description = "Add a modifier to the strip";
299 ot->idname = "SEQUENCER_OT_strip_modifier_add_node_group";
300
304
306
309}
310
312
314{
315 MenuType type{};
316 STRNCPY_UTF8(type.idname, "SEQUENCER_MT_add_modifier_unassigned_assets");
319 type.description = N_(
320 "Modifier node group assets not assigned to a catalog.\n"
321 "Catalogs can be assigned in the Asset Browser");
322 return type;
323}
324
326{
327 MenuType type{};
328 STRNCPY_UTF8(type.idname, "SEQUENCER_MT_add_modifier_catalog_assets");
332 return type;
333}
334
336{
337 MenuType type{};
338 STRNCPY_UTF8(type.idname, "SEQUENCER_MT_modifier_add_root_catalogs");
342 return type;
343}
344
352
353} // namespace blender::ed::vse
Main runtime representation of an asset.
#define IDP_int_get(prop)
#define STRNCPY_UTF8(dst, src)
#define TIP_(msgid)
#define IFACE_(msgid)
#define DATA_(msgid)
#define ID_IS_ASSET(_id)
Definition DNA_ID.h:743
#define ID_MISSING(_id)
Definition DNA_ID.h:695
#define FILTER_ID_NT
Definition DNA_ID.h:1215
#define C
Definition RandGen.cpp:29
#define UI_ITEM_NONE
#define ND_SEQUENCER
Definition WM_types.hh:456
#define NC_SCENE
Definition WM_types.hh:391
constexpr bool is_empty() const
Definition BLI_span.hh:264
void foreach_child(ItemIterFn callback) const
void foreach_root_item(ItemIterFn callback) const
const AssetCatalogTreeItem * find_item(const AssetCatalogPath &path) const
AssetLibraryReference all_library_reference()
void all_library_reload_catalogs_if_dirty()
bool is_loaded(const AssetLibraryReference *library_reference)
void asset_reading_region_listen_fn(const wmRegionListenerParams *params)
ID * asset_local_id_ensure_imported(Main &bmain, const asset_system::AssetRepresentation &asset, int flags=0, const std::optional< eAssetImportMethod > import_method=std::nullopt, const std::optional< ImportInstantiateContext > instantiate_context=std::nullopt, ReportList *reports=nullptr)
void operator_asset_reference_props_register(StructRNA &srna)
void draw_menu_for_catalog(const asset_system::AssetCatalogTreeItem &item, const StringRefNull menu_name, ui::Layout &layout)
void draw_asset_menu_item(const asset_system::AssetRepresentation *asset, ui::Layout &layout, FunctionRef< void(ui::Layout &, BIFIconID)> draw_item_fn)
AssetItemTree build_filtered_all_catalog_tree(const AssetLibraryReference &library_ref, const bContext &C, const AssetFilterSettings &filter_settings, FunctionRef< bool(const AssetMetaData &)> meta_data_filter={}, const std::optional< StringRef > skip_prefix=std::nullopt)
const asset_system::AssetRepresentation * operator_asset_reference_props_get_asset_from_all_library(const bContext &C, PointerRNA &ptr, ReportList *reports)
static MenuType modifier_add_unassigned_assets_menu_type()
static bool unassigned_local_poll(const Main &bmain)
static void catalog_assets_draw(const bContext *C, Menu *menu)
static bNodeTree * get_asset_or_local_node_group(const bContext &C, PointerRNA &ptr, ReportList *reports)
static void unassigned_assets_draw(const bContext *C, Menu *menu)
static void root_catalogs_draw(const bContext *C, Menu *menu)
static bNodeTree * get_node_group(const bContext &C, PointerRNA &ptr, ReportList *reports)
static asset::AssetItemTree * get_static_item_tree()
static std::string strip_modifier_add_asset_get_description(bContext *C, wmOperatorType *, PointerRNA *ptr)
static MenuType modifier_add_root_catalogs_menu_type()
static void SEQUENCER_OT_strip_modifier_add_node_group(wmOperatorType *ot)
bool sequencer_strip_editable_poll(bContext *C)
static wmOperatorStatus strip_modifier_add_asset_exec(bContext *C, wmOperator *op)
static MenuType modifier_add_catalog_assets_menu_type()
static asset::AssetItemTree build_catalog_tree(const bContext &C)
void relations_invalidate_cache(Scene *scene, Strip *strip)
void modifier_persistent_uid_init(const Strip &strip, StripModifierData &smd)
void modifier_unique_name(Strip *strip, StripModifierData *smd)
void compositor_modifier_nodes_update_interface(Main &bmain, Scene &sequencer_scene, SequencerCompositorModifierData &cmd)
Strip * select_active_get(const Scene *scene)
StripModifierData * modifier_new(Strip *strip, const char *name, eStripModifierType type)
@ COMPOSIT_NODE_ASSET_STRIP_MODIFIER
BLI_assert(slot->slot_subtype.map==BMO_OP_SLOT_SUBTYPE_MAP_FLT)
void WM_operatortype_append(void(*opfunc)(wmOperatorType *))
Scene * CTX_data_sequencer_scene(const bContext *C)
void WM_operator_properties_id_lookup(wmOperatorType *ot, const bool add_name_prop)
void id_us_plus(ID *id)
Definition lib_id.cc:433
ID * WM_operator_properties_id_lookup_from_name_or_session_uid(Main *bmain, PointerRNA *ptr, const ID_Type type)
bke::bNodeTreeType * ntreeType_Composite
std::optional< StringRefNull > CTX_data_string_get(const bContext *C, const char *member)
void BKE_report(ReportList *reports, eReportType type, const char *message)
Definition report.cc:162
void WM_operator_properties_id_lookup_set_from_id(PointerRNA *ptr, const ID *id)
IDProperty * BKE_asset_metadata_idprop_find(const AssetMetaData *asset_data, const char *name) ATTR_WARN_UNUSED_RESULT
Definition asset.cc:183
@ SEQ_COMP_MOD_HIDE_DATABLOCK_SELECTOR
void WM_event_add_notifier(const bContext *C, uint type, void *reference)
wmOperatorType * WM_operatortype_find(const char *idname, bool quiet)
Main * CTX_data_main(const bContext *C)
bool WM_menutype_add(MenuType *mt)
@ OPTYPE_REGISTER
Definition WM_types.hh:188
@ OPTYPE_UNDO
Definition WM_types.hh:190
@ eSeqModifierType_Compositor
The meta-data of an asset. By creating and giving this for a data-block (ID.asset_data),...
char name[258]
Definition DNA_ID.h:433
ListBaseT< bNodeTree > nodetrees
Definition BKE_main.hh:409
char idname[BKE_ST_MAXNAME]
MenuTypeFlag flag
void(*) draw(const bContext *C, Menu *menu)
const char * description
void(*) listener(const wmRegionListenerParams *params)
ui::Layout * layout
struct CompositorNodeAssetTraits * compositor_node_asset_traits
eNodeTree_Type type
std::optional< std::string > asset_catalog_path_prefix
Definition BKE_node.hh:546
MultiValueMap< asset_system::AssetCatalogPath, asset_system::AssetRepresentation * > assets_per_path
Vector< asset_system::AssetRepresentation * > unassigned_assets
asset_system::AssetCatalogTree catalogs
void label(StringRef name, int icon)
PointerRNA op(wmOperatorType *ot, std::optional< StringRef > name, int icon, wm::OpCallContext context, eUI_Item_Flag flag)
void menu(MenuType *mt, std::optional< StringRef > name, int icon)
void separator(float factor=1.0f, LayoutSeparatorType type=LayoutSeparatorType::Auto)
wmOperatorStatus(*) exec(bContext *C, wmOperator *op) ATTR_WARN_UNUSED_RESULT
Definition WM_types.hh:1125
const char * description
Definition WM_types.hh:1115
bool(*) poll(bContext *C) ATTR_WARN_UNUSED_RESULT
Definition WM_types.hh:1165
std::string(*) get_description(bContext *C, wmOperatorType *ot, PointerRNA *ptr)
Definition WM_types.hh:1197
struct ReportList * reports
#define N_(msgid)