blender
/
blender
129
397
Fork 571
Code Issues 6.2k Pull Requests 753 Projects 19 Wiki Activity

Cleanup: Move new utilities for ID lookup operator properties 

Move them to a more accessible place, so that other operators in
different files can use them. The following commit needs this.
This commit is contained in:
Julian Eisel 2022-05-23 20:32:36 +02:00
parent 02c5ca2f22
commit 0d6dda4555
3 changed files with 76 additions and 63 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

67
source/blender/editors/object/object_add.cc
View File

@ -252,65 +252,6 @@ static int object_add_drop_xy_generic_invoke(bContext *C, wmOperator *op, const
return op->type->exec(C, op);
}
/**
* Tries to find an ID in \a bmain. Three needs to be either a "name" string or "session_uuid" int
* property defined and set. The former has priority.
*
* See #id_add_lookup_props for a helper to add the properties.
*/
static ID *id_add_lookup_from_name_or_session_uuid_props(Main *bmain,
const wmOperator *op,
const ID_Type type)
{
PropertyRNA *prop_name = RNA_struct_find_property(op->ptr, "name");
PropertyRNA *prop_session_uuid = RNA_struct_find_property(op->ptr, "session_uuid");
if (prop_name && RNA_property_is_set(op->ptr, prop_name)) {
char name[MAX_ID_NAME - 2];
RNA_property_string_get(op->ptr, prop_name, name);
return BKE_libblock_find_name(bmain, type, name);
}
if (prop_session_uuid && RNA_property_is_set(op->ptr, prop_session_uuid)) {
const uint32_t session_uuid = (uint32_t)RNA_property_int_get(op->ptr, prop_session_uuid);
return BKE_libblock_find_session_uuid(bmain, type, session_uuid);
}
return nullptr;
}
/**
* Adds "name" and "session_uuid" properties to the operator so the caller can tell the operator
* which ID to add. See #id_add_find_from_name_or_session_uuid_op_props(). Both properties will be
* hidden in the UI.
*
* \note New operators should probably use "session_uuid" only (set \a add_name_prop to #false),
* since this works with linked data and/or library overrides (in both cases, multiple IDs with the
* same name and type may be present). The "name" property is only kept to not break compatibility
* with old scripts using these operators.
*/
static void id_add_lookup_props(wmOperatorType *ot, const bool add_name_prop = false)
{
PropertyRNA *prop;
if (add_name_prop) {
prop = RNA_def_string(
ot->srna, "name", nullptr, MAX_ID_NAME - 2, "Name", "Name of the data-block to add");
RNA_def_property_flag(prop, (PropertyFlag)(PROP_SKIP_SAVE | PROP_HIDDEN));
}
prop = RNA_def_int(ot->srna,
"session_uuid",
0,
INT32_MIN,
INT32_MAX,
"Session UUID",
"Session UUID of the data-block to add",
INT32_MIN,
INT32_MAX);
RNA_def_property_flag(prop, (PropertyFlag)(PROP_SKIP_SAVE | PROP_HIDDEN));
}
/** \} */
/* -------------------------------------------------------------------- */
@ -1712,7 +1653,7 @@ static std::optional<CollectionAddInfo> collection_add_info_get_from_op(bContext
PropertyRNA *prop_location = RNA_struct_find_property(op->ptr, "location");
add_info.collection = reinterpret_cast<Collection *>(
id_add_lookup_from_name_or_session_uuid_props(bmain, op, ID_GR));
WM_operator_properties_id_lookup_from_name_or_session_uuid(bmain, op, ID_GR));
bool update_location_if_necessary = false;
if (add_info.collection) {
@ -3776,7 +3717,7 @@ static int object_add_named_exec(bContext *C, wmOperator *op)
/* Find object, create fake base. */
Object *ob = reinterpret_cast<Object *>(
id_add_lookup_from_name_or_session_uuid_props(bmain, op, ID_OB));
WM_operator_properties_id_lookup_from_name_or_session_uuid(bmain, op, ID_OB));
if (ob == nullptr) {
BKE_report(op->reports, RPT_ERROR, "Object not found");
@ -3864,7 +3805,7 @@ void OBJECT_OT_add_named(wmOperatorType *ot)
"Linked",
"Duplicate object but not object data, linking to the original data");
id_add_lookup_props(ot, true);
WM_operator_properties_id_lookup(ot, true);
prop = RNA_def_float_matrix(
ot->srna, "matrix", 4, 4, nullptr, 0.0f, 0.0f, "Matrix", "", 0.0f, 0.0f);
@ -3888,7 +3829,7 @@ static int object_transform_to_mouse_exec(bContext *C, wmOperator *op)
ViewLayer *view_layer = CTX_data_view_layer(C);
Object *ob = reinterpret_cast<Object *>(
id_add_lookup_from_name_or_session_uuid_props(bmain, op, ID_OB));
WM_operator_properties_id_lookup_from_name_or_session_uuid(bmain, op, ID_OB));
if (!ob) {
ob = OBACT(view_layer);

21
source/blender/windowmanager/WM_api.h
View File

@ -770,6 +770,27 @@ void WM_operator_properties_filesel(struct wmOperatorType *ot,
eFileSel_Flag flag,
short display,
short sort);
/**
* Tries to find an ID in \a bmain. There needs to be either a "name" string or "session_uuid" int
* property defined and set. The former has priority. See #WM_operator_properties_id_lookup() for a
* helper to add the properties.
*/
struct ID *WM_operator_properties_id_lookup_from_name_or_session_uuid(struct Main *bmain,
const struct wmOperator *op,
enum ID_Type type);
/**
* Adds "name" and "session_uuid" properties so the caller can tell the operator which ID to act
* on. See #WM_operator_properties_id_lookup_from_name_or_session_uuid(). Both properties will be
* hidden in the UI and not be saved over consecutive operator calls.
*
* \note New operators should probably use "session_uuid" only (set \a add_name_prop to #false),
* since this works properly with linked data and/or library overrides (in both cases, multiple IDs
* with the same name and type may be present). The "name" property is only kept to not break
* compatibility with old scripts using some previously existing operators.
*/
void WM_operator_properties_id_lookup(wmOperatorType *ot, const bool add_name_prop);
/**
* Disable using cursor position,
* use when view operators are initialized from buttons.

51
source/blender/windowmanager/intern/wm_operator_props.c
View File

@ -8,8 +8,12 @@
* (`WM_operator_properties_*` functions).
*/
#include "DNA_ID_enums.h"
#include "DNA_space_types.h"
#include "BKE_lib_id.h"
#include "BKE_main.h"
#include "BLI_math_base.h"
#include "BLI_rect.h"
@ -222,6 +226,53 @@ void WM_operator_properties_filesel(wmOperatorType *ot,
RNA_def_property_flag(prop, PROP_HIDDEN | PROP_SKIP_SAVE);
}
ID *WM_operator_properties_id_lookup_from_name_or_session_uuid(Main *bmain,
const wmOperator *op,
const ID_Type type)
{
PropertyRNA *prop_name = RNA_struct_find_property(op->ptr, "name");
PropertyRNA *prop_session_uuid = RNA_struct_find_property(op->ptr, "session_uuid");
if (prop_name && RNA_property_is_set(op->ptr, prop_name)) {
char name[MAX_ID_NAME - 2];
RNA_property_string_get(op->ptr, prop_name, name);
return BKE_libblock_find_name(bmain, type, name);
}
if (prop_session_uuid && RNA_property_is_set(op->ptr, prop_session_uuid)) {
const uint32_t session_uuid = (uint32_t)RNA_property_int_get(op->ptr, prop_session_uuid);
return BKE_libblock_find_session_uuid(bmain, type, session_uuid);
}
return NULL;
}
void WM_operator_properties_id_lookup(wmOperatorType *ot, const bool add_name_prop)
{
PropertyRNA *prop;
if (add_name_prop) {
prop = RNA_def_string(ot->srna,
"name",
NULL,
MAX_ID_NAME - 2,
"Name",
"Name of the data-block to use by the operator");
RNA_def_property_flag(prop, (PropertyFlag)(PROP_SKIP_SAVE | PROP_HIDDEN));
}
prop = RNA_def_int(ot->srna,
"session_uuid",
0,
INT32_MIN,
INT32_MAX,
"Session UUID",
"Session UUID of the data-block to use by the operator",
INT32_MIN,
INT32_MAX);
RNA_def_property_flag(prop, (PropertyFlag)(PROP_SKIP_SAVE | PROP_HIDDEN));
}
static void wm_operator_properties_select_action_ex(wmOperatorType *ot,
int default_action,
const EnumPropertyItem *select_actions,