Merge branch 'blender-v2.81-release'
[blender.git] / source / blender / nodes / intern / node_util.h
1 /*
2  * This program is free software; you can redistribute it and/or
3  * modify it under the terms of the GNU General Public License
4  * as published by the Free Software Foundation; either version 2
5  * of the License, or (at your option) any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software Foundation,
14  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
15  *
16  * The Original Code is Copyright (C) 2007 Blender Foundation.
17  * All rights reserved.
18  */
19
20 /** \file
21  * \ingroup nodes
22  */
23
24 #ifndef __NODE_UTIL_H__
25 #define __NODE_UTIL_H__
26
27 #include "DNA_listBase.h"
28
29 #include "BLI_utildefines.h"
30
31 #include "BKE_node.h"
32
33 #include "MEM_guardedalloc.h"
34
35 #include "NOD_socket.h"
36
37 #include "GPU_material.h" /* For Shader muting GPU code... */
38
39 #include "RNA_access.h"
40
41 struct bNode;
42 struct bNodeTree;
43
44 /* data for initializing node execution */
45 typedef struct bNodeExecContext {
46   struct bNodeInstanceHash *previews;
47 } bNodeExecContext;
48
49 typedef struct bNodeExecData {
50   void *data;                   /* custom data storage */
51   struct bNodePreview *preview; /* optional preview image */
52 } bNodeExecData;
53
54 /**** Storage Data ****/
55
56 extern void node_free_curves(struct bNode *node);
57 extern void node_free_standard_storage(struct bNode *node);
58
59 extern void node_copy_curves(struct bNodeTree *dest_ntree,
60                              struct bNode *dest_node,
61                              const struct bNode *src_node);
62 extern void node_copy_standard_storage(struct bNodeTree *dest_ntree,
63                                        struct bNode *dest_node,
64                                        const struct bNode *src_node);
65 extern void *node_initexec_curves(struct bNodeExecContext *context,
66                                   struct bNode *node,
67                                   bNodeInstanceKey key);
68
69 /**** Labels ****/
70
71 void node_blend_label(struct bNodeTree *ntree, struct bNode *node, char *label, int maxlen);
72 void node_image_label(struct bNodeTree *ntree, struct bNode *node, char *label, int maxlen);
73 void node_math_label(struct bNodeTree *ntree, struct bNode *node, char *label, int maxlen);
74 void node_vector_math_label(struct bNodeTree *ntree, struct bNode *node, char *label, int maxlen);
75 void node_filter_label(struct bNodeTree *ntree, struct bNode *node, char *label, int maxlen);
76
77 /*** Link Handling */
78 void node_insert_link_default(struct bNodeTree *ntree, struct bNode *node, struct bNodeLink *link);
79 void node_update_internal_links_default(struct bNodeTree *ntree, struct bNode *node);
80
81 float node_socket_get_float(struct bNodeTree *ntree, struct bNode *node, struct bNodeSocket *sock);
82 void node_socket_set_float(struct bNodeTree *ntree,
83                            struct bNode *node,
84                            struct bNodeSocket *sock,
85                            float value);
86 void node_socket_get_color(struct bNodeTree *ntree,
87                            struct bNode *node,
88                            struct bNodeSocket *sock,
89                            float *value);
90 void node_socket_set_color(struct bNodeTree *ntree,
91                            struct bNode *node,
92                            struct bNodeSocket *sock,
93                            const float *value);
94 void node_socket_get_vector(struct bNodeTree *ntree,
95                             struct bNode *node,
96                             struct bNodeSocket *sock,
97                             float *value);
98 void node_socket_set_vector(struct bNodeTree *ntree,
99                             struct bNode *node,
100                             struct bNodeSocket *sock,
101                             const float *value);
102
103 #endif