Blender V5.3
node_util.cc
Go to the documentation of this file.
1/* SPDX-FileCopyrightText: 2007 Blender Authors
2 *
3 * SPDX-License-Identifier: GPL-2.0-or-later */
4
8
9#include <cctype>
10#include <cstring>
11
12#include "DNA_node_types.h"
13
14#include "BLI_listbase.hh"
16#include "BLI_string.hh"
17#include "BLI_string_utf8.hh"
18#include "BLI_utildefines.hh"
19
20#include "BLT_translation.hh"
21
22#include "BKE_colortools.hh"
23#include "BKE_node.hh"
25
26#include "RNA_access.hh"
27#include "RNA_enum_types.hh"
28#include "RNA_prototypes.hh"
29
30#include "MEM_guardedalloc.h"
31
32#include "node_util.hh"
33
34namespace blender {
35
36/* -------------------------------------------------------------------- */
39
41{
42 BKE_curvemapping_free(static_cast<CurveMapping *>(node->storage));
43}
44
46{
47 if (node->storage) {
48 MEM_delete_void(node->storage);
49 }
50}
51
52void node_copy_curves(bNodeTree * /*dest_ntree*/, bNode *dest_node, const bNode *src_node)
53{
54 dest_node->storage = BKE_curvemapping_copy(static_cast<CurveMapping *>(src_node->storage));
55}
56
58 bNode *dest_node,
59 const bNode *src_node)
60{
61 dest_node->storage = MEM_dupalloc_void(src_node->storage);
62}
63
65{
66 BKE_curvemapping_init(static_cast<CurveMapping *>(node->storage));
67 return nullptr; /* unused return */
68}
69
71
72/* -------------------------------------------------------------------- */
75
76void node_sock_label(bNodeSocket *sock, const char *name)
77{
78 STRNCPY_UTF8(sock->label, name);
79}
80
82{
83 if (sock->label[0] != '\0') {
84 sock->label[0] = '\0';
85 }
86}
87
126
128
129/* -------------------------------------------------------------------- */
132
133void node_blend_label(const bNodeTree * /*ntree*/,
134 const bNode *node,
135 char *label,
136 int label_maxncpy)
137{
138 const char *name;
139 bool enum_label = RNA_enum_name(rna_enum_ramp_blend_items, node->custom1, &name);
140 if (!enum_label) {
141 name = CTX_N_(BLT_I18NCONTEXT_COLOR, "Unknown");
142 }
143 BLI_strncpy_utf8(label, CTX_IFACE_(BLT_I18NCONTEXT_COLOR, name), label_maxncpy);
144}
145
146void node_image_label(const bNodeTree * /*ntree*/,
147 const bNode *node,
148 char *label,
149 int label_maxncpy)
150{
151 if (node->id == nullptr) {
152 BLI_strncpy(label, IFACE_(node->typeinfo->ui_name.c_str()), label_maxncpy);
153 return;
154 }
155 BLI_strncpy(label, node->id->name + 2, label_maxncpy);
156}
157
158void node_math_label(const bNodeTree * /*ntree*/,
159 const bNode *node,
160 char *label,
161 int label_maxncpy)
162{
163 const char *name;
164 bool enum_label = RNA_enum_name(rna_enum_node_math_items, node->custom1, &name);
165 if (!enum_label) {
166 name = CTX_N_(BLT_I18NCONTEXT_ID_NODETREE, "Unknown");
167 }
168 BLI_strncpy_utf8(label, CTX_IFACE_(BLT_I18NCONTEXT_ID_NODETREE, name), label_maxncpy);
169}
170
171void node_vector_math_label(const bNodeTree * /*ntree*/,
172 const bNode *node,
173 char *label,
174 int label_maxncpy)
175{
176 const char *name;
177 bool enum_label = RNA_enum_name(rna_enum_node_vec_math_items, node->custom1, &name);
178 if (!enum_label) {
179 name = CTX_N_(BLT_I18NCONTEXT_ID_NODETREE, "Unknown");
180 }
181 BLI_strncpy_utf8(label, CTX_IFACE_(BLT_I18NCONTEXT_ID_NODETREE, name), label_maxncpy);
182}
183
184void node_combsep_color_label(const ListBaseT<bNodeSocket> *sockets, NodeCombSepColorMode mode)
185{
186 bNodeSocket *sock1 = sockets->first();
187 bNodeSocket *sock2 = sock1->next;
188 bNodeSocket *sock3 = sock2->next;
189
193
194 switch (mode) {
196 node_sock_label(sock1, "Red");
197 node_sock_label(sock2, "Green");
198 node_sock_label(sock3, "Blue");
199 break;
201 node_sock_label(sock1, "Hue");
202 node_sock_label(sock2, "Saturation");
203 node_sock_label(sock3, "Lightness");
204 break;
206 node_sock_label(sock1, "Hue");
207 node_sock_label(sock2, "Saturation");
208 node_sock_label(sock3, "Value");
209 break;
210 default: {
212 break;
213 }
214 }
215}
216
218
219/* -------------------------------------------------------------------- */
222
224{
225 return true;
226}
227
229
230/* -------------------------------------------------------------------- */
233
234int node_socket_get_int(bNodeTree *ntree, bNode * /*node*/, bNodeSocket *sock)
235{
236 PointerRNA ptr = RNA_pointer_create_discrete(id_cast<ID *>(ntree), RNA_NodeSocket, sock);
237 return RNA_int_get(&ptr, "default_value");
238}
239
240void node_socket_set_int(bNodeTree *ntree, bNode * /*node*/, bNodeSocket *sock, int value)
241{
242 PointerRNA ptr = RNA_pointer_create_discrete(id_cast<ID *>(ntree), RNA_NodeSocket, sock);
243 RNA_int_set(&ptr, "default_value", value);
244}
245
246bool node_socket_get_bool(bNodeTree *ntree, bNode * /*node*/, bNodeSocket *sock)
247{
248 PointerRNA ptr = RNA_pointer_create_discrete(id_cast<ID *>(ntree), RNA_NodeSocket, sock);
249 return RNA_boolean_get(&ptr, "default_value");
250}
251
252void node_socket_set_bool(bNodeTree *ntree, bNode * /*node*/, bNodeSocket *sock, bool value)
253{
254 PointerRNA ptr = RNA_pointer_create_discrete(id_cast<ID *>(ntree), RNA_NodeSocket, sock);
255 RNA_boolean_set(&ptr, "default_value", value);
256}
257
258float node_socket_get_float(bNodeTree *ntree, bNode * /*node*/, bNodeSocket *sock)
259{
260 PointerRNA ptr = RNA_pointer_create_discrete(id_cast<ID *>(ntree), RNA_NodeSocket, sock);
261 return RNA_float_get(&ptr, "default_value");
262}
263
264void node_socket_set_float(bNodeTree *ntree, bNode * /*node*/, bNodeSocket *sock, float value)
265{
266 PointerRNA ptr = RNA_pointer_create_discrete(id_cast<ID *>(ntree), RNA_NodeSocket, sock);
267 RNA_float_set(&ptr, "default_value", value);
268}
269
270void node_socket_get_color(bNodeTree *ntree, bNode * /*node*/, bNodeSocket *sock, float *value)
271{
272 PointerRNA ptr = RNA_pointer_create_discrete(id_cast<ID *>(ntree), RNA_NodeSocket, sock);
273 RNA_float_get_array(&ptr, "default_value", value);
274}
275
277 bNode * /*node*/,
278 bNodeSocket *sock,
279 const float *value)
280{
281 PointerRNA ptr = RNA_pointer_create_discrete(id_cast<ID *>(ntree), RNA_NodeSocket, sock);
282 RNA_float_set_array(&ptr, "default_value", value);
283}
284
285void node_socket_get_vector(bNodeTree *ntree, bNode * /*node*/, bNodeSocket *sock, float *value)
286{
287 PointerRNA ptr = RNA_pointer_create_discrete(id_cast<ID *>(ntree), RNA_NodeSocket, sock);
288 RNA_float_get_array(&ptr, "default_value", value);
289}
290
292 bNode * /*node*/,
293 bNodeSocket *sock,
294 const float *value)
295{
296 PointerRNA ptr = RNA_pointer_create_discrete(id_cast<ID *>(ntree), RNA_NodeSocket, sock);
297 RNA_float_set_array(&ptr, "default_value", value);
298}
299
300void node_socket_get_rotation(bNodeTree *ntree, bNode * /*node*/, bNodeSocket *sock, float *value)
301{
302 PointerRNA ptr = RNA_pointer_create_discrete(id_cast<ID *>(ntree), RNA_NodeSocket, sock);
303 float euler[3];
304 RNA_float_get_array(&ptr, "default_value", euler);
305 eul_to_quat(value, euler);
306}
307
309 bNode * /*node*/,
310 bNodeSocket *sock,
311 const float *value)
312{
313 PointerRNA ptr = RNA_pointer_create_discrete(id_cast<ID *>(ntree), RNA_NodeSocket, sock);
314 float euler[3];
315 quat_to_eul(euler, value);
316 RNA_float_set_array(&ptr, "default_value", euler);
317}
318
320
321} // namespace blender
#define STRNCPY_UTF8(dst, src)
#define CTX_N_(context, msgid)
#define BLT_I18NCONTEXT_ID_NODETREE
#define CTX_IFACE_(context, msgid)
#define IFACE_(msgid)
#define BLT_I18NCONTEXT_COLOR
Read Blender memory allocation and freeing.
#define BLI_assert_unreachable()
#define ELEM(...)
void node_set_socket_availability(bNodeTree &ntree, bNodeSocket &sock, bool is_available)
Definition node.cc:5499
BMesh Iterators.
void RNA_float_set_array(PointerRNA *ptr, const char *name, const float *values)
void node_math_label(const bNodeTree *, const bNode *node, char *label, int label_maxncpy)
Definition node_util.cc:158
CurveMapping * BKE_curvemapping_copy(const CurveMapping *cumap)
int node_socket_get_int(bNodeTree *ntree, bNode *, bNodeSocket *sock)
Definition node_util.cc:234
const EnumPropertyItem rna_enum_ramp_blend_items[]
void RNA_int_set(PointerRNA *ptr, const char *name, int value)
char * BLI_strncpy_utf8(char *__restrict dst, const char *__restrict src, size_t dst_maxncpy) ATTR_NONNULL(1
void node_math_update(bNodeTree *ntree, bNode *node)
Definition node_util.cc:88
void quat_to_eul(float eul[3], const float quat[4])
@ NODE_MATH_SMOOTH_MAX
@ NODE_MATH_SMOOTH_MIN
@ NODE_MATH_ARCCOSINE
@ NODE_MATH_ARCTANGENT
@ NODE_MATH_MULTIPLY_ADD
void node_socket_set_color(bNodeTree *ntree, bNode *, bNodeSocket *sock, const float *value)
Definition node_util.cc:276
int RNA_int_get(PointerRNA *ptr, const char *name)
float node_socket_get_float(bNodeTree *ntree, bNode *, bNodeSocket *sock)
Definition node_util.cc:258
@ NODE_COMBSEP_COLOR_HSL
@ NODE_COMBSEP_COLOR_HSV
@ NODE_COMBSEP_COLOR_RGB
void BKE_curvemapping_free(CurveMapping *cumap)
void MEM_delete_void(void *vmemh)
void node_blend_label(const bNodeTree *, const bNode *node, char *label, int label_maxncpy)
Definition node_util.cc:133
void node_combsep_color_label(const ListBaseT< bNodeSocket > *sockets, NodeCombSepColorMode mode)
Definition node_util.cc:184
void node_vector_math_label(const bNodeTree *, const bNode *node, char *label, int label_maxncpy)
Definition node_util.cc:171
void BKE_curvemapping_init(CurveMapping *cumap)
void * BLI_findlink(const ListBase *listbase, int number) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(1)
Definition listbase.cc:541
char * BLI_strncpy(char *__restrict dst, const char *__restrict src, size_t dst_maxncpy) ATTR_NONNULL(1
void * MEM_dupalloc_void(const void *vmemh) ATTR_WARN_UNUSED_RESULT
void node_sock_label(bNodeSocket *sock, const char *name)
Definition node_util.cc:76
void node_sock_label_clear(bNodeSocket *sock)
Definition node_util.cc:81
void node_socket_set_vector(bNodeTree *ntree, bNode *, bNodeSocket *sock, const float *value)
Definition node_util.cc:291
void node_free_curves(bNode *node)
Definition node_util.cc:40
bool RNA_enum_name(const EnumPropertyItem *item, const int value, const char **r_name)
const EnumPropertyItem rna_enum_node_vec_math_items[]
void eul_to_quat(float quat[4], const float eul[3])
void node_socket_get_color(bNodeTree *ntree, bNode *, bNodeSocket *sock, float *value)
Definition node_util.cc:270
void node_socket_set_rotation(bNodeTree *ntree, bNode *, bNodeSocket *sock, const float *value)
Definition node_util.cc:308
void node_socket_set_bool(bNodeTree *ntree, bNode *, bNodeSocket *sock, bool value)
Definition node_util.cc:252
void node_copy_curves(bNodeTree *, bNode *dest_node, const bNode *src_node)
Definition node_util.cc:52
void node_socket_get_rotation(bNodeTree *ntree, bNode *, bNodeSocket *sock, float *value)
Definition node_util.cc:300
PointerRNA RNA_pointer_create_discrete(ID *id, StructRNA *type, void *data)
bool node_insert_link_default(bke::NodeInsertLinkParams &)
Definition node_util.cc:223
bool RNA_boolean_get(PointerRNA *ptr, const char *name)
void RNA_float_set(PointerRNA *ptr, const char *name, float value)
void RNA_boolean_set(PointerRNA *ptr, const char *name, bool value)
void * node_initexec_curves(bNodeExecContext *, bNode *node, bNodeInstanceKey)
Definition node_util.cc:64
void node_socket_set_int(bNodeTree *ntree, bNode *, bNodeSocket *sock, int value)
Definition node_util.cc:240
bool node_socket_get_bool(bNodeTree *ntree, bNode *, bNodeSocket *sock)
Definition node_util.cc:246
const EnumPropertyItem rna_enum_node_math_items[]
void node_copy_standard_storage(bNodeTree *, bNode *dest_node, const bNode *src_node)
Definition node_util.cc:57
void node_free_standard_storage(bNode *node)
Definition node_util.cc:45
void node_socket_get_vector(bNodeTree *ntree, bNode *, bNodeSocket *sock, float *value)
Definition node_util.cc:285
void node_socket_set_float(bNodeTree *ntree, bNode *, bNodeSocket *sock, float value)
Definition node_util.cc:264
void node_image_label(const bNodeTree *, const bNode *node, char *label, int label_maxncpy)
Definition node_util.cc:146
float RNA_float_get(PointerRNA *ptr, const char *name)
void RNA_float_get_array(PointerRNA *ptr, const char *name, float *values)
struct bNodeSocket * next