Blender V5.3
bmesh_operator_api_inline.hh
Go to the documentation of this file.
1/* SPDX-FileCopyrightText: 2023 Blender Authors
2 *
3 * SPDX-License-Identifier: GPL-2.0-or-later */
4
10
11#pragma once
12
13#include "BLI_compiler_attrs.hh"
15
16#include "bmesh_class.hh"
17
19
20namespace blender {
21
22struct BMOperator;
23
24/* Tool Flag API: Tool code must never put junk in header flags (#BMHeader.hflag)
25 * instead, use this API to set flags.
26 * If you need to store a value per element, use a #GHash or a mapping slot to do it. */
27
29 short _bmo_elem_flag_test(BMesh *bm, const BMFlagLayer *oflags, const short oflag)
30{
32 return oflags[bm->toolflag_index].f & oflag;
33}
34
36 bool _bmo_elem_flag_test_bool(BMesh *bm, const BMFlagLayer *oflags, const short oflag)
37{
39 return (oflags[bm->toolflag_index].f & oflag) != 0;
40}
41
42ATTR_NONNULL(1, 2)
48
49ATTR_NONNULL(1, 2)
55
56ATTR_NONNULL(1, 2)
58{
60 if (val) {
62 }
63 else {
64 oflags[bm->toolflag_index].f &= short(~oflag);
65 }
66}
67
68ATTR_NONNULL(1, 2)
74
75ATTR_NONNULL(1, 2)
77 BMOpSlot *slot,
78 void *element,
79 const int val)
80{
81 union {
82 void *ptr;
83 int val;
84 } t = {nullptr};
85 BLI_assert(slot->slot_subtype.map == BMO_OP_SLOT_SUBTYPE_MAP_INT);
86 BMO_slot_map_insert(op, slot, element, ((void)(t.val = val), t.ptr));
87}
88
89ATTR_NONNULL(1, 2)
91 BMOpSlot *slot,
92 void *element,
93 const bool val)
94{
95 union {
96 void *ptr;
97 bool val;
98 } t = {nullptr};
99 BLI_assert(slot->slot_subtype.map == BMO_OP_SLOT_SUBTYPE_MAP_BOOL);
100 BMO_slot_map_insert(op, slot, element, ((void)(t.val = val), t.ptr));
101}
102
103ATTR_NONNULL(1, 2)
105 BMOpSlot *slot,
106 void *element,
107 const float val)
108{
109 union {
110 void *ptr;
111 float val;
112 } t = {nullptr};
113 BLI_assert(slot->slot_subtype.map == BMO_OP_SLOT_SUBTYPE_MAP_FLT);
114 BMO_slot_map_insert(op, slot, element, ((void)(t.val = val), t.ptr));
115}
116
117/* pointer versions of BMO_slot_map_float_get and BMO_slot_map_float_insert.
118 *
119 * do NOT use these for non-operator-api-allocated memory! instead
120 * use BMO_slot_map_data_get and BMO_slot_map_insert, which copies the data. */
121
122ATTR_NONNULL(1, 2)
124 BMOpSlot *slot,
125 const void *element,
126 void *val)
127{
128 BLI_assert(slot->slot_subtype.map == BMO_OP_SLOT_SUBTYPE_MAP_INTERNAL);
129 BMO_slot_map_insert(op, slot, element, val);
130}
131
132ATTR_NONNULL(1, 2)
134 BMOpSlot *slot,
135 const void *element,
136 void *val)
137{
138 BLI_assert(slot->slot_subtype.map == BMO_OP_SLOT_SUBTYPE_MAP_ELEM);
139 BMO_slot_map_insert(op, slot, element, val);
140}
141
142/* no values */
143ATTR_NONNULL(1, 2)
145{
146 BLI_assert(slot->slot_subtype.map == BMO_OP_SLOT_SUBTYPE_MAP_EMPTY);
147 BMO_slot_map_insert(op, slot, element, nullptr);
148}
149
151 bool BMO_slot_map_contains(BMOpSlot *slot, const void *element)
152{
153 BLI_assert(slot->slot_type == BMO_OP_SLOT_MAPPING);
154 return BLI_ghash_haskey(slot->data.ghash, element);
155}
156
158 void **BMO_slot_map_data_get(BMOpSlot *slot, const void *element)
159{
160
161 return BLI_ghash_lookup_p(slot->data.ghash, element);
162}
163
165 float BMO_slot_map_float_get(BMOpSlot *slot, const void *element)
166{
167 void **data;
168 BLI_assert(slot->slot_subtype.map == BMO_OP_SLOT_SUBTYPE_MAP_FLT);
169
170 data = BMO_slot_map_data_get(slot, element);
171 if (data) {
172 return *reinterpret_cast<float *>(data);
173 }
174 return 0.0f;
175}
176
178 int BMO_slot_map_int_get(BMOpSlot *slot, const void *element)
179{
180 void **data;
181 BLI_assert(slot->slot_subtype.map == BMO_OP_SLOT_SUBTYPE_MAP_INT);
182
183 data = BMO_slot_map_data_get(slot, element);
184 if (data) {
185 return *reinterpret_cast<int *>(data);
186 }
187 return 0;
188}
189
191 bool BMO_slot_map_bool_get(BMOpSlot *slot, const void *element)
192{
193 void **data;
194 BLI_assert(slot->slot_subtype.map == BMO_OP_SLOT_SUBTYPE_MAP_BOOL);
195
196 data = BMO_slot_map_data_get(slot, element);
197 if (data) {
198 return *reinterpret_cast<bool *>(data);
199 }
200 return false;
201}
202
204 void *BMO_slot_map_ptr_get(BMOpSlot *slot, const void *element)
205{
206 void **val = BMO_slot_map_data_get(slot, element);
207 BLI_assert(slot->slot_subtype.map == BMO_OP_SLOT_SUBTYPE_MAP_INTERNAL);
208 if (val) {
209 return *val;
210 }
211
212 return nullptr;
213}
214
216 void *BMO_slot_map_elem_get(BMOpSlot *slot, const void *element)
217{
218 void **val = static_cast<void **>(BMO_slot_map_data_get(slot, element));
219 BLI_assert(slot->slot_subtype.map == BMO_OP_SLOT_SUBTYPE_MAP_ELEM);
220 if (val) {
221 return *val;
222 }
223
224 return nullptr;
225}
226
227} // namespace blender
#define ATTR_WARN_UNUSED_RESULT
#define ATTR_NONNULL(...)
#define BLI_INLINE
#define BLI_assert(a)
BMesh Iterators.
BLI_assert(slot->slot_subtype.map==BMO_OP_SLOT_SUBTYPE_MAP_FLT)
@ BMO_OP_SLOT_SUBTYPE_MAP_INTERNAL
@ BMO_OP_SLOT_SUBTYPE_MAP_EMPTY
BLI_INLINE void BMO_slot_map_ptr_insert(BMOperator *op, BMOpSlot *slot, const void *element, void *val)
BLI_INLINE short _bmo_elem_flag_test(BMesh *bm, const BMFlagLayer *oflags, short oflag)
BLI_INLINE void _bmo_elem_flag_disable(BMesh *bm, BMFlagLayer *oflags, short oflag)
BLI_INLINE void BMO_slot_map_bool_insert(BMOperator *op, BMOpSlot *slot, void *element, const bool val)
BLI_INLINE void BMO_slot_map_empty_insert(BMOperator *op, BMOpSlot *slot, const void *element)
void ** BLI_ghash_lookup_p(GHash *gh, const void *key) ATTR_WARN_UNUSED_RESULT
Definition BLI_ghash.cc:749
void BMO_slot_map_insert(BMOperator *op, BMOpSlot *slot, const void *element, const void *data)
ATTR_WARN_UNUSED_RESULT const BMFlagLayer * oflags
BMesh const char void * data
BLI_INLINE void BMO_slot_map_float_insert(BMOperator *op, BMOpSlot *slot, void *element, const float val)
BLI_INLINE void _bmo_elem_flag_toggle(BMesh *bm, BMFlagLayer *oflags, short oflag)
BLI_INLINE bool _bmo_elem_flag_test_bool(BMesh *bm, const BMFlagLayer *oflags, short oflag)
BLI_INLINE void _bmo_elem_flag_set(BMesh *bm, BMFlagLayer *oflags, short oflag, int val)
BLI_INLINE void BMO_slot_map_int_insert(BMOperator *op, BMOpSlot *slot, void *element, const int val)
bool ATTR_WARN_UNUSED_RESULT
void ATTR_NONNULL(1, 2)
ATTR_WARN_UNUSED_RESULT const void * element
ATTR_WARN_UNUSED_RESULT const BMFlagLayer const short oflag
BLI_INLINE void BMO_slot_map_elem_insert(BMOperator *op, BMOpSlot *slot, const void *element, void *val)
BLI_INLINE void _bmo_elem_flag_enable(BMesh *bm, BMFlagLayer *oflags, short oflag)
bool BLI_ghash_haskey(const GHash *gh, const void *key) ATTR_WARN_UNUSED_RESULT
Definition BLI_ghash.cc:825