Blender V5.3
MOD_uvwarp.cc
Go to the documentation of this file.
1/* SPDX-FileCopyrightText: 2023 Blender Authors
2 *
3 * SPDX-License-Identifier: GPL-2.0-or-later */
4
8
9#include <cstring>
10
11#include "BLI_utildefines.hh"
12
13#include "BLI_math_matrix_c.hh"
14#include "BLI_math_vector_c.hh"
15#include "BLI_task_c.hh"
16
17#include "BLT_translation.hh"
18
19#include "DNA_mesh_types.h"
20#include "DNA_meshdata_types.h"
21#include "DNA_object_types.h"
22#include "DNA_screen_types.h"
23
24#include "BKE_action.hh" /* BKE_pose_channel_find_name */
25#include "BKE_attribute.hh"
26#include "BKE_customdata.hh"
27#include "BKE_deform.hh"
28#include "BKE_lib_query.hh"
29#include "BKE_mesh.hh"
30#include "BKE_modifier.hh"
31
33#include "UI_resources.hh"
34
35#include "RNA_access.hh"
36#include "RNA_prototypes.hh"
37
38#include "MOD_ui_common.hh"
39#include "MOD_util.hh"
40
41namespace blender {
42
43static void uv_warp_from_mat4_pair(float uv_dst[2],
44 const float uv_src[2],
45 const float warp_mat[4][4])
46{
47 float tuv[3] = {0.0f};
48
49 copy_v2_v2(tuv, uv_src);
50 mul_m4_v3(warp_mat, tuv);
51 copy_v2_v2(uv_dst, tuv);
52}
53
54static void init_data(ModifierData *md)
55{
56 UVWarpModifierData *umd = reinterpret_cast<UVWarpModifierData *>(md);
58}
59
60static void required_data_mask(ModifierData *md, CustomData_MeshMasks *r_cddata_masks)
61{
62 UVWarpModifierData *umd = reinterpret_cast<UVWarpModifierData *>(md);
63
64 /* Ask for vertex-groups if we need them. */
65 if (umd->vgroup_name[0] != '\0') {
66 r_cddata_masks->vmask |= CD_MASK_MDEFORMVERT;
67 }
68}
69
70static void matrix_from_obj_pchan(float mat[4][4], Object *ob, const char *bonename)
71{
72 bPoseChannel *pchan = BKE_pose_channel_find_name(ob->pose, bonename);
73 if (pchan) {
74 mul_m4_m4m4(mat, ob->object_to_world().ptr(), pchan->pose_mat);
75 }
76 else {
77 copy_m4_m4(mat, ob->object_to_world().ptr());
78 }
79}
80
92
93static void uv_warp_compute(void *__restrict userdata,
94 const int i,
95 const TaskParallelTLS *__restrict /*tls*/)
96{
97 const UVWarpData *data = static_cast<const UVWarpData *>(userdata);
98 const IndexRange face = data->faces[i];
99 const Span<int> face_verts = data->corner_verts.slice(face);
100
101 float2 *mluv = &data->uv_map[face.start()];
102
103 const MDeformVert *dvert = data->dvert;
104 const int defgrp_index = data->defgrp_index;
105
106 float (*warp_mat)[4] = data->warp_mat;
107
108 int l;
109
110 if (dvert) {
111 for (l = 0; l < face.size(); l++, mluv++) {
112 const int vert_i = face_verts[l];
113 float uv[2];
114 const float weight = data->invert_vgroup ?
115 1.0f - BKE_defvert_find_weight(&dvert[vert_i], defgrp_index) :
116 BKE_defvert_find_weight(&dvert[vert_i], defgrp_index);
117
118 uv_warp_from_mat4_pair(uv, (*mluv), warp_mat);
119 interp_v2_v2v2((*mluv), (*mluv), uv, weight);
120 }
121 }
122 else {
123 for (l = 0; l < face.size(); l++, mluv++) {
124 uv_warp_from_mat4_pair(*mluv, *mluv, warp_mat);
125 }
126 }
127}
128
130{
131 UVWarpModifierData *umd = reinterpret_cast<UVWarpModifierData *>(md);
132 const MDeformVert *dvert;
133 int defgrp_index;
134 float warp_mat[4][4];
135 const int axis_u = umd->axis_u;
136 const int axis_v = umd->axis_v;
137 const bool invert_vgroup = (umd->flag & MOD_UVWARP_INVERT_VGROUP) != 0;
138
139 /* make sure there are UV Maps available */
140 if (mesh->uv_map_names().is_empty()) {
141 return mesh;
142 }
143
144 if (!ELEM(nullptr, umd->object_src, umd->object_dst)) {
145 float mat_src[4][4];
146 float mat_dst[4][4];
147 float imat_dst[4][4];
148 float shuf_mat[4][4];
149
150 /* make sure anything moving UVs is available */
151 matrix_from_obj_pchan(mat_src, umd->object_src, umd->bone_src);
152 matrix_from_obj_pchan(mat_dst, umd->object_dst, umd->bone_dst);
153
154 invert_m4_m4(imat_dst, mat_dst);
155 mul_m4_m4m4(warp_mat, imat_dst, mat_src);
156
157 /* apply warp */
158 if (!is_zero_v2(umd->center)) {
159 float mat_cent[4][4];
160 float imat_cent[4][4];
161
162 unit_m4(mat_cent);
163 mat_cent[3][axis_u] = umd->center[0];
164 mat_cent[3][axis_v] = umd->center[1];
165
166 invert_m4_m4(imat_cent, mat_cent);
167
168 mul_m4_m4m4(warp_mat, warp_mat, imat_cent);
169 mul_m4_m4m4(warp_mat, mat_cent, warp_mat);
170 }
171
172 const int shuf_indices[4] = {axis_u, axis_v, -1, 3};
173 shuffle_m4(shuf_mat, shuf_indices);
174 mul_m4_m4m4(warp_mat, shuf_mat, warp_mat);
175 transpose_m4(shuf_mat);
176 mul_m4_m4m4(warp_mat, warp_mat, shuf_mat);
177 }
178 else {
179 unit_m4(warp_mat);
180 }
181
182 /* Apply direct 2d transform. */
183 translate_m4(warp_mat, umd->center[0], umd->center[1], 0.0f);
184 const float scale[3] = {umd->scale[0], umd->scale[1], 1.0f};
185 rescale_m4(warp_mat, scale);
186 rotate_m4(warp_mat, 'Z', umd->rotation);
187 translate_m4(warp_mat, umd->offset[0], umd->offset[1], 0.0f);
188 translate_m4(warp_mat, -umd->center[0], -umd->center[1], 0.0f);
189
190 /* make sure we're using an existing layer */
191 const StringRef uvname = mesh->uv_map_names().contains(umd->uvlayer_name) ?
192 umd->uvlayer_name :
193 mesh->active_uv_map_name();
194
195 const OffsetIndices faces = mesh->faces();
196 const Span<int> corner_verts = mesh->corner_verts();
197
198 bke::MutableAttributeAccessor attributes = mesh->attributes_for_write();
201 MOD_get_vgroup(ctx->object, mesh, umd->vgroup_name, &dvert, &defgrp_index);
202
204 data.faces = faces;
205 data.corner_verts = corner_verts;
206 data.uv_map = uv_map.span;
207 data.dvert = dvert;
208 data.defgrp_index = defgrp_index;
209 data.warp_mat = warp_mat;
210 data.invert_vgroup = invert_vgroup;
211
212 TaskParallelSettings settings;
214 settings.use_threading = (faces.size() > 1000);
215 BLI_task_parallel_range(0, faces.size(), &data, uv_warp_compute, &settings);
216
217 mesh->runtime->is_original_bmesh = false;
218
219 uv_map.finish();
220
221 return mesh;
222}
223
224static void foreach_ID_link(ModifierData *md, Object *ob, IDWalkFunc walk, void *user_data)
225{
226 UVWarpModifierData *umd = reinterpret_cast<UVWarpModifierData *>(md);
227
228 walk(user_data, ob, reinterpret_cast<ID **>(&umd->object_dst), IDWALK_CB_NOP);
229 walk(user_data, ob, reinterpret_cast<ID **>(&umd->object_src), IDWALK_CB_NOP);
230}
231
233{
234 UVWarpModifierData *umd = reinterpret_cast<UVWarpModifierData *>(md);
235
237 ctx->node, umd->object_src, umd->bone_src, "UVWarp Modifier");
239 ctx->node, umd->object_dst, umd->bone_dst, "UVWarp Modifier");
240
241 DEG_add_depends_on_transform_relation(ctx->node, "UVWarp Modifier");
242}
243
244static void panel_draw(const bContext * /*C*/, Panel *panel)
245{
246 ui::Layout &layout = *panel->layout;
247
248 PointerRNA ob_ptr;
250
251 PointerRNA warp_obj_ptr;
252 PointerRNA obj_data_ptr = RNA_pointer_get(&ob_ptr, "data");
253
254 layout.use_property_split_set(true);
255
256 layout.prop_search(ptr, "uv_layer", &obj_data_ptr, "uv_layers", std::nullopt, ICON_GROUP_UVS);
257
258 ui::Layout *col = &layout.column(false);
259 col->prop(ptr, "center", UI_ITEM_NONE, std::nullopt, ICON_NONE);
260
261 col = &layout.column(false);
262 col->prop(ptr, "axis_u", UI_ITEM_NONE, IFACE_("Axis U"), ICON_NONE);
263 col->prop(ptr, "axis_v", UI_ITEM_NONE, IFACE_("V"), ICON_NONE);
264
265 col = &layout.column(false);
266 col->prop(ptr, "object_from", UI_ITEM_NONE, std::nullopt, ICON_NONE);
267 warp_obj_ptr = RNA_pointer_get(ptr, "object_from");
268 if (warp_obj_ptr && RNA_enum_get(&warp_obj_ptr, "type") == OB_ARMATURE) {
269 PointerRNA warp_obj_data_ptr = RNA_pointer_get(&warp_obj_ptr, "data");
270 col->prop_search(ptr, "bone_from", &warp_obj_data_ptr, "bones", std::nullopt, ICON_BONE_DATA);
271 }
272
273 col->prop(ptr, "object_to", UI_ITEM_NONE, CTX_IFACE_(BLT_I18NCONTEXT_MODIFIER, "To"), ICON_NONE);
274 warp_obj_ptr = RNA_pointer_get(ptr, "object_to");
275 if (warp_obj_ptr && RNA_enum_get(&warp_obj_ptr, "type") == OB_ARMATURE) {
276 PointerRNA warp_obj_data_ptr = RNA_pointer_get(&warp_obj_ptr, "data");
277 col->prop_search(ptr, "bone_to", &warp_obj_data_ptr, "bones", std::nullopt, ICON_BONE_DATA);
278 }
279
280 modifier_vgroup_ui(layout, ptr, &ob_ptr, "vertex_group", "invert_vertex_group", std::nullopt);
281
282 modifier_error_message_draw(layout, ptr);
283}
284
285static void transform_panel_draw(const bContext * /*C*/, Panel *panel)
286{
287 ui::Layout &layout = *panel->layout;
288
290
291 layout.use_property_split_set(true);
292
293 layout.prop(ptr, "offset", UI_ITEM_NONE, std::nullopt, ICON_NONE);
294 layout.prop(ptr, "scale", UI_ITEM_NONE, std::nullopt, ICON_NONE);
295 layout.prop(ptr, "rotation", UI_ITEM_NONE, std::nullopt, ICON_NONE);
296}
297
298static void panel_register(ARegionType *region_type)
299{
302 region_type, "offset", "Transform", nullptr, transform_panel_draw, panel_type);
303}
304
306 /*idname*/ "UVWarp",
307 /*name*/ N_("UVWarp"),
308 /*struct_name*/ "UVWarpModifierData",
309 /*struct_size*/ sizeof(UVWarpModifierData),
310 /*srna*/ &RNA_UVWarpModifier,
314 /*icon*/ ICON_MOD_UVPROJECT, /* TODO: Use correct icon. */
315
316 /*copy_data*/ BKE_modifier_copydata_generic,
317
318 /*deform_verts*/ nullptr,
319 /*deform_matrices*/ nullptr,
320 /*deform_verts_EM*/ nullptr,
321 /*deform_matrices_EM*/ nullptr,
322 /*modify_mesh*/ modify_mesh,
323 /*modify_geometry_set*/ nullptr,
324
325 /*init_data*/ init_data,
326 /*required_data_mask*/ required_data_mask,
327 /*free_data*/ nullptr,
328 /*is_disabled*/ nullptr,
329 /*update_depsgraph*/ update_depsgraph,
330 /*depends_on_time*/ nullptr,
331 /*depends_on_normals*/ nullptr,
332 /*foreach_ID_link*/ foreach_ID_link,
333 /*foreach_tex_link*/ nullptr,
334 /*free_runtime_data*/ nullptr,
335 /*panel_register*/ panel_register,
336 /*blend_write*/ nullptr,
337 /*blend_read*/ nullptr,
338 /*foreach_cache*/ nullptr,
339 /*foreach_working_space_color*/ nullptr,
340};
341
342} // namespace blender
Blender kernel action and pose functionality.
CustomData interface, see also DNA_customdata_types.h.
support for deformation groups and hooks.
#define BLT_I18NCONTEXT_MODIFIER
#define CTX_IFACE_(context, msgid)
#define IFACE_(msgid)
Object is a sort of wrapper for general info.
#define UI_ITEM_NONE
#define INIT_DEFAULT_STRUCT_AFTER(struct_dst, member)
#define ELEM(...)
#define CD_MASK_MDEFORMVERT
constexpr int64_t size() const
constexpr int64_t start() const
GSpanAttributeWriter lookup_or_add_for_write_span(StringRef name, AttrDomain domain, AttrType data_type, const AttributeInit &initializer=AttributeInitDefaultValue())
float3x3 scale(float3x3 mat, float2 scale)
BMesh Iterators.
MINLINE bool is_zero_v2(const float v[2]) ATTR_WARN_UNUSED_RESULT
int RNA_enum_get(PointerRNA *ptr, const char *name)
PointerRNA * modifier_panel_get_property_pointers(Panel *panel, PointerRNA *r_ob_ptr)
BLI_INLINE void BLI_parallel_range_settings_defaults(TaskParallelSettings *settings)
ATTR_WARN_UNUSED_RESULT const BMLoop * l
MINLINE void copy_v2_v2(float r[2], const float a[2])
void MOD_get_vgroup(const Object *ob, const Mesh *mesh, const char *name, const MDeformVert **dvert, int *defgrp_index)
Definition MOD_util.cc:158
bool invert_m4_m4(float inverse[4][4], const float mat[4][4])
static void init_data(ModifierData *md)
void(*)(void *user_data, Object *ob, ID **idpoin, LibraryForeachIDCallbackFlag cb_flag) IDWalkFunc
static void update_depsgraph(tGraphSliderOp *gso)
static void foreach_ID_link(ModifierData *md, Object *ob, IDWalkFunc walk, void *user_data)
void mul_m4_m4m4(float R[4][4], const float A[4][4], const float B[4][4])
void translate_m4(float mat[4][4], float Tx, float Ty, float Tz)
void BLI_task_parallel_range(int start, int stop, void *userdata, TaskParallelRangeFunc func, const TaskParallelSettings *settings)
static void matrix_from_obj_pchan(float mat[4][4], Object *ob, const char *bonename)
Definition MOD_uvwarp.cc:70
void DEG_add_depends_on_transform_relation(DepsNodeHandle *node_handle, const char *description)
static void required_data_mask(ModifierData *, CustomData_MeshMasks *r_cddata_masks)
void mul_m4_v3(const float M[4][4], float r[3])
void modifier_error_message_draw(ui::Layout &layout, PointerRNA *ptr)
float BKE_defvert_find_weight(const MDeformVert *dvert, int defgroup)
Definition deform.cc:779
void modifier_vgroup_ui(ui::Layout &layout, PointerRNA *ptr, PointerRNA *ob_ptr, const StringRefNull vgroup_prop, const std::optional< StringRefNull > invert_vgroup_prop, const std::optional< StringRefNull > text)
VecBase< float, 2 > float2
void MOD_depsgraph_update_object_bone_relation(DepsNodeHandle *node, Object *object, const char *bonename, const char *description)
Definition MOD_util.cc:188
BMesh const char void * data
static void transform_panel_draw(const bContext *, Panel *panel)
static void panel_register(ARegionType *region_type)
void unit_m4(float m[4][4])
ModifierTypeInfo modifierType_UVWarp
static Mesh * modify_mesh(ModifierData *md, const ModifierEvalContext *ctx, Mesh *mesh)
Definition MOD_array.cc:873
@ eModifierTypeFlag_EnableInEditmode
@ eModifierTypeFlag_SupportsEditmode
@ eModifierTypeFlag_AcceptsMesh
PointerRNA RNA_pointer_get(PointerRNA *ptr, const char *name)
static void uv_warp_compute(void *__restrict userdata, const int i, const TaskParallelTLS *__restrict)
Definition MOD_uvwarp.cc:93
void rotate_m4(float mat[4][4], char axis, float angle)
void transpose_m4(float R[4][4])
void interp_v2_v2v2(float r[2], const float a[2], const float b[2], float t)
PanelType * modifier_panel_register(ARegionType *region_type, ModifierType type, PanelDrawFn draw)
void rescale_m4(float mat[4][4], const float scale[3])
static void panel_draw(const bContext *, Panel *panel)
PanelType * modifier_subpanel_register(ARegionType *region_type, const char *name, const char *label, PanelDrawFn draw_header, PanelDrawFn draw, PanelType *parent)
void copy_m4_m4(float m1[4][4], const float m2[4][4])
void shuffle_m4(float R[4][4], const int index[4])
bPoseChannel * BKE_pose_channel_find_name(const bPose *pose, const char *name)
static void uv_warp_from_mat4_pair(float uv_dst[2], const float uv_src[2], const float warp_mat[4][4])
Definition MOD_uvwarp.cc:43
void BKE_modifier_copydata_generic(const ModifierData *md, ModifierData *md_dst, int flag)
KERNEL_FEATURE_LIGHT_PASSES KERNEL_FEATURE_PATH_GUIDING float
struct bPose * pose
ui::Layout * layout
const MDeformVert * dvert
Definition MOD_uvwarp.cc:86
float(* warp_mat)[4]
Definition MOD_uvwarp.cc:89
MutableSpan< float2 > uv_map
Definition MOD_uvwarp.cc:84
OffsetIndices< int > faces
Definition MOD_uvwarp.cc:82
Span< int > corner_verts
Definition MOD_uvwarp.cc:83
void prop_search(PointerRNA *ptr, PropertyRNA *prop, PointerRNA *searchptr, PropertyRNA *searchprop, PropertyRNA *item_searchpropname, std::optional< StringRefNull > name, int icon, bool results_are_suggestions)
void use_property_split_set(bool is_sep)
void prop(PointerRNA *ptr, PropertyRNA *prop, int index, int value, eUI_Item_Flag flag, std::optional< StringRef > name_opt, int icon, std::optional< StringRef > placeholder=std::nullopt)
Layout & column(bool align)
#define N_(msgid)