Blender V5.3
layer_utils.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 "BKE_collection.hh"
12#include "BKE_customdata.hh"
13#include "BKE_editmesh.hh"
14#include "BKE_layer.hh"
15#include "BKE_mesh_types.hh"
16
17#include "DNA_ID.h"
18#include "DNA_layer_types.h"
19#include "DNA_mesh_types.h"
20#include "DNA_object_types.h"
21
22namespace blender {
23
24/* -------------------------------------------------------------------- */
27
29 ViewLayer *view_layer, const View3D *v3d, const ObjectsInViewLayerParams *params)
30{
31 if (params->no_dup_data) {
32 FOREACH_SELECTED_OBJECT_BEGIN (view_layer, v3d, ob_iter) {
33 ID *id = ob_iter->data;
34 if (id) {
35 id->tag |= ID_TAG_DOIT;
36 }
37 }
39 }
40
41 Vector<Object *> objects;
42
43 FOREACH_SELECTED_OBJECT_BEGIN (view_layer, v3d, ob_iter) {
44 if (params->filter_fn) {
45 if (!params->filter_fn(ob_iter, params->filter_userdata)) {
46 continue;
47 }
48 }
49
50 if (params->no_dup_data) {
51 ID *id = ob_iter->data;
52 if (id) {
53 if (id->tag & ID_TAG_DOIT) {
54 id->tag &= ~ID_TAG_DOIT;
55 }
56 else {
57 continue;
58 }
59 }
60 }
61
62 objects.append(ob_iter);
63 }
65
66 return objects;
67}
68
70
71/* -------------------------------------------------------------------- */
74
76 const Scene *scene,
77 ViewLayer *view_layer,
78 const View3D *v3d,
79 const ObjectsInModeParams *params)
80{
81 if (params->no_dup_data) {
82 FOREACH_BASE_IN_MODE_BEGIN (&bmain, scene, view_layer, v3d, -1, params->object_mode, base_iter)
83 {
84 ID *id = base_iter->object->data;
85 if (id) {
86 id->tag |= ID_TAG_DOIT;
87 }
88 }
90 }
91
92 Vector<Base *> bases;
93
94 FOREACH_BASE_IN_MODE_BEGIN (&bmain, scene, view_layer, v3d, -1, params->object_mode, base_iter) {
95 if (params->filter_fn) {
96 if (!params->filter_fn(base_iter->object, params->filter_userdata)) {
97 continue;
98 }
99 }
100 if (params->no_dup_data) {
101 ID *id = base_iter->object->data;
102 if (id) {
103 if (id->tag & ID_TAG_DOIT) {
104 id->tag &= ~ID_TAG_DOIT;
105 }
106 else {
107 continue;
108 }
109 }
110 }
111 bases.append(base_iter);
112 }
114
115 return bases;
116}
117
119 const Main &bmain,
120 const Scene *scene,
121 ViewLayer *view_layer,
122 const View3D *v3d,
123 const ObjectsInModeParams *params)
124{
126 bmain, scene, view_layer, v3d, params);
127 Vector<Object *> objects(bases.size());
128 std::transform(
129 bases.begin(), bases.end(), objects.begin(), [](Base *base) { return base->object; });
130 return objects;
131}
132
134 const Scene *scene,
135 ViewLayer *view_layer,
136 const View3D *v3d)
137{
138 ObjectsInModeParams params = {0};
139 params.object_mode = OB_MODE_EDIT;
140 return BKE_view_layer_array_from_objects_in_mode_params(bmain, scene, view_layer, v3d, &params);
141}
142
144 const Scene *scene,
145 ViewLayer *view_layer,
146 const View3D *v3d)
147{
148 ObjectsInModeParams params = {0};
149 params.object_mode = OB_MODE_EDIT;
150 return BKE_view_layer_array_from_bases_in_mode_params(bmain, scene, view_layer, v3d, &params);
151}
152
154 const Scene *scene,
155 ViewLayer *view_layer,
156 const View3D *v3d)
157{
158 ObjectsInModeParams params = {0};
159 params.object_mode = OB_MODE_EDIT;
160 params.no_dup_data = true;
161 return BKE_view_layer_array_from_objects_in_mode_params(bmain, scene, view_layer, v3d, &params);
162}
163
165 const Scene *scene,
166 ViewLayer *view_layer,
167 const View3D *v3d)
168{
169 ObjectsInModeParams params = {0};
170 params.object_mode = OB_MODE_EDIT;
171 params.no_dup_data = true;
172 return BKE_view_layer_array_from_bases_in_mode_params(bmain, scene, view_layer, v3d, &params);
173}
174
176 const Main &bmain, const Scene *scene, ViewLayer *view_layer, const View3D *v3d)
177{
178 ObjectsInModeParams params = {0};
179 params.object_mode = OB_MODE_EDIT;
180 params.no_dup_data = true;
182 return BKE_view_layer_array_from_objects_in_mode_params(bmain, scene, view_layer, v3d, &params);
183}
184
186 const Scene *scene,
187 ViewLayer *view_layer,
188 const View3D *v3d,
189 const eObjectMode mode)
190{
191 ObjectsInModeParams params = {0};
192 params.object_mode = mode;
193 params.no_dup_data = true;
194 return BKE_view_layer_array_from_objects_in_mode_params(bmain, scene, view_layer, v3d, &params);
195}
196
198{
199 return &view_layer->object_bases;
200}
201
202ListBaseT<Base> *BKE_view_layer_object_bases_get(ViewLayer *view_layer)
203{
204 BLI_assert_msg((view_layer->flag & VIEW_LAYER_OUT_OF_SYNC) == 0,
205 "Object Bases out of sync, invoke BKE_view_layer_synced_ensure.");
207}
208
210{
211 BLI_assert_msg((view_layer->flag & VIEW_LAYER_OUT_OF_SYNC) == 0,
212 "Active Base out of sync, invoke BKE_view_layer_synced_ensure.");
213 return view_layer->basact;
214}
215
217{
218 BLI_assert_msg((view_layer->flag & VIEW_LAYER_OUT_OF_SYNC) == 0,
219 "Active Collection out of sync, invoke BKE_view_layer_synced_ensure.");
220 return view_layer->active_collection;
221}
222
224
225/* -------------------------------------------------------------------- */
228
229bool BKE_view_layer_filter_edit_mesh_has_uvs(const Object *ob, void * /*user_data*/)
230{
231 if (ob->type == OB_MESH) {
232 const Mesh *mesh = id_cast<const Mesh *>(ob->data);
233 if (const BMesh *bm = BKE_editmesh_bmesh_get(mesh)) {
235 return true;
236 }
237 }
238 }
239 return false;
240}
241
242bool BKE_view_layer_filter_edit_mesh_has_edges(const Object *ob, void * /*user_data*/)
243{
244 if (ob->type == OB_MESH) {
245 const Mesh *mesh = id_cast<const Mesh *>(ob->data);
246 if (const BMesh *bm = BKE_editmesh_bmesh_get(mesh)) {
247 if (bm->totedge != 0) {
248 return true;
249 }
250 }
251 }
252 return false;
253}
254
256 const Scene *scene,
257 ViewLayer *view_layer,
258 const View3D *v3d)
259{
260 BKE_view_layer_synced_ensure(bmain, scene, view_layer);
261 Object *ob_active = BKE_view_layer_active_object_get(view_layer);
262 Object *ob_result = nullptr;
263 FOREACH_SELECTED_OBJECT_BEGIN (view_layer, v3d, ob_iter) {
264 if (ob_iter == ob_active) {
265 continue;
266 }
267
268 if (ob_result == nullptr) {
269 ob_result = ob_iter;
270 }
271 else {
272 ob_result = nullptr;
273 break;
274 }
275 }
277 return ob_result;
278}
279
281
282/* -------------------------------------------------------------------- */
285
287{
288 Base *base = BKE_view_layer_active_base_get(const_cast<ViewLayer *>(view_layer));
289 return base ? base->object : nullptr;
290}
291
293{
295 if (ob == nullptr) {
296 return nullptr;
297 }
298 if (!(ob->mode & OB_MODE_EDIT)) {
299 return nullptr;
300 }
301 return ob;
302}
303
305
306} // namespace blender
CustomData interface, see also DNA_customdata_types.h.
#define FOREACH_BASE_IN_MODE_BEGIN(_bmain, _scene, _view_layer, _v3d, _object_type, _object_mode, _instance)
Definition BKE_layer.hh:436
#define FOREACH_BASE_IN_MODE_END
Definition BKE_layer.hh:454
#define FOREACH_SELECTED_OBJECT_BEGIN(_view_layer, _v3d, _instance)
Definition BKE_layer.hh:374
#define FOREACH_SELECTED_OBJECT_END
Definition BKE_layer.hh:386
ID and Library types, which are fundamental for SDNA.
Object is a sort of wrapper for general info.
#define BLI_assert_msg(a, msg)
int64_t size() const
void append(const T &value)
BMesh Iterators.
Object * BKE_view_layer_active_object_get(const ViewLayer *view_layer)
bool CustomData_has_layer(const CustomData *data, eCustomDataType type)
Object * BKE_view_layer_non_active_selected_object(const Main &bmain, const Scene *scene, ViewLayer *view_layer, const View3D *v3d)
Vector< Base * > BKE_view_layer_array_from_bases_in_mode_params(const Main &bmain, const Scene *scene, ViewLayer *view_layer, const View3D *v3d, const ObjectsInModeParams *params)
Base * BKE_view_layer_active_base_get(ViewLayer *view_layer)
ListBaseT< Base > * BKE_view_layer_object_bases_unsynced_get(ViewLayer *view_layer)
LayerCollection * BKE_view_layer_active_collection_get(ViewLayer *view_layer)
@ VIEW_LAYER_OUT_OF_SYNC
Object * BKE_view_layer_edit_object_get(const ViewLayer *view_layer)
Vector< Object * > BKE_view_layer_array_from_objects_in_mode_params(const Main &bmain, const Scene *scene, ViewLayer *view_layer, const View3D *v3d, const ObjectsInModeParams *params)
bool BKE_view_layer_synced_ensure(const Main &bmain, const Scene *scene, ViewLayer *view_layer)
Vector< Object * > BKE_view_layer_array_selected_objects_params(ViewLayer *view_layer, const View3D *v3d, const ObjectsInViewLayerParams *params)
Vector< Object * > BKE_view_layer_array_from_objects_in_mode_unique_data(const Main &bmain, const Scene *scene, ViewLayer *view_layer, const View3D *v3d, eObjectMode mode)
Vector< Object * > BKE_view_layer_array_from_objects_in_edit_mode(const Main &bmain, const Scene *scene, ViewLayer *view_layer, const View3D *v3d)
Vector< Object * > BKE_view_layer_array_from_objects_in_edit_mode_unique_data(const Main &bmain, const Scene *scene, ViewLayer *view_layer, const View3D *v3d)
@ ID_TAG_DOIT
Definition DNA_ID.h:1029
const BMesh * BKE_editmesh_bmesh_get(const Object *ob)
Definition editmesh.cc:65
Vector< Base * > BKE_view_layer_array_from_bases_in_edit_mode_unique_data(const Main &bmain, const Scene *scene, ViewLayer *view_layer, const View3D *v3d)
Vector< Object * > BKE_view_layer_array_from_objects_in_edit_mode_unique_data_with_uvs(const Main &bmain, const Scene *scene, ViewLayer *view_layer, const View3D *v3d)
Vector< Base * > BKE_view_layer_array_from_bases_in_edit_mode(const Main &bmain, const Scene *scene, ViewLayer *view_layer, const View3D *v3d)
bool BKE_view_layer_filter_edit_mesh_has_edges(const Object *ob, void *user_data)
bool BKE_view_layer_filter_edit_mesh_has_uvs(const Object *ob, void *user_data)
ListBaseT< Base > * BKE_view_layer_object_bases_get(ViewLayer *view_layer)
struct Object * object
bool(*) filter_fn(const Object *ob, void *user_data)
Definition BKE_layer.hh:616
bool(*) filter_fn(const Object *ob, void *user_data)
Definition BKE_layer.hh:593
eViewLayer_Flag flag
LayerCollection * active_collection
ListBaseT< Base > object_bases