Blender V5.3
MOD_uvproject.cc
Go to the documentation of this file.
1/* SPDX-FileCopyrightText: 2005 Blender Authors
2 *
3 * SPDX-License-Identifier: GPL-2.0-or-later */
4
8
9/* UV Project modifier: Generates UVs projected from an object */
10
11#include "BLI_utildefines.hh"
12
13#include "BLI_math_matrix_c.hh"
14#include "BLI_math_vector_c.hh"
15
16#include "BLT_translation.hh"
17
18#include "DNA_camera_types.h"
19#include "DNA_mesh_types.h"
20#include "DNA_object_types.h"
21#include "DNA_screen_types.h"
22
23#include "BKE_attribute.h"
24#include "BKE_attribute.hh"
25#include "BKE_camera.h"
26#include "BKE_customdata.hh"
27#include "BKE_lib_query.hh"
28#include "BKE_mesh.hh"
29#include "BKE_uvproject.h"
30
32#include "UI_resources.hh"
33
34#include "RNA_access.hh"
35#include "RNA_prototypes.hh"
36
37#include "MOD_modifiertypes.hh"
38#include "MOD_ui_common.hh"
39
40#include "MEM_guardedalloc.h"
41
43
44namespace blender {
45
46static void init_data(ModifierData *md)
47{
48 UVProjectModifierData *umd = reinterpret_cast<UVProjectModifierData *>(md);
49
51}
52
53static void required_data_mask(ModifierData * /*md*/, CustomData_MeshMasks *r_cddata_masks)
54{
55 /* ask for UV coordinates */
56 r_cddata_masks->lmask |= CD_MASK_PROP_FLOAT2;
57}
58
59static void foreach_ID_link(ModifierData *md, Object *ob, IDWalkFunc walk, void *user_data)
60{
61 UVProjectModifierData *umd = reinterpret_cast<UVProjectModifierData *>(md);
62 for (int i = 0; i < MOD_UVPROJECT_MAXPROJECTORS; i++) {
63 walk(user_data, ob, reinterpret_cast<ID **>(&umd->projectors[i]), IDWALK_CB_NOP);
64 }
65}
66
68{
69 UVProjectModifierData *umd = reinterpret_cast<UVProjectModifierData *>(md);
70 bool do_add_own_transform = false;
71 for (int i = 0; i < umd->projectors_num; i++) {
72 if (umd->projectors[i] != nullptr) {
74 ctx->node, umd->projectors[i], DEG_OB_COMP_TRANSFORM, "UV Project Modifier");
75 do_add_own_transform = true;
76 }
77 }
78 if (do_add_own_transform) {
79 DEG_add_depends_on_transform_relation(ctx->node, "UV Project Modifier");
80 }
81}
82
83struct Projector {
84 Object *ob; /* object this projector is derived from */
85 float projmat[4][4]; /* projection matrix */
86 float normal[3]; /* projector normal in world space */
87 void *uci; /* optional uv-project info (panorama projection) */
88};
89
91{
92 bke::MutableAttributeAccessor attributes = mesh.attributes_for_write();
93 if (md_name.is_empty()) {
94 const StringRef name = mesh.active_uv_map_name();
95 return attributes.lookup_or_add_for_write_span<float2>(name.is_empty() ? "Float2" : name,
97 }
100 {
101 return attribute;
102 }
104 const std::string name = BKE_attribute_calc_unique_name(owner, md_name);
106}
107
109 const ModifierEvalContext * /*ctx*/,
110 Object *ob,
111 Mesh *mesh)
112{
114 int projectors_num = 0;
115 float aspx = umd->aspectx ? umd->aspectx : 1.0f;
116 float aspy = umd->aspecty ? umd->aspecty : 1.0f;
117 float scax = umd->scalex ? umd->scalex : 1.0f;
118 float scay = umd->scaley ? umd->scaley : 1.0f;
119 bool free_uci = false;
120
121 for (int i = 0; i < umd->projectors_num; i++) {
122 if (umd->projectors[i] != nullptr) {
123 projectors[projectors_num++].ob = umd->projectors[i];
124 }
125 }
126
127 if (projectors_num == 0) {
128 return mesh;
129 }
130
132 if (!uv_attribute) {
133 return mesh;
134 }
135
136 /* calculate a projection matrix and normal for each projector */
137 for (int i = 0; i < projectors_num; i++) {
138 float tmpmat[4][4];
139 float offsetmat[4][4];
140 /* calculate projection matrix */
141 invert_m4_m4(projectors[i].projmat, projectors[i].ob->object_to_world().ptr());
142
143 projectors[i].uci = nullptr;
144
145 if (projectors[i].ob->type == OB_CAMERA) {
146 const Camera *cam = id_cast<const Camera *>(projectors[i].ob->data);
147 if (cam->type == CAM_PANO) {
148 projectors[i].uci = BKE_uvproject_camera_info(projectors[i].ob, nullptr, aspx, aspy);
150 static_cast<ProjCameraInfo *>(projectors[i].uci), scax, scay);
151 free_uci = true;
152 }
153 else {
154 CameraParams params;
155
156 /* setup parameters */
157 BKE_camera_params_init(&params);
158 BKE_camera_params_from_object(&params, projectors[i].ob);
159
160 /* Compute matrix, view-plane, etc. */
161 BKE_camera_params_compute_viewplane(&params, 1, 1, aspx, aspy);
162
163 /* scale the view-plane */
164 params.viewplane.xmin *= scax;
165 params.viewplane.xmax *= scax;
166 params.viewplane.ymin *= scay;
167 params.viewplane.ymax *= scay;
168
170 mul_m4_m4m4(tmpmat, params.winmat, projectors[i].projmat);
171 }
172 }
173 else {
174 copy_m4_m4(tmpmat, projectors[i].projmat);
175 }
176
177 unit_m4(offsetmat);
178 mul_mat3_m4_fl(offsetmat, 0.5);
179 offsetmat[3][0] = offsetmat[3][1] = offsetmat[3][2] = 0.5;
180
181 mul_m4_m4m4(projectors[i].projmat, offsetmat, tmpmat);
182
183 /* Calculate world-space projector normal (for best projector test). */
184 projectors[i].normal[0] = 0;
185 projectors[i].normal[1] = 0;
186 projectors[i].normal[2] = 1;
187 mul_mat3_m4_v3(projectors[i].ob->object_to_world().ptr(), projectors[i].normal);
188 }
189
190 const Span<float3> positions = mesh->vert_positions();
191 const OffsetIndices faces = mesh->faces();
192 const Span<int> corner_verts = mesh->corner_verts();
193 MutableSpan<float2> mloop_uv = uv_attribute.span;
194
195 /* Convert coords to world-space. */
196 Array<float3> coords(positions.size());
197 for (int64_t i = 0; i < positions.size(); i++) {
198 mul_v3_m4v3(coords[i], ob->object_to_world().ptr(), positions[i]);
199 }
200
201 /* if only one projector, project coords to UVs */
202 if (projectors_num == 1 && projectors[0].uci == nullptr) {
203 for (int64_t i = 0; i < coords.size(); i++) {
204 mul_project_m4_v3(projectors[0].projmat, coords[i]);
205 }
206 }
207
208 /* apply coords as UVs */
209 for (const int i : faces.index_range()) {
210 const IndexRange face = faces[i];
211 if (projectors_num == 1) {
212 if (projectors[0].uci) {
213 for (const int corner : face) {
214 const int vert = corner_verts[corner];
216 mloop_uv[corner], coords[vert], static_cast<ProjCameraInfo *>(projectors[0].uci));
217 }
218 }
219 else {
220 /* apply transformed coords as UVs */
221 for (const int corner : face) {
222 const int vert = corner_verts[corner];
223 copy_v2_v2(mloop_uv[corner], coords[vert]);
224 }
225 }
226 }
227 else {
228 /* multiple projectors, select the closest to face normal direction */
229 int j;
230 Projector *best_projector;
231 float best_dot;
232
233 /* get the untransformed face normal */
234 const float3 face_no = bke::mesh::face_normal_calc(positions, corner_verts.slice(face));
235
236 /* find the projector which the face points at most directly
237 * (projector normal with largest dot product is best)
238 */
239 best_dot = dot_v3v3(projectors[0].normal, face_no);
240 best_projector = &projectors[0];
241
242 for (j = 1; j < projectors_num; j++) {
243 float tmp_dot = dot_v3v3(projectors[j].normal, face_no);
244 if (tmp_dot > best_dot) {
245 best_dot = tmp_dot;
246 best_projector = &projectors[j];
247 }
248 }
249
250 if (best_projector->uci) {
251 for (const int corner : face) {
252 const int vert = corner_verts[corner];
254 mloop_uv[corner], coords[vert], static_cast<ProjCameraInfo *>(best_projector->uci));
255 }
256 }
257 else {
258 for (const int corner : face) {
259 const int vert = corner_verts[corner];
260 mul_v2_project_m4_v3(mloop_uv[corner], best_projector->projmat, coords[vert]);
261 }
262 }
263 }
264 }
265
266 if (free_uci) {
267 int j;
268 for (j = 0; j < projectors_num; j++) {
269 if (projectors[j].uci) {
270 MEM_delete_void(projectors[j].uci);
271 }
272 }
273 }
274
275 uv_attribute.finish();
276
277 mesh->runtime->is_original_bmesh = false;
278
279 return mesh;
280}
281
283{
284 Mesh *result;
285 UVProjectModifierData *umd = reinterpret_cast<UVProjectModifierData *>(md);
286
287 result = uvprojectModifier_do(umd, ctx, ctx->object, mesh);
288
289 return result;
290}
291
292static void panel_draw(const bContext * /*C*/, Panel *panel)
293{
294 ui::Layout &layout = *panel->layout;
295
296 PointerRNA ob_ptr;
298
299 PointerRNA obj_data_ptr = RNA_pointer_get(&ob_ptr, "data");
300
301 layout.use_property_split_set(true);
302
303 layout.prop_search(ptr, "uv_layer", &obj_data_ptr, "uv_layers", std::nullopt, ICON_GROUP_UVS);
304
305 /* Aspect and Scale are only used for camera projectors. */
306 bool has_camera = false;
307 RNA_BEGIN (ptr, projector_ptr, "projectors") {
308 PointerRNA ob_projector = RNA_pointer_get(&projector_ptr, "object");
309 if (ob_projector && RNA_enum_get(&ob_projector, "type") == OB_CAMERA) {
310 has_camera = true;
311 break;
312 }
313 }
314 RNA_END;
315
316 ui::Layout *sub = &layout.column(true);
317 sub->active_set(has_camera);
318 sub->prop(ptr, "aspect_x", UI_ITEM_NONE, std::nullopt, ICON_NONE);
319 sub->prop(ptr, "aspect_y", UI_ITEM_NONE, IFACE_("Y"), ICON_NONE);
320
321 sub = &layout.column(true);
322 sub->active_set(has_camera);
323 sub->prop(ptr, "scale_x", UI_ITEM_NONE, std::nullopt, ICON_NONE);
324 sub->prop(ptr, "scale_y", UI_ITEM_NONE, IFACE_("Y"), ICON_NONE);
325
326 layout.prop(ptr, "projector_count", UI_ITEM_NONE, IFACE_("Projectors"), ICON_NONE);
327 RNA_BEGIN (ptr, projector_ptr, "projectors") {
328 layout.prop(&projector_ptr, "object", UI_ITEM_NONE, std::nullopt, ICON_NONE);
329 }
330 RNA_END;
331
332 modifier_error_message_draw(layout, ptr);
333}
334
335static void panel_register(ARegionType *region_type)
336{
338}
339
341 /*idname*/ "UVProject",
342 /*name*/ N_("UVProject"),
343 /*struct_name*/ "UVProjectModifierData",
344 /*struct_size*/ sizeof(UVProjectModifierData),
345 /*srna*/ &RNA_UVProjectModifier,
349 /*icon*/ ICON_MOD_UVPROJECT,
350
351 /*copy_data*/ BKE_modifier_copydata_generic,
352
353 /*deform_verts*/ nullptr,
354 /*deform_matrices*/ nullptr,
355 /*deform_verts_EM*/ nullptr,
356 /*deform_matrices_EM*/ nullptr,
357 /*modify_mesh*/ modify_mesh,
358 /*modify_geometry_set*/ nullptr,
359
360 /*init_data*/ init_data,
361 /*required_data_mask*/ required_data_mask,
362 /*free_data*/ nullptr,
363 /*is_disabled*/ nullptr,
364 /*update_depsgraph*/ update_depsgraph,
365 /*depends_on_time*/ nullptr,
366 /*depends_on_normals*/ nullptr,
367 /*foreach_ID_link*/ foreach_ID_link,
368 /*foreach_tex_link*/ nullptr,
369 /*free_runtime_data*/ nullptr,
370 /*panel_register*/ panel_register,
371 /*blend_write*/ nullptr,
372 /*blend_read*/ nullptr,
373 /*foreach_cache*/ nullptr,
374 /*foreach_working_space_color*/ nullptr,
375};
376
377} // namespace blender
Generic geometry attributes built on CustomData.
Camera data-block and utility functions.
CustomData interface, see also DNA_customdata_types.h.
#define IFACE_(msgid)
#define MOD_UVPROJECT_MAXPROJECTORS
Object is a sort of wrapper for general info.
Read Blender memory allocation and freeing.
#define RNA_BEGIN(sptr, itemptr, propname)
#define RNA_END
#define UI_ITEM_NONE
#define INIT_DEFAULT_STRUCT_AFTER(struct_dst, member)
#define CD_MASK_PROP_FLOAT2
int64_t size() const
Definition BLI_array.hh:267
static AttributeOwner from_id(ID *id)
constexpr Span slice(int64_t start, int64_t size) const
Definition BLI_span.hh:141
constexpr int64_t size() const
Definition BLI_span.hh:256
GSpanAttributeWriter lookup_or_add_for_write_span(StringRef name, AttrDomain domain, AttrType data_type, const AttributeInit &initializer=AttributeInitDefaultValue())
constexpr bool is_empty() const
#define attribute(slot)
float3 face_normal_calc(Span< float3 > vert_positions, Span< int > face_verts)
BMesh Iterators.
__int64 int64_t
Definition BKE_text.h:90
int RNA_enum_get(PointerRNA *ptr, const char *name)
PointerRNA * modifier_panel_get_property_pointers(Panel *panel, PointerRNA *r_ob_ptr)
void BKE_uvproject_camera_info_scale(ProjCameraInfo *uci, float scale_x, float scale_y)
Definition uvproject.cc:197
void mul_v3_m4v3(float r[3], const float mat[4][4], const float vec[3])
MINLINE void copy_v2_v2(float r[2], const float a[2])
void mul_project_m4_v3(const float mat[4][4], float vec[3])
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)
void mul_mat3_m4_fl(float R[4][4], float f)
void BKE_camera_params_compute_viewplane(CameraParams *params, int winx, int winy, float aspx, float aspy)
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 BKE_uvproject_from_camera(float target[2], const float source[3], const struct ProjCameraInfo *uci)
void DEG_add_object_relation(DepsNodeHandle *node_handle, Object *object, eDepsObjectComponentType component, const char *description)
std::string BKE_attribute_calc_unique_name(const AttributeOwner &owner, StringRef name)
void DEG_add_depends_on_transform_relation(DepsNodeHandle *node_handle, const char *description)
void MEM_delete_void(void *vmemh)
static void required_data_mask(ModifierData *, CustomData_MeshMasks *r_cddata_masks)
void BKE_camera_params_compute_matrix(CameraParams *params)
void modifier_error_message_draw(ui::Layout &layout, PointerRNA *ptr)
VecBase< float, 2 > float2
static bke::SpanAttributeWriter< float2 > get_uv_attribute(Mesh &mesh, const StringRef md_name)
static void panel_register(ARegionType *region_type)
void BKE_camera_params_from_object(CameraParams *params, const struct Object *cam_ob)
void unit_m4(float m[4][4])
static Mesh * modify_mesh(ModifierData *md, const ModifierEvalContext *ctx, Mesh *mesh)
Definition MOD_array.cc:873
@ eModifierTypeFlag_SupportsMapping
@ eModifierTypeFlag_EnableInEditmode
@ eModifierTypeFlag_SupportsEditmode
@ eModifierTypeFlag_AcceptsMesh
PointerRNA RNA_pointer_get(PointerRNA *ptr, const char *name)
void mul_mat3_m4_v3(const float mat[4][4], float r[3])
static Mesh * uvprojectModifier_do(UVProjectModifierData *umd, const ModifierEvalContext *, Object *ob, Mesh *mesh)
PanelType * modifier_panel_register(ARegionType *region_type, ModifierType type, PanelDrawFn draw)
ModifierTypeInfo modifierType_UVProject
static void panel_draw(const bContext *, Panel *panel)
void copy_m4_m4(float m1[4][4], const float m2[4][4])
VecBase< float, 3 > float3
void BKE_camera_params_init(CameraParams *params)
MINLINE float dot_v3v3(const float a[3], const float b[3]) ATTR_WARN_UNUSED_RESULT
void mul_v2_project_m4_v3(float r[2], const float mat[4][4], const float vec[3])
struct ProjCameraInfo * BKE_uvproject_camera_info(const struct Object *ob, const float rotmat[4][4], float winx, float winy)
void BKE_modifier_copydata_generic(const ModifierData *md, ModifierData *md_dst, int flag)
ui::Layout * layout
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)
void active_set(bool active)
Layout & column(bool align)
#define N_(msgid)