Blender V5.3
BKE_node_tree_interface.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
8
9#pragma once
10
12#include "DNA_node_types.h"
13
14#include "BKE_node.hh"
15
16#include <type_traits>
17
18#include "BLI_cache_mutex.hh"
19#include "BLI_vector_set.hh"
20
21namespace blender::bke {
22
24
26 friend bNodeTreeInterface;
27 friend bNodeTree;
28
29 private:
33 std::atomic<bool> interface_changed_ = true;
34
39 CacheMutex items_cache_mutex_;
40
41 /* Runtime topology cache for linear access to items. */
43
44 struct SocketIdentifierGetter {
46 {
47 return socket->identifier;
48 }
49 };
50
51 /* Socket-only lists for input/output access by index. */
54};
55
56namespace node_interface {
57
58namespace detail {
59
60template<typename T> static bool item_is_type(const bNodeTreeInterfaceItem &item)
61{
62 bool match = false;
63 switch (item.item_type) {
65 match |= std::is_same_v<T, bNodeTreeInterfaceSocket>;
66 break;
67 }
69 match |= std::is_same_v<T, bNodeTreeInterfacePanel>;
70 break;
71 }
72 }
73 return match;
74}
75
76} // namespace detail
77
78template<typename T> T &get_item_as(bNodeTreeInterfaceItem &item)
79{
81 return reinterpret_cast<T &>(item);
82}
83
84template<typename T> const T &get_item_as(const bNodeTreeInterfaceItem &item)
85{
87 return reinterpret_cast<const T &>(item);
88}
89
90template<typename T> T *get_item_as(bNodeTreeInterfaceItem *item)
91{
92 if (item && detail::item_is_type<T>(*item)) {
93 return reinterpret_cast<T *>(item);
94 }
95 return nullptr;
96}
97
98template<typename T> const T *get_item_as(const bNodeTreeInterfaceItem *item)
99{
100 if (item && detail::item_is_type<T>(*item)) {
101 return reinterpret_cast<const T *>(item);
102 }
103 return nullptr;
104}
105
106namespace socket_types {
107
108/* Info for generating static subtypes. */
116
117/* NOTE: Socket and interface subtypes could be defined from a single central list,
118 * but makesrna cannot have a dependency on BKE, so this list would have to live in RNA itself,
119 * with BKE etc. accessing the RNA API to get the subtypes info. */
121 {"NodeSocketFloat", "NodeTreeInterfaceSocketFloat", SOCK_FLOAT, PROP_NONE},
122 {"NodeSocketFloatUnsigned", "NodeTreeInterfaceSocketFloatUnsigned", SOCK_FLOAT, PROP_UNSIGNED},
123 {"NodeSocketFloatPercentage",
124 "NodeTreeInterfaceSocketFloatPercentage",
127 {"NodeSocketFloatFactor", "NodeTreeInterfaceSocketFloatFactor", SOCK_FLOAT, PROP_FACTOR},
128 {"NodeSocketFloatMass", "NodeTreeInterfaceSocketFloatMass", SOCK_FLOAT, PROP_MASS},
129 {"NodeSocketFloatAngle", "NodeTreeInterfaceSocketFloatAngle", SOCK_FLOAT, PROP_ANGLE},
130 {"NodeSocketFloatTime", "NodeTreeInterfaceSocketFloatTime", SOCK_FLOAT, PROP_TIME},
131 {"NodeSocketFloatTimeAbsolute",
132 "NodeTreeInterfaceSocketFloatTimeAbsolute",
135 {"NodeSocketFloatDistance", "NodeTreeInterfaceSocketFloatDistance", SOCK_FLOAT, PROP_DISTANCE},
136 {"NodeSocketFloatWavelength",
137 "NodeTreeInterfaceSocketFloatWavelength",
140 {"NodeSocketFloatColorTemperature",
141 "NodeTreeInterfaceSocketFloatColorTemperature",
144 {"NodeSocketFloatFrequency",
145 "NodeTreeInterfaceSocketFloatFrequency",
148 {"NodeSocketFloatPixel", "NodeTreeInterfaceSocketFloatPixel", SOCK_FLOAT, PROP_PIXEL},
149
150 {"NodeSocketInt", "NodeTreeInterfaceSocketInt", SOCK_INT, PROP_NONE},
151 {"NodeSocketIntUnsigned", "NodeTreeInterfaceSocketIntUnsigned", SOCK_INT, PROP_UNSIGNED},
152 {"NodeSocketIntPercentage", "NodeTreeInterfaceSocketIntPercentage", SOCK_INT, PROP_PERCENTAGE},
153 {"NodeSocketIntFactor", "NodeTreeInterfaceSocketIntFactor", SOCK_INT, PROP_FACTOR},
154 {"NodeSocketIntPixel", "NodeTreeInterfaceSocketIntPixel", SOCK_INT, PROP_PIXEL},
155
156 {"NodeSocketBool", "NodeTreeInterfaceSocketBool", SOCK_BOOLEAN, PROP_NONE},
157
158 {"NodeSocketVector", "NodeTreeInterfaceSocketVector", SOCK_VECTOR, PROP_NONE},
159 {"NodeSocketVectorFactor", "NodeTreeInterfaceSocketVectorFactor", SOCK_VECTOR, PROP_FACTOR},
160 {"NodeSocketVectorPercentage",
161 "NodeTreeInterfaceSocketVectorPercentage",
164 {"NodeSocketVectorTranslation",
165 "NodeTreeInterfaceSocketVectorTranslation",
168 {"NodeSocketVectorDirection",
169 "NodeTreeInterfaceSocketVectorDirection",
172 {"NodeSocketVectorVelocity",
173 "NodeTreeInterfaceSocketVectorVelocity",
176 {"NodeSocketVectorAcceleration",
177 "NodeTreeInterfaceSocketVectorAcceleration",
180 {"NodeSocketVectorEuler", "NodeTreeInterfaceSocketVectorEuler", SOCK_VECTOR, PROP_EULER},
181 {"NodeSocketVectorXYZ", "NodeTreeInterfaceSocketVectorXYZ", SOCK_VECTOR, PROP_XYZ},
182 {"NodeSocketVectorPixel", "NodeTreeInterfaceSocketVectorPixel", SOCK_VECTOR, PROP_PIXEL},
183
184 {"NodeSocketVector2D", "NodeTreeInterfaceSocketVector2D", SOCK_VECTOR, PROP_NONE},
185 {"NodeSocketVectorFactor2D",
186 "NodeTreeInterfaceSocketVectorFactor2D",
189 {"NodeSocketVectorPercentage2D",
190 "NodeTreeInterfaceSocketVectorPercentage2D",
193 {"NodeSocketVectorTranslation2D",
194 "NodeTreeInterfaceSocketVectorTranslation2D",
197 {"NodeSocketVectorDirection2D",
198 "NodeTreeInterfaceSocketVectorDirection2D",
201 {"NodeSocketVectorVelocity2D",
202 "NodeTreeInterfaceSocketVectorVelocity2D",
205 {"NodeSocketVectorAcceleration2D",
206 "NodeTreeInterfaceSocketVectorAcceleration2D",
209 {"NodeSocketVectorEuler2D", "NodeTreeInterfaceSocketVectorEuler2D", SOCK_VECTOR, PROP_EULER},
210 {"NodeSocketVectorXYZ2D", "NodeTreeInterfaceSocketVectorXYZ2D", SOCK_VECTOR, PROP_XYZ},
211 {"NodeSocketVectorPixel2D", "NodeTreeInterfaceSocketVectorPixel2D", SOCK_VECTOR, PROP_PIXEL},
212
213 {"NodeSocketVector4D", "NodeTreeInterfaceSocketVector4D", SOCK_VECTOR, PROP_NONE},
214 {"NodeSocketVectorFactor4D",
215 "NodeTreeInterfaceSocketVectorFactor4D",
218 {"NodeSocketVectorPercentage4D",
219 "NodeTreeInterfaceSocketVectorPercentage4D",
222 {"NodeSocketVectorTranslation4D",
223 "NodeTreeInterfaceSocketVectorTranslation4D",
226 {"NodeSocketVectorDirection4D",
227 "NodeTreeInterfaceSocketVectorDirection4D",
230 {"NodeSocketVectorVelocity4D",
231 "NodeTreeInterfaceSocketVectorVelocity4D",
234 {"NodeSocketVectorAcceleration4D",
235 "NodeTreeInterfaceSocketVectorAcceleration4D",
238 {"NodeSocketVectorEuler4D", "NodeTreeInterfaceSocketVectorEuler4D", SOCK_VECTOR, PROP_EULER},
239 {"NodeSocketVectorXYZ4D", "NodeTreeInterfaceSocketVectorXYZ4D", SOCK_VECTOR, PROP_XYZ},
240 {"NodeSocketVectorPixel4D", "NodeTreeInterfaceSocketVectorPixel4D", SOCK_VECTOR, PROP_PIXEL},
241
242 /* 2D Integer Vector types. */
243 {"NodeSocketIntVector2D", "NodeTreeInterfaceSocketIntVector2D", SOCK_INT_VECTOR, PROP_NONE},
244 {"NodeSocketIntVectorUnsigned2D",
245 "NodeTreeInterfaceSocketIntVectorUnsigned2D",
248 {"NodeSocketIntVectorPercentage2D",
249 "NodeTreeInterfaceSocketIntVectorPercentage2D",
252 {"NodeSocketIntVectorFactor2D",
253 "NodeTreeInterfaceSocketIntVectorFactor2D",
256 {"NodeSocketIntVectorPixel2D",
257 "NodeTreeInterfaceSocketIntVectorPixel2D",
259 PROP_PIXEL},
260
261 /* 3D Integer Vector types. */
262 {"NodeSocketIntVector3D", "NodeTreeInterfaceSocketIntVector3D", SOCK_INT_VECTOR, PROP_NONE},
263 {"NodeSocketIntVectorUnsigned3D",
264 "NodeTreeInterfaceSocketIntVectorUnsigned3D",
267 {"NodeSocketIntVectorPercentage3D",
268 "NodeTreeInterfaceSocketIntVectorPercentage3D",
271 {"NodeSocketIntVectorFactor3D",
272 "NodeTreeInterfaceSocketIntVectorFactor3D",
275 {"NodeSocketIntVectorPixel3D",
276 "NodeTreeInterfaceSocketIntVectorPixel3D",
278 PROP_PIXEL},
279
280 {"NodeSocketRotation", "NodeTreeInterfaceSocketRotation", SOCK_ROTATION, PROP_NONE},
281 {"NodeSocketMatrix", "NodeTreeInterfaceSocketMatrix", SOCK_MATRIX, PROP_NONE},
282
283 {"NodeSocketColor", "NodeTreeInterfaceSocketColor", SOCK_RGBA, PROP_NONE},
284 {"NodeSocketString", "NodeTreeInterfaceSocketString", SOCK_STRING, PROP_NONE},
285 {"NodeSocketStringFilePath",
286 "NodeTreeInterfaceSocketStringFilePath",
289 {"NodeSocketShader", "NodeTreeInterfaceSocketShader", SOCK_SHADER, PROP_NONE},
290 {"NodeSocketObject", "NodeTreeInterfaceSocketObject", SOCK_OBJECT, PROP_NONE},
291 {"NodeSocketImage", "NodeTreeInterfaceSocketImage", SOCK_IMAGE, PROP_NONE},
292 {"NodeSocketGeometry", "NodeTreeInterfaceSocketGeometry", SOCK_GEOMETRY, PROP_NONE},
293 {"NodeSocketCollection", "NodeTreeInterfaceSocketCollection", SOCK_COLLECTION, PROP_NONE},
294 {"NodeSocketTexture", "NodeTreeInterfaceSocketTexture", SOCK_TEXTURE, PROP_NONE},
295 {"NodeSocketMaterial", "NodeTreeInterfaceSocketMaterial", SOCK_MATERIAL, PROP_NONE},
296 {"NodeSocketMenu", "NodeTreeInterfaceSocketMenu", SOCK_MENU, PROP_NONE},
297 {"NodeSocketBundle", "NodeTreeInterfaceSocketBundle", SOCK_BUNDLE, PROP_NONE},
298 {"NodeSocketClosure", "NodeTreeInterfaceSocketClosure", SOCK_CLOSURE, PROP_NONE},
299 {"NodeSocketFont", "NodeTreeInterfaceSocketFont", SOCK_FONT, PROP_NONE},
300 {"NodeSocketScene", "NodeTreeInterfaceSocketScene", SOCK_SCENE, PROP_NONE},
301 {"NodeSocketText", "NodeTreeInterfaceSocketText", SOCK_TEXT_ID, PROP_NONE},
302 {"NodeSocketMask", "NodeTreeInterfaceSocketMask", SOCK_MASK, PROP_NONE},
303 {"NodeSocketSound", "NodeTreeInterfaceSocketSound", SOCK_SOUND, PROP_NONE},
304};
305
306template<typename Fn> bool socket_data_to_static_type(const StringRef socket_type, const Fn &fn)
307{
309 if (socket_type == info.socket_identifier) {
310 return bke::socket_data_to_static_type(info.type, fn);
311 }
312 }
313 return false;
314}
315
316} // namespace socket_types
317
318template<typename T> bool socket_data_is_type(const char *socket_type)
319{
320 bool match = false;
321 socket_types::socket_data_to_static_type(socket_type, [&match]<typename SocketDataType>() {
322 match |= std::is_same_v<T, SocketDataType>;
323 });
324 return match;
325}
326
328{
330 return *static_cast<T *>(item.socket_data);
331}
332
333template<typename T> const T &get_socket_data_as(const bNodeTreeInterfaceSocket &item)
334{
336 return *static_cast<const T *>(item.socket_data);
337}
338
348 bNodeTree &ntree,
349 const bNode &from_node,
350 const bNodeSocket &from_sock,
351 std::optional<StringRef> name = std::nullopt,
352 std::optional<eNodeSocketInOut> in_out = std::nullopt);
353
363 /* All dragged items. If a parent item is selected, its children are excluded because they are
364 * dragged implicitly. */
367};
368
370
371} // namespace node_interface
372
373} // namespace blender::bke
SIMD_FORCE_INLINE btVector3 operator()(const btVector3 &x) const
Return the transform of the vector.
Definition btTransform.h:90
#define T
static bool item_is_type(const bNodeTreeInterfaceItem &item)
bool socket_data_to_static_type(const StringRef socket_type, const Fn &fn)
static const bNodeSocketStaticTypeInfo node_socket_subtypes[]
T & get_item_as(bNodeTreeInterfaceItem &item)
void item_reference_free(bNodeTreeInterfaceItemReference *item_reference)
bool socket_data_is_type(const char *socket_type)
T & get_socket_data_as(bNodeTreeInterfaceSocket &item)
bNodeTreeInterfaceSocket * add_interface_socket_from_node(bNodeTree &ntree, const bNode &from_node, const bNodeSocket &from_sock, std::optional< StringRef > name=std::nullopt, std::optional< eNodeSocketInOut > in_out=std::nullopt)
bool socket_data_to_static_type(const eNodeSocketDatatype type, Fn &&fn)
Definition BKE_node.hh:1058
BLI_assert(slot->slot_subtype.map==BMO_OP_SLOT_SUBTYPE_MAP_FLT)
VectorSet< T, InlineBufferCapacity, DefaultProbingStrategy, CustomIDHash< T, GetIDFn >, CustomIDEqual< T, GetIDFn > > CustomIDVectorSet
@ PROP_ACCELERATION
Definition RNA_types.hh:321
@ PROP_PERCENTAGE
Definition RNA_types.hh:307
@ PROP_TIME_ABSOLUTE
Definition RNA_types.hh:311
@ PROP_FACTOR
Definition RNA_types.hh:308
@ PROP_TRANSLATION
Definition RNA_types.hh:318
@ PROP_DISTANCE
Definition RNA_types.hh:313
@ PROP_VELOCITY
Definition RNA_types.hh:320
@ PROP_FILEPATH
Definition RNA_types.hh:284
@ PROP_FREQUENCY
Definition RNA_types.hh:349
@ PROP_COLOR_TEMPERATURE
Definition RNA_types.hh:347
@ PROP_WAVELENGTH
Definition RNA_types.hh:344
@ PROP_DIRECTION
Definition RNA_types.hh:319
@ PROP_UNSIGNED
Definition RNA_types.hh:306