Merge branch 'blender-v2.91-release' into master
[blender.git] / source / blender / editors / space_node / node_intern.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) 2008 Blender Foundation.
17  * All rights reserved.
18  */
19
20 /** \file
21  * \ingroup spnode
22  */
23
24 #pragma once
25
26 #include "BKE_node.h"
27 #include "UI_interface.h"
28 #include <stddef.h> /* for size_t */
29
30 /* internal exports only */
31
32 struct ARegion;
33 struct ARegionType;
34 struct Main;
35 struct View2D;
36 struct bContext;
37 struct bNode;
38 struct bNodeLink;
39 struct bNodeSocket;
40 struct wmGizmoGroupType;
41 struct wmKeyConfig;
42 struct wmWindow;
43
44 /* temp data to pass on to modal */
45 typedef struct bNodeLinkDrag {
46   struct bNodeLinkDrag *next, *prev;
47
48   /* List of links dragged by the operator.
49    * Note: This is a list of LinkData structs on top of the actual bNodeLinks.
50    * This way the links can be added to the node tree while being stored in this list.
51    */
52   ListBase links;
53   int in_out;
54 } bNodeLinkDrag;
55
56 /* space_node.c */
57
58 /* transform between View2Ds in the tree path */
59 void space_node_group_offset(struct SpaceNode *snode, float *x, float *y);
60
61 /* node_draw.c */
62 int node_get_colorid(struct bNode *node);
63 int node_get_resize_cursor(int directions);
64 void node_draw_shadow(struct SpaceNode *snode, struct bNode *node, float radius, float alpha);
65 void node_draw_default(const struct bContext *C,
66                        struct ARegion *region,
67                        struct SpaceNode *snode,
68                        struct bNodeTree *ntree,
69                        struct bNode *node,
70                        bNodeInstanceKey key);
71 void node_draw_sockets(struct View2D *v2d,
72                        const struct bContext *C,
73                        struct bNodeTree *ntree,
74                        struct bNode *node,
75                        bool draw_outputs,
76                        bool select_all);
77 void node_update_default(const struct bContext *C, struct bNodeTree *ntree, struct bNode *node);
78 int node_select_area_default(struct bNode *node, int x, int y);
79 int node_tweak_area_default(struct bNode *node, int x, int y);
80 void node_socket_color_get(struct bContext *C,
81                            struct bNodeTree *ntree,
82                            struct PointerRNA *node_ptr,
83                            struct bNodeSocket *sock,
84                            float r_color[4]);
85 void node_update_nodetree(const struct bContext *C, struct bNodeTree *ntree);
86 void node_draw_nodetree(const struct bContext *C,
87                         struct ARegion *region,
88                         struct SpaceNode *snode,
89                         struct bNodeTree *ntree,
90                         bNodeInstanceKey parent_key);
91 void node_draw_space(const bContext *C, ARegion *region);
92
93 void node_set_cursor(struct wmWindow *win, struct SpaceNode *snode, float cursor[2]);
94 /* DPI scaled coords */
95 void node_to_view(struct bNode *node, float x, float y, float *rx, float *ry);
96 void node_to_updated_rect(struct bNode *node, rctf *r_rect);
97 void node_from_view(struct bNode *node, float x, float y, float *rx, float *ry);
98
99 /* node_buttons.c */
100 void node_buttons_register(struct ARegionType *art);
101
102 /* node_toolbar.c */
103 void node_toolbar_register(struct ARegionType *art);
104
105 /* node_ops.c */
106 void node_operatortypes(void);
107 void node_keymap(struct wmKeyConfig *keyconf);
108
109 /* node_select.c */
110 void node_deselect_all(struct SpaceNode *snode);
111 void node_socket_select(struct bNode *node, struct bNodeSocket *sock);
112 void node_socket_deselect(struct bNode *node, struct bNodeSocket *sock, const bool deselect_node);
113 void node_deselect_all_input_sockets(struct SpaceNode *snode, const bool deselect_nodes);
114 void node_deselect_all_output_sockets(struct SpaceNode *snode, const bool deselect_nodes);
115 void node_select_single(struct bContext *C, struct bNode *node);
116
117 void NODE_OT_select(struct wmOperatorType *ot);
118 void NODE_OT_select_all(struct wmOperatorType *ot);
119 void NODE_OT_select_linked_to(struct wmOperatorType *ot);
120 void NODE_OT_select_linked_from(struct wmOperatorType *ot);
121 void NODE_OT_select_box(struct wmOperatorType *ot);
122 void NODE_OT_select_circle(struct wmOperatorType *ot);
123 void NODE_OT_select_lasso(struct wmOperatorType *ot);
124 void NODE_OT_select_grouped(struct wmOperatorType *ot);
125 void NODE_OT_select_same_type_step(struct wmOperatorType *ot);
126 void NODE_OT_find_node(struct wmOperatorType *ot);
127
128 /* node_view.c */
129 int space_node_view_flag(struct bContext *C,
130                          struct SpaceNode *snode,
131                          ARegion *region,
132                          const int node_flag,
133                          const int smooth_viewtx);
134
135 void NODE_OT_view_all(struct wmOperatorType *ot);
136 void NODE_OT_view_selected(struct wmOperatorType *ot);
137
138 void NODE_OT_backimage_move(struct wmOperatorType *ot);
139 void NODE_OT_backimage_zoom(struct wmOperatorType *ot);
140 void NODE_OT_backimage_fit(struct wmOperatorType *ot);
141 void NODE_OT_backimage_sample(struct wmOperatorType *ot);
142
143 /* drawnode.c */
144 void nodelink_batch_start(struct SpaceNode *snode);
145 void nodelink_batch_end(struct SpaceNode *snode);
146
147 void node_draw_link(struct View2D *v2d, struct SpaceNode *snode, struct bNodeLink *link);
148 void node_draw_link_bezier(struct View2D *v2d,
149                            struct SpaceNode *snode,
150                            struct bNodeLink *link,
151                            int th_col1,
152                            int th_col2,
153                            int th_col3);
154 bool node_link_bezier_points(struct View2D *v2d,
155                              struct SpaceNode *snode,
156                              struct bNodeLink *link,
157                              float coord_array[][2],
158                              int resol);
159 void draw_nodespace_back_pix(const struct bContext *C,
160                              struct ARegion *region,
161                              struct SpaceNode *snode,
162                              bNodeInstanceKey parent_key);
163
164 /* node_add.c */
165 bNode *node_add_node(
166     const struct bContext *C, const char *idname, int type, float locx, float locy);
167 void NODE_OT_add_reroute(struct wmOperatorType *ot);
168 void NODE_OT_add_file(struct wmOperatorType *ot);
169 void NODE_OT_add_mask(struct wmOperatorType *ot);
170 void NODE_OT_new_node_tree(struct wmOperatorType *ot);
171
172 /* node_group.c */
173 void NODE_OT_group_make(struct wmOperatorType *ot);
174 void NODE_OT_group_insert(struct wmOperatorType *ot);
175 void NODE_OT_group_ungroup(struct wmOperatorType *ot);
176 void NODE_OT_group_separate(struct wmOperatorType *ot);
177 void NODE_OT_group_edit(struct wmOperatorType *ot);
178
179 /* node_relationships.c */
180 bool node_connected_to_output(struct Main *bmain, struct bNodeTree *ntree, struct bNode *node);
181
182 void NODE_OT_link(struct wmOperatorType *ot);
183 void NODE_OT_link_make(struct wmOperatorType *ot);
184 void NODE_OT_links_cut(struct wmOperatorType *ot);
185 void NODE_OT_links_detach(struct wmOperatorType *ot);
186
187 void NODE_OT_parent_set(struct wmOperatorType *ot);
188 void NODE_OT_join(struct wmOperatorType *ot);
189 void NODE_OT_attach(struct wmOperatorType *ot);
190 void NODE_OT_detach(struct wmOperatorType *ot);
191
192 void NODE_OT_link_viewer(struct wmOperatorType *ot);
193
194 void NODE_OT_insert_offset(struct wmOperatorType *ot);
195
196 /* node_edit.c */
197 void snode_notify(struct bContext *C, struct SpaceNode *snode);
198 void snode_dag_update(struct bContext *C, struct SpaceNode *snode);
199 void snode_set_context(const struct bContext *C);
200
201 void snode_update(struct SpaceNode *snode, struct bNode *node);
202 bool composite_node_active(struct bContext *C);
203 bool composite_node_editable(struct bContext *C);
204
205 bool node_has_hidden_sockets(struct bNode *node);
206 void node_set_hidden_sockets(struct SpaceNode *snode, bNode *node, int set);
207 int node_render_changed_exec(bContext *, struct wmOperator *);
208 int node_find_indicated_socket(struct SpaceNode *snode,
209                                struct bNode **nodep,
210                                struct bNodeSocket **sockp,
211                                float cursor[2],
212                                int in_out);
213
214 void NODE_OT_duplicate(struct wmOperatorType *ot);
215 void NODE_OT_delete(struct wmOperatorType *ot);
216 void NODE_OT_delete_reconnect(struct wmOperatorType *ot);
217 void NODE_OT_resize(struct wmOperatorType *ot);
218
219 void NODE_OT_mute_toggle(struct wmOperatorType *ot);
220 void NODE_OT_hide_toggle(struct wmOperatorType *ot);
221 void NODE_OT_hide_socket_toggle(struct wmOperatorType *ot);
222 void NODE_OT_preview_toggle(struct wmOperatorType *ot);
223 void NODE_OT_options_toggle(struct wmOperatorType *ot);
224 void NODE_OT_node_copy_color(struct wmOperatorType *ot);
225
226 void NODE_OT_read_viewlayers(struct wmOperatorType *ot);
227 void NODE_OT_render_changed(struct wmOperatorType *ot);
228
229 void NODE_OT_output_file_add_socket(struct wmOperatorType *ot);
230 void NODE_OT_output_file_remove_active_socket(struct wmOperatorType *ot);
231 void NODE_OT_output_file_move_active_socket(struct wmOperatorType *ot);
232
233 void NODE_OT_switch_view_update(struct wmOperatorType *ot);
234
235 /* Note: clipboard_cut is a simple macro of copy + delete */
236 void NODE_OT_clipboard_copy(struct wmOperatorType *ot);
237 void NODE_OT_clipboard_paste(struct wmOperatorType *ot);
238
239 void NODE_OT_tree_socket_add(struct wmOperatorType *ot);
240 void NODE_OT_tree_socket_remove(struct wmOperatorType *ot);
241 void NODE_OT_tree_socket_move(struct wmOperatorType *ot);
242
243 void NODE_OT_shader_script_update(struct wmOperatorType *ot);
244
245 void NODE_OT_viewer_border(struct wmOperatorType *ot);
246 void NODE_OT_clear_viewer_border(struct wmOperatorType *ot);
247
248 /* node_widgets.c */
249 void NODE_GGT_backdrop_transform(struct wmGizmoGroupType *gzgt);
250 void NODE_GGT_backdrop_crop(struct wmGizmoGroupType *gzgt);
251 void NODE_GGT_backdrop_sun_beams(struct wmGizmoGroupType *gzgt);
252 void NODE_GGT_backdrop_corner_pin(struct wmGizmoGroupType *gzgt);
253
254 void NODE_OT_cryptomatte_layer_add(struct wmOperatorType *ot);
255 void NODE_OT_cryptomatte_layer_remove(struct wmOperatorType *ot);
256
257 extern const char *node_context_dir[];
258
259 /* XXXXXX */
260
261 /* Nodes draw without dpi - the view zoom is flexible. */
262 #define HIDDEN_RAD (0.75f * U.widget_unit)
263 #define BASIS_RAD (0.2f * U.widget_unit)
264 #define NODE_DYS (U.widget_unit / 2)
265 #define NODE_DY U.widget_unit
266 #define NODE_SOCKDY (0.08f * U.widget_unit)
267 #define NODE_WIDTH(node) (node->width * UI_DPI_FAC)
268 #define NODE_HEIGHT(node) (node->height * UI_DPI_FAC)
269 #define NODE_MARGIN_X (0.95f * U.widget_unit)
270 #define NODE_SOCKSIZE (0.25f * U.widget_unit)
271 #define NODE_RESIZE_MARGIN (0.20f * U.widget_unit)
272 #define NODE_LINK_RESOL 12
273
274 /* Button events (butspace) */
275 enum eNodeSpace_ButEvents {
276   B_NOP = 0,
277   B_REDR = 1,
278   B_NODE_USEMAT,
279   B_NODE_USESCENE,
280   B_NODE_USETEX,
281   B_TEXBROWSE,
282   B_TEXALONE,
283   B_TEXLOCAL,
284   B_TEXDELETE,
285   B_TEXPRV,
286   B_AUTOTEXNAME,
287   B_KEEPDATA,
288   B_NODE_EXEC,
289   B_MATPRV,
290   B_NODE_LOADIMAGE,
291   B_NODE_SETIMAGE,
292 };