Blender V5.3
ED_uvedit.hh
Go to the documentation of this file.
1/* SPDX-FileCopyrightText: 2008 Blender Authors
2 *
3 * SPDX-License-Identifier: GPL-2.0-or-later */
4
8
9#pragma once
10
11#include "DNA_listBase.h"
12
13#include "BLI_function_ref.hh"
14#include "BLI_vector_list.hh"
15
16#include "BKE_customdata.hh"
17
18namespace blender {
19
20struct ARegion;
21struct ARegionType;
22struct BMEdge;
23struct BMEditMesh;
24struct BMFace;
25struct BMLoop;
26struct BMVert;
27struct BMesh;
28struct Image;
29struct ImageUser;
30struct Main;
31struct Object;
32struct Scene;
33struct SpaceImage;
34struct ToolSettings;
35struct View2D;
36struct ViewLayer;
37struct bContext;
38struct bNode;
39struct bNodeTree;
40struct wmKeyConfig;
41struct wmTimer;
42
43/* `uvedit_ops.cc` */
44
47void ED_keymap_uvedit(wmKeyConfig *keyconf);
48
53
54void ED_uvedit_foreach_uv(const Scene *scene,
55 BMesh *bm,
56 const bool skip_invisible,
57 const bool selected,
58 FunctionRef<void(float[2])> user_fn);
60 Span<Object *> objects_edit,
61 const bool skip_invisible,
62 const bool skip_nonselected,
63 FunctionRef<void(float[2])> user_fn);
64bool ED_uvedit_minmax_multi(const Scene *scene,
65 Span<Object *> objects_edit,
66 float r_min[2],
67 float r_max[2]);
68bool ED_uvedit_center_multi(const Scene *scene,
69 Span<Object *> objects_edit,
70 float r_cent[2],
71 char mode);
72
73bool ED_uvedit_center_from_pivot_ex(const Main &bmain,
74 const SpaceImage *sima,
75 Scene *scene,
76 ViewLayer *view_layer,
77 float r_center[2],
78 char mode,
79 bool *r_has_select);
80
82 int mat_nr,
83 Image **r_ima,
84 ImageUser **r_iuser,
85 const bNode **r_node,
86 const bNodeTree **r_ntree);
87void ED_object_assign_active_image(Main *bmain, Object *ob, int mat_nr, Image *ima);
88
89bool ED_uvedit_test(Object *obedit);
90
91/* `uvedit_select.cc` */
92
93namespace ed::uv {
94
109 private:
110 char uv_sticky_;
111 BMesh &bm_;
112
113 VectorList<BMVert *> bm_verts_select_;
114 VectorList<BMEdge *> bm_edges_select_;
115 VectorList<BMFace *> bm_faces_select_;
116
117 VectorList<BMVert *> bm_verts_deselect_;
118 VectorList<BMEdge *> bm_edges_deselect_;
119 VectorList<BMFace *> bm_faces_deselect_;
120
121 public:
122 UVSyncSelectFromMesh(BMesh &bm, char uv_sticky) : uv_sticky_(uv_sticky), bm_(bm) {}
124
125 static std::unique_ptr<UVSyncSelectFromMesh> create_if_needed(const ToolSettings &ts, BMesh &bm);
126 void apply();
127
128 /* Select. */
129
131 void edge_select_enable(BMEdge *f);
132 void face_select_enable(BMFace *f);
133
134 /* De-Select. */
135
139
140 /* Select set. */
141
142 void vert_select_set(BMVert *v, bool value);
143 void edge_select_set(BMEdge *f, bool value);
144 void face_select_set(BMFace *f, bool value);
145};
146
147} // namespace ed::uv
148
152
153/* Visibility and selection tests. */
154
155bool uvedit_face_visible_test_ex(const ToolSettings *ts, const BMFace *efa);
156bool uvedit_face_select_test_ex(const ToolSettings *ts, const BMesh *bm, const BMFace *efa);
157
159 const BMesh *bm,
160 const BMLoop *l,
161 const BMUVOffsets &offsets);
163 const BMesh *bm,
164 const BMLoop *l,
165 const BMUVOffsets &offsets);
166
167bool uvedit_face_visible_test(const Scene *scene, const BMFace *efa);
168bool uvedit_face_select_test(const Scene *scene, const BMesh *bm, const BMFace *efa);
169bool uvedit_edge_select_test(const Scene *scene,
170 const BMesh *bm,
171 const BMLoop *l,
172 const BMUVOffsets &offsets);
173bool uvedit_uv_select_test(const Scene *scene,
174 const BMesh *bm,
175 const BMLoop *l,
176 const BMUVOffsets &offsets);
177
178/* Low level loop selection, this ignores the selection modes. */
179
180bool uvedit_loop_vert_select_get(const ToolSettings *ts, const BMesh *bm, const BMLoop *l);
181bool uvedit_loop_edge_select_get(const ToolSettings *ts, const BMesh *bm, const BMLoop *l);
183 const BMesh *bm,
184 BMLoop *l,
185 const bool select);
187 const BMesh *bm,
188 BMLoop *l,
189 const bool select);
190
191/* Individual UV element selection functions. */
192
198void uvedit_face_select_set(const Scene *scene, BMesh *bm, BMFace *efa, bool select);
204void uvedit_edge_select_set(const Scene *scene, BMesh *bm, BMLoop *l, bool select);
210void uvedit_uv_select_set(const Scene *scene, BMesh *bm, BMLoop *l, bool select);
211
212/* Low level functions for (de)selecting individual UV elements. Ensure UV face visibility before
213 * use. */
214
215void uvedit_face_select_enable(const Scene *scene, BMesh *bm, BMFace *efa);
216void uvedit_face_select_disable(const Scene *scene, BMesh *bm, BMFace *efa);
217
218void uvedit_edge_select_enable(const Scene *scene, BMesh *bm, BMLoop *l);
219void uvedit_edge_select_disable(const Scene *scene, BMesh *bm, BMLoop *l);
220
221void uvedit_uv_select_enable(const Scene *scene, BMesh *bm, BMLoop *l);
222void uvedit_uv_select_disable(const Scene *scene, BMesh *bm, BMLoop *l);
223
224/* Sticky mode UV element selection functions. */
225
227 const Scene *scene, BMesh *bm, BMFace *efa, bool select, const BMUVOffsets &offsets);
229 const Scene *scene, BMesh *bm, BMLoop *l, bool select, const BMUVOffsets &offsets);
230
232 const Scene *scene, BMesh *bm, BMLoop *l, bool select, const BMUVOffsets &offsets);
233
234/* Low level functions for sticky element selection (sticky mode independent). Type of sticky
235 * selection is specified explicitly (using sticky_flag, except for face selection). */
236
238 const Scene *scene, BMesh *bm, BMFace *efa, const bool select, const BMUVOffsets &offsets);
246void uvedit_edge_select_shared_vert(const Scene *scene,
247 BMesh *bm,
248 BMLoop *l,
249 const bool select,
250 const int sticky_flag,
251 const BMUVOffsets &offsets);
259void uvedit_uv_select_shared_vert(const Scene *scene,
260 BMesh *bm,
261 BMLoop *l,
262 const bool select,
263 const int sticky_flag,
264 const BMUVOffsets &offsets);
265
269void uvedit_edge_select_set_noflush(const Scene *scene,
270 BMesh *bm,
271 BMLoop *l,
272 const bool select,
273 const int sticky_flag,
274 const BMUVOffsets &offsets);
275
282void ED_uvedit_selectmode_clean(const Scene *scene, Object *obedit);
286
292void ED_uvedit_selectmode_flush(const Scene *scene, BMesh *bm);
293
300void uvedit_select_flush_from_verts(const Scene *scene, BMesh *bm, bool select);
301
303 const Scene *scene,
304 Span<Object *> objects,
305 const float mval_fl[2],
306 const bool ignore_selected,
307 float *dist_sq,
308 float r_uv[2]);
309
310BMFace **ED_uvedit_selected_faces(const Scene *scene, BMesh *bm, int len_max, int *r_faces_len);
311BMLoop **ED_uvedit_selected_edges(const Scene *scene, BMesh *bm, int len_max, int *r_edges_len);
312BMLoop **ED_uvedit_selected_verts(const Scene *scene, BMesh *bm, int len_max, int *r_verts_len);
313
316
319
324char ED_uvedit_select_mode_get(const Scene *scene);
327
328/* `uvedit_unwrap_ops.cc` */
329
330void ED_uvedit_deselect_all(const Scene *scene, Object *obedit, int action);
331
332void ED_uvedit_get_aspect(Object *obedit, float *r_aspx, float *r_aspy);
333
338float ED_uvedit_get_aspect_y(Object *obedit);
339
341 const int material_index,
342 float *r_aspx,
343 float *r_aspy);
344
347
351void ED_uvedit_live_unwrap_begin(Scene *scene, Object *obedit, struct wmWindow *win_modal);
353void ED_uvedit_live_unwrap_end(bool cancel);
354
355void ED_uvedit_live_unwrap(const Scene *scene, Span<Object *> objects);
356void ED_uvedit_add_simple_uvs(Main *bmain, const Scene *scene, Object *ob);
357
358/* `uvedit_draw.cc` */
359
360void ED_image_draw_cursor(ARegion *region, const float cursor[2]);
361
362/* `uvedit_buttons.cc` */
363
365
366/* `uvedit_islands.cc` */
367
380
384int bm_mesh_calc_uv_islands(const Scene *scene,
385 BMesh *bm,
386 ListBaseT<FaceIsland> *island_list,
387 const bool only_selected_faces,
388 const bool only_selected_uvs,
389 const bool use_seams,
390 const float aspect_y,
391 const BMUVOffsets &offsets);
392
396bool uv_coords_isect_udim(const Image *image, const int udim_grid[2], const float coords[2]);
397
398} // namespace blender
CustomData interface, see also DNA_customdata_types.h.
These structs are the foundation for all linked lists in the library system.
#define C
Definition RandGen.cpp:29
NonCopyable(const NonCopyable &other)=delete
void vert_select_set(BMVert *v, bool value)
void face_select_set(BMFace *f, bool value)
UVSyncSelectFromMesh(const UVSyncSelectFromMesh &)=delete
UVSyncSelectFromMesh(BMesh &bm, char uv_sticky)
Definition ED_uvedit.hh:122
void edge_select_set(BMEdge *f, bool value)
static std::unique_ptr< UVSyncSelectFromMesh > create_if_needed(const ToolSettings &ts, BMesh &bm)
BMesh Iterators.
void ED_image_draw_cursor(ARegion *region, const float cursor[2])
void ED_uvedit_sync_uvselect_ensure_if_needed(const ToolSettings *ts, BMesh *bm)
bool uvedit_face_select_test_ex(const ToolSettings *ts, const BMesh *bm, const BMFace *efa)
void ED_uvedit_sticky_selectmode_update(bContext *C)
void ED_uvedit_get_aspect_from_material(Object *ob, const int material_index, float *r_aspx, float *r_aspy)
BMLoop * ED_uvedit_active_edge_loop_get(const ToolSettings *ts, BMesh *bm)
bool uvedit_edge_select_test(const Scene *scene, const BMesh *bm, const BMLoop *l, const BMUVOffsets &offsets)
int bm_mesh_calc_uv_islands(const Scene *scene, BMesh *bm, ListBaseT< FaceIsland > *island_list, const bool only_selected_faces, const bool only_selected_uvs, const bool use_seams, const float aspect_y, const BMUVOffsets &offsets)
void ED_uvedit_get_aspect(Object *obedit, float *r_aspx, float *r_aspy)
void ED_uvedit_foreach_uv(const Scene *scene, BMesh *bm, const bool skip_invisible, const bool selected, FunctionRef< void(float[2])> user_fn)
float ED_uvedit_get_aspect_y(Object *obedit)
void ED_uvedit_add_simple_uvs(Main *bmain, const Scene *scene, Object *ob)
ATTR_WARN_UNUSED_RESULT const BMLoop * l
void ED_uvedit_selectmode_clean_multi(bContext *C)
bool uvedit_face_visible_test(const Scene *scene, const BMFace *efa)
void ED_uvedit_buttons_register(ARegionType *art)
void ED_uvedit_select_sync_multi(bContext *C)
void ED_uvedit_active_edge_loop_set(BMesh *bm, BMLoop *l)
bool uv_coords_isect_udim(const Image *image, const int udim_grid[2], const float coords[2])
BMLoop ** ED_uvedit_selected_edges(const Scene *scene, BMesh *bm, int len_max, int *r_edges_len)
void ED_uvedit_active_vert_loop_set(BMesh *bm, BMLoop *l)
void uvedit_face_select_disable(const Scene *scene, BMesh *bm, BMFace *efa)
void ED_uvedit_selectmode_flush(const Scene *scene, BMesh *bm)
UV Select Mode Flush.
void uvedit_uv_select_set_with_sticky(const Scene *scene, BMesh *bm, BMLoop *l, bool select, const BMUVOffsets &offsets)
void uvedit_loop_vert_select_set(const ToolSettings *ts, const BMesh *bm, BMLoop *l, const bool select)
bool ED_uvedit_live_unwrap_timer_check(const wmTimer *timer)
void ED_uvedit_foreach_uv_multi(const Scene *scene, Span< Object * > objects_edit, const bool skip_invisible, const bool skip_nonselected, FunctionRef< void(float[2])> user_fn)
bool uvedit_face_visible_test_ex(const ToolSettings *ts, const BMFace *efa)
bool ED_uvedit_minmax_multi(const Scene *scene, Span< Object * > objects_edit, float r_min[2], float r_max[2])
ATTR_WARN_UNUSED_RESULT const BMVert * v
BMLoop * ED_uvedit_active_vert_loop_get(const ToolSettings *ts, BMesh *bm)
void uvedit_face_select_set_with_sticky(const Scene *scene, BMesh *bm, BMFace *efa, bool select, const BMUVOffsets &offsets)
void ED_uvedit_live_unwrap_re_solve()
bool ED_uvedit_sync_uvselect_is_valid_or_ignore(const ToolSettings *ts, const BMesh *bm)
void uvedit_edge_select_disable(const Scene *scene, BMesh *bm, BMLoop *l)
void uvedit_edge_select_set(const Scene *scene, BMesh *bm, BMLoop *l, bool select)
Select UV Edge.
bool uvedit_uv_select_test(const Scene *scene, const BMesh *bm, const BMLoop *l, const BMUVOffsets &offsets)
BMFace ** ED_uvedit_selected_faces(const Scene *scene, BMesh *bm, int len_max, int *r_faces_len)
void ED_uvedit_live_unwrap(const Scene *scene, Span< Object * > objects)
void uvedit_face_select_shared_vert(const Scene *scene, BMesh *bm, BMFace *efa, const bool select, const BMUVOffsets &offsets)
void uvedit_uv_select_enable(const Scene *scene, BMesh *bm, BMLoop *l)
void uvedit_uv_select_disable(const Scene *scene, BMesh *bm, BMLoop *l)
void ED_uvedit_select_sync_flush(const ToolSettings *ts, BMesh *bm, bool select)
void uvedit_uv_select_shared_vert(const Scene *scene, BMesh *bm, BMLoop *l, const bool select, const int sticky_flag, const BMUVOffsets &offsets)
void ED_uvedit_selectmode_clean(const Scene *scene, Object *obedit)
UV Select Mode set.
char ED_uvedit_select_mode_get(const Scene *scene)
bool ED_uvedit_center_from_pivot_ex(const Main &bmain, const SpaceImage *sima, Scene *scene, ViewLayer *view_layer, float r_center[2], char mode, bool *r_has_select)
bool uvedit_face_select_test(const Scene *scene, const BMesh *bm, const BMFace *efa)
void ED_uvedit_deselect_all(const Scene *scene, Object *obedit, int action)
bool ED_uvedit_select_island_check(const ToolSettings *ts)
void uvedit_face_select_set(const Scene *scene, BMesh *bm, BMFace *efa, bool select)
Select UV Face.
void ED_operatortypes_uvedit()
bool uvedit_loop_vert_select_get(const ToolSettings *ts, const BMesh *bm, const BMLoop *l)
bool ED_uvedit_sync_uvselect_ignore(const ToolSettings *ts)
void uvedit_loop_edge_select_set(const ToolSettings *ts, const BMesh *bm, BMLoop *l, const bool select)
void ED_uvedit_select_all(const ToolSettings *ts, BMesh *bm)
void ED_uvedit_live_unwrap_end(bool cancel)
void uvedit_edge_select_set_with_sticky(const Scene *scene, BMesh *bm, BMLoop *l, bool select, const BMUVOffsets &offsets)
void ED_keymap_uvedit(wmKeyConfig *keyconf)
void uvedit_edge_select_shared_vert(const Scene *scene, BMesh *bm, BMLoop *l, const bool select, const int sticky_flag, const BMUVOffsets &offsets)
void uvedit_edge_select_set_noflush(const Scene *scene, BMesh *bm, BMLoop *l, const bool select, const int sticky_flag, const BMUVOffsets &offsets)
void ED_operatormacros_uvedit()
void uvedit_uv_select_set(const Scene *scene, BMesh *bm, BMLoop *l, bool select)
Select UV Vertex.
void uvedit_edge_select_enable(const Scene *scene, BMesh *bm, BMLoop *l)
void ED_uvedit_live_unwrap_begin(Scene *scene, Object *obedit, struct wmWindow *win_modal)
void uvedit_face_select_enable(const Scene *scene, BMesh *bm, BMFace *efa)
bool ED_uvedit_test(Object *obedit)
Definition uvedit_ops.cc:74
bool uvedit_edge_select_test_ex(const ToolSettings *ts, const BMesh *bm, const BMLoop *l, const BMUVOffsets &offsets)
bool ED_uvedit_center_multi(const Scene *scene, Span< Object * > objects_edit, float r_cent[2], char mode)
bool uvedit_uv_select_test_ex(const ToolSettings *ts, const BMesh *bm, const BMLoop *l, const BMUVOffsets &offsets)
BMLoop ** ED_uvedit_selected_verts(const Scene *scene, BMesh *bm, int len_max, int *r_verts_len)
void uvedit_select_flush_from_verts(const Scene *scene, BMesh *bm, bool select)
void ED_object_assign_active_image(Main *bmain, Object *ob, int mat_nr, Image *ima)
bool uvedit_loop_edge_select_get(const ToolSettings *ts, const BMesh *bm, const BMLoop *l)
bool ED_uvedit_nearest_uv_multi(const View2D *v2d, const Scene *scene, Span< Object * > objects, const float mval_fl[2], const bool ignore_selected, float *dist_sq, float r_uv[2])
bool ED_object_get_active_image(Object *ob, int mat_nr, Image **r_ima, ImageUser **r_iuser, const bNode **r_node, const bNodeTree **r_ntree)
Definition uvedit_ops.cc:98
BMUVOffsets offsets
Definition ED_uvedit.hh:377
FaceIsland * next
Definition ED_uvedit.hh:369
FaceIsland * prev
Definition ED_uvedit.hh:370