Blender V5.3
node_type.h
Go to the documentation of this file.
1/* SPDX-FileCopyrightText: 2011-2022 Blender Foundation
2 *
3 * SPDX-License-Identifier: Apache-2.0 */
4
5#pragma once
6
7#include <bitset>
8
9#include "graph/node_enum.h"
10
11#include "util/array.h" // IWYU pragma: keep
12#include "util/map.h"
13#include "util/param.h"
14#include "util/thread.h"
15#include "util/types.h"
16#include "util/unique_ptr.h"
17#include "util/vector.h"
18
20
21struct Node;
22struct NodeType;
23
24using SocketModifiedFlags = std::bitset<128>;
25
26/* Socket Type */
27
28struct SocketType {
62
63 enum Flags {
64 LINKABLE = (1 << 0),
65 ANIMATABLE = (1 << 1),
66
67 SVM_INTERNAL = (1 << 2),
68 OSL_INTERNAL = (1 << 3),
69 INTERNAL = (1 << 2) | (1 << 3),
70
73 LINK_TEXTURE_UV = (1 << 6),
75 LINK_INCOMING = (1 << 8),
76 LINK_NORMAL = (1 << 9),
77 LINK_POSITION = (1 << 10),
78 LINK_TANGENT = (1 << 11),
80 DEFAULT_LINK_MASK = (1 << 4) | (1 << 5) | (1 << 6) | (1 << 7) | (1 << 8) | (1 << 9) |
81 (1 << 10) | (1 << 11) | (1 << 12)
82 };
83
84 ustring name;
86 int struct_offset = -1;
87 const void *default_value = nullptr;
88 const NodeEnum *enum_values = nullptr;
89 const NodeType *node_type = nullptr;
90 int flags = 0;
91 ustring ui_name;
92 uint8_t modified_flag_bit = 0;
93
94 size_t storage_size() const;
95 size_t packed_size() const;
96 bool is_array() const;
97 static size_t size(Type type, bool packed);
98 static size_t max_size();
99 static ustring type_name(Type type);
100 static void *zero_default_value();
101 static bool is_float3(Type type);
102};
103
104/* Node Type */
105
106struct NodeType {
107 enum Type { NONE, SHADER };
108
109 explicit NodeType(Type type = NONE, const NodeType *base = nullptr);
111
112 void register_input(ustring name,
113 ustring ui_name,
115 const int struct_offset,
116 const void *default_value,
117 const NodeEnum *enum_values = nullptr,
118 const NodeType *node_type = nullptr,
119 int flags = 0,
120 int extra_flags = 0);
121 void register_output(ustring name, ustring ui_name, SocketType::Type type);
122
123 const SocketType *find_input(ustring name) const;
124 const SocketType *find_output(ustring name) const;
125
127
128 ustring name;
134
135 static NodeType *add(const char *name,
137 Type type = NONE,
138 const NodeType *base = nullptr);
139 static const NodeType *find(ustring name);
141
142 static bool register_on_init(const NodeType *(*init_func)());
143};
144
145/* Node Definition Macros
146 *
147 * Node we use accessor to get node types to ensure correct static
148 * initialization order. */
149
150#define NODE_DECLARE \
151 static const NodeType *get_node_type(); \
152 template<typename T> static const NodeType *register_type(); \
153 static unique_ptr<Node> create(const NodeType *type); \
154 static const NodeType *node_type_; \
155 static thread_mutex node_type_mutex_;
156
157#define NODE_DEFINE(structname) \
158 const NodeType *structname::node_type_ = nullptr; \
159 thread_mutex structname::node_type_mutex_; \
160 static bool structname##_register_on_init = NodeType::register_on_init( \
161 structname::get_node_type); \
162 unique_ptr<Node> structname::create(const NodeType *) \
163 { \
164 return make_unique<structname>(); \
165 } \
166 const NodeType *structname::get_node_type() \
167 { \
168 if (node_type_ == nullptr) { \
169 thread_scoped_lock lock(node_type_mutex_); \
170 if (node_type_ == nullptr) { \
171 node_type_ = structname::register_type<structname>(); \
172 } \
173 } \
174 return node_type_; \
175 } \
176 template<typename T> const NodeType *structname::register_type()
177
178#define NODE_ABSTRACT_DECLARE \
179 template<typename T> static const NodeType *register_base_type(); \
180 static const NodeType *get_node_base_type();
181
182#define NODE_ABSTRACT_DEFINE(structname) \
183 const NodeType *structname::get_node_base_type() \
184 { \
185 /* Base types constructed in this getter to ensure correct initialization \
186 * order. Regular types are not so they are auto-registered for XML parsing. */ \
187 static const NodeType *node_base_type = register_base_type<structname>(); \
188 return node_base_type; \
189 } \
190 template<typename T> const NodeType *structname::register_base_type()
191
192/* Sock Definition Macros */
193
194#define SOCKET_OFFSETOF(T, name) offsetof(T, name)
195#define SOCKET_SIZEOF(T, name) (sizeof(T::name))
196#define SOCKET_DEFINE(name, ui_name, default_value, datatype, TYPE, flags, ...) \
197 { \
198 static datatype defval = default_value; \
199 static_assert(std::is_same_v<decltype(T::name), datatype>); \
200 type->register_input(ustring(#name), \
201 ustring(ui_name), \
202 TYPE, \
203 SOCKET_OFFSETOF(T, name), \
204 &defval, \
205 nullptr, \
206 nullptr, \
207 flags, \
208 ##__VA_ARGS__); \
209 }
210
211#define SOCKET_BOOLEAN(name, ui_name, default_value, ...) \
212 SOCKET_DEFINE(name, ui_name, default_value, bool, SocketType::BOOLEAN, 0, ##__VA_ARGS__)
213#define SOCKET_INT(name, ui_name, default_value, ...) \
214 SOCKET_DEFINE(name, ui_name, default_value, int, SocketType::INT, 0, ##__VA_ARGS__)
215#define SOCKET_UINT(name, ui_name, default_value, ...) \
216 SOCKET_DEFINE(name, ui_name, default_value, uint, SocketType::UINT, 0, ##__VA_ARGS__)
217#define SOCKET_UINT64(name, ui_name, default_value, ...) \
218 SOCKET_DEFINE(name, ui_name, default_value, uint64_t, SocketType::UINT64, 0, ##__VA_ARGS__)
219#define SOCKET_FLOAT(name, ui_name, default_value, ...) \
220 SOCKET_DEFINE(name, ui_name, default_value, float, SocketType::FLOAT, 0, ##__VA_ARGS__)
221#define SOCKET_COLOR(name, ui_name, default_value, ...) \
222 SOCKET_DEFINE(name, ui_name, default_value, float3, SocketType::COLOR, 0, ##__VA_ARGS__)
223#define SOCKET_VECTOR(name, ui_name, default_value, ...) \
224 SOCKET_DEFINE(name, ui_name, default_value, float3, SocketType::VECTOR, 0, ##__VA_ARGS__)
225#define SOCKET_POINT(name, ui_name, default_value, ...) \
226 SOCKET_DEFINE(name, ui_name, default_value, float3, SocketType::POINT, 0, ##__VA_ARGS__)
227#define SOCKET_NORMAL(name, ui_name, default_value, ...) \
228 SOCKET_DEFINE(name, ui_name, default_value, float3, SocketType::NORMAL, 0, ##__VA_ARGS__)
229#define SOCKET_POINT2(name, ui_name, default_value, ...) \
230 SOCKET_DEFINE(name, ui_name, default_value, float2, SocketType::POINT2, 0, ##__VA_ARGS__)
231#define SOCKET_STRING(name, ui_name, default_value, ...) \
232 SOCKET_DEFINE(name, ui_name, default_value, ustring, SocketType::STRING, 0, ##__VA_ARGS__)
233#define SOCKET_TRANSFORM(name, ui_name, default_value, ...) \
234 SOCKET_DEFINE(name, ui_name, default_value, Transform, SocketType::TRANSFORM, 0, ##__VA_ARGS__)
235#define SOCKET_ENUM(name, ui_name, values, default_value, ...) \
236 { \
237 static int defval = default_value; \
238 assert(SOCKET_SIZEOF(T, name) == sizeof(int)); \
239 type->register_input(ustring(#name), \
240 ustring(ui_name), \
241 SocketType::ENUM, \
242 SOCKET_OFFSETOF(T, name), \
243 &defval, \
244 &values, \
245 nullptr, \
246 ##__VA_ARGS__); \
247 }
248#define SOCKET_NODE(name, ui_name, node_type, ...) \
249 { \
250 static Node *defval = nullptr; \
251 assert(SOCKET_SIZEOF(T, name) == sizeof(Node *)); \
252 type->register_input(ustring(#name), \
253 ustring(ui_name), \
254 SocketType::NODE, \
255 SOCKET_OFFSETOF(T, name), \
256 (const void *)&defval, \
257 nullptr, \
258 node_type, \
259 ##__VA_ARGS__); \
260 }
261
262#define SOCKET_BOOLEAN_ARRAY(name, ui_name, default_value, ...) \
263 SOCKET_DEFINE( \
264 name, ui_name, default_value, array<bool>, SocketType::BOOLEAN_ARRAY, 0, ##__VA_ARGS__)
265#define SOCKET_INT_ARRAY(name, ui_name, default_value, ...) \
266 SOCKET_DEFINE(name, ui_name, default_value, array<int>, SocketType::INT_ARRAY, 0, ##__VA_ARGS__)
267#define SOCKET_FLOAT_ARRAY(name, ui_name, default_value, ...) \
268 SOCKET_DEFINE( \
269 name, ui_name, default_value, array<float>, SocketType::FLOAT_ARRAY, 0, ##__VA_ARGS__)
270#define SOCKET_COLOR_ARRAY(name, ui_name, default_value, ...) \
271 SOCKET_DEFINE(name, \
272 ui_name, \
273 default_value, \
274 array<packed_float3>, \
275 SocketType::COLOR_ARRAY, \
276 0, \
277 ##__VA_ARGS__)
278#define SOCKET_VECTOR_ARRAY(name, ui_name, default_value, ...) \
279 SOCKET_DEFINE(name, \
280 ui_name, \
281 default_value, \
282 array<packed_float3>, \
283 SocketType::VECTOR_ARRAY, \
284 0, \
285 ##__VA_ARGS__)
286#define SOCKET_POINT_ARRAY(name, ui_name, default_value, ...) \
287 SOCKET_DEFINE(name, \
288 ui_name, \
289 default_value, \
290 array<packed_float3>, \
291 SocketType::POINT_ARRAY, \
292 0, \
293 ##__VA_ARGS__)
294#define SOCKET_NORMAL_ARRAY(name, ui_name, default_value, ...) \
295 SOCKET_DEFINE(name, \
296 ui_name, \
297 default_value, \
298 array<packed_float3>, \
299 SocketType::NORMAL_ARRAY, \
300 0, \
301 ##__VA_ARGS__)
302#define SOCKET_POINT2_ARRAY(name, ui_name, default_value, ...) \
303 SOCKET_DEFINE( \
304 name, ui_name, default_value, array<float2>, SocketType::POINT2_ARRAY, 0, ##__VA_ARGS__)
305#define SOCKET_STRING_ARRAY(name, ui_name, default_value, ...) \
306 SOCKET_DEFINE( \
307 name, ui_name, default_value, array<ustring>, SocketType::STRING_ARRAY, 0, ##__VA_ARGS__)
308#define SOCKET_TRANSFORM_ARRAY(name, ui_name, default_value, ...) \
309 SOCKET_DEFINE(name, \
310 ui_name, \
311 default_value, \
312 array<Transform>, \
313 SocketType::TRANSFORM_ARRAY, \
314 0, \
315 ##__VA_ARGS__)
316#define SOCKET_NODE_ARRAY(name, ui_name, node_type, ...) \
317 { \
318 static array<Node *> defval = {}; \
319 assert(SOCKET_SIZEOF(T, name) == sizeof(array<Node *>)); \
320 type->register_input(ustring(#name), \
321 ustring(ui_name), \
322 SocketType::NODE_ARRAY, \
323 SOCKET_OFFSETOF(T, name), \
324 &defval, \
325 nullptr, \
326 node_type, \
327 ##__VA_ARGS__); \
328 }
329
330#define SOCKET_IN_BOOLEAN(name, ui_name, default_value, ...) \
331 SOCKET_DEFINE(name, \
332 ui_name, \
333 default_value, \
334 bool, \
335 SocketType::BOOLEAN, \
336 SocketType::LINKABLE, \
337 ##__VA_ARGS__)
338#define SOCKET_IN_INT(name, ui_name, default_value, ...) \
339 SOCKET_DEFINE( \
340 name, ui_name, default_value, int, SocketType::INT, SocketType::LINKABLE, ##__VA_ARGS__)
341#define SOCKET_IN_FLOAT(name, ui_name, default_value, ...) \
342 SOCKET_DEFINE(name, \
343 ui_name, \
344 default_value, \
345 float, \
346 SocketType::FLOAT, \
347 SocketType::LINKABLE, \
348 ##__VA_ARGS__)
349#define SOCKET_IN_COLOR(name, ui_name, default_value, ...) \
350 SOCKET_DEFINE(name, \
351 ui_name, \
352 default_value, \
353 float3, \
354 SocketType::COLOR, \
355 SocketType::LINKABLE, \
356 ##__VA_ARGS__)
357#define SOCKET_IN_VECTOR(name, ui_name, default_value, ...) \
358 SOCKET_DEFINE(name, \
359 ui_name, \
360 default_value, \
361 float3, \
362 SocketType::VECTOR, \
363 SocketType::LINKABLE, \
364 ##__VA_ARGS__)
365#define SOCKET_IN_POINT(name, ui_name, default_value, ...) \
366 SOCKET_DEFINE(name, \
367 ui_name, \
368 default_value, \
369 float3, \
370 SocketType::POINT, \
371 SocketType::LINKABLE, \
372 ##__VA_ARGS__)
373#define SOCKET_IN_NORMAL(name, ui_name, default_value, ...) \
374 SOCKET_DEFINE(name, \
375 ui_name, \
376 default_value, \
377 float3, \
378 SocketType::NORMAL, \
379 SocketType::LINKABLE, \
380 ##__VA_ARGS__)
381#define SOCKET_IN_STRING(name, ui_name, default_value, ...) \
382 SOCKET_DEFINE(name, \
383 ui_name, \
384 default_value, \
385 ustring, \
386 SocketType::STRING, \
387 SocketType::LINKABLE, \
388 ##__VA_ARGS__)
389#define SOCKET_IN_CLOSURE(name, ui_name, ...) \
390 type->register_input(ustring(#name), \
391 ustring(ui_name), \
392 SocketType::CLOSURE, \
393 0, \
394 nullptr, \
395 nullptr, \
396 nullptr, \
397 SocketType::LINKABLE, \
398 ##__VA_ARGS__)
399
400#define SOCKET_OUT_BOOLEAN(name, ui_name) \
401 { \
402 type->register_output(ustring(#name), ustring(ui_name), SocketType::BOOLEAN); \
403 }
404#define SOCKET_OUT_INT(name, ui_name) \
405 { \
406 type->register_output(ustring(#name), ustring(ui_name), SocketType::INT); \
407 }
408#define SOCKET_OUT_FLOAT(name, ui_name) \
409 { \
410 type->register_output(ustring(#name), ustring(ui_name), SocketType::FLOAT); \
411 }
412#define SOCKET_OUT_COLOR(name, ui_name) \
413 { \
414 type->register_output(ustring(#name), ustring(ui_name), SocketType::COLOR); \
415 }
416#define SOCKET_OUT_VECTOR(name, ui_name) \
417 { \
418 type->register_output(ustring(#name), ustring(ui_name), SocketType::VECTOR); \
419 }
420#define SOCKET_OUT_POINT(name, ui_name) \
421 { \
422 type->register_output(ustring(#name), ustring(ui_name), SocketType::POINT); \
423 }
424#define SOCKET_OUT_NORMAL(name, ui_name) \
425 { \
426 type->register_output(ustring(#name), ustring(ui_name), SocketType::NORMAL); \
427 }
428#define SOCKET_OUT_CLOSURE(name, ui_name) \
429 { \
430 type->register_output(ustring(#name), ustring(ui_name), SocketType::CLOSURE); \
431 }
432#define SOCKET_OUT_STRING(name, ui_name) \
433 { \
434 type->register_output(ustring(#name), ustring(ui_name), SocketType::STRING); \
435 }
436#define SOCKET_OUT_ENUM(name, ui_name) \
437 { \
438 type->register_output(ustring(#name), ustring(ui_name), SocketType::ENUM); \
439 }
440
@ NONE
#define CCL_NAMESPACE_END
std::bitset< 128 > SocketModifiedFlags
Definition node_type.h:24
Type type
Definition node_type.h:129
vector< SocketType, std::allocator< SocketType > > inputs
Definition node_type.h:131
NodeType(Type type=NONE, const NodeType *base=nullptr)
static NodeType * add(const char *name, CreateFunc create, Type type=NONE, const NodeType *base=nullptr)
unique_ptr< Node >(*)(const NodeType *) CreateFunc
Definition node_type.h:126
const SocketType * find_output(ustring name) const
static const NodeType * find(ustring name)
CreateFunc create
Definition node_type.h:133
void register_input(ustring name, ustring ui_name, SocketType::Type type, const int struct_offset, const void *default_value, const NodeEnum *enum_values=nullptr, const NodeType *node_type=nullptr, int flags=0, int extra_flags=0)
static vector< ustring > type_names()
static bool register_on_init(const NodeType *(*init_func)())
const NodeType * base
Definition node_type.h:130
ustring name
Definition node_type.h:128
void register_output(ustring name, ustring ui_name, SocketType::Type type)
const SocketType * find_input(ustring name) const
vector< SocketType, std::allocator< SocketType > > outputs
Definition node_type.h:132
static size_t size(Type type, bool packed)
Definition node_type.cpp:30
const void * default_value
Definition node_type.h:87
ustring name
Definition node_type.h:84
const NodeType * node_type
Definition node_type.h:89
@ BOOLEAN_ARRAY
Definition node_type.h:48
@ TRANSFORM_ARRAY
Definition node_type.h:57
static size_t max_size()
Definition node_type.cpp:93
ustring ui_name
Definition node_type.h:91
Type type
Definition node_type.h:85
size_t storage_size() const
Definition node_type.cpp:15
static bool is_float3(Type type)
static ustring type_name(Type type)
static void * zero_default_value()
Definition node_type.cpp:98
@ LINK_OSL_INITIALIZER
Definition node_type.h:79
@ LINK_TEXTURE_UV
Definition node_type.h:73
@ LINK_TEXTURE_GENERATED
Definition node_type.h:71
@ LINK_INCOMING
Definition node_type.h:75
@ LINK_TEXTURE_INCOMING
Definition node_type.h:74
@ LINK_TEXTURE_NORMAL
Definition node_type.h:72
@ DEFAULT_LINK_MASK
Definition node_type.h:80
@ LINK_POSITION
Definition node_type.h:77
const NodeEnum * enum_values
Definition node_type.h:88
uint8_t modified_flag_bit
Definition node_type.h:92
size_t packed_size() const
Definition node_type.cpp:20
bool is_array() const
Definition node_type.cpp:25
int struct_offset
Definition node_type.h:86