Merge branch 'master' into blender2.8
[blender.git] / source / blender / editors / space_node / node_intern.h
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * The Original Code is Copyright (C) 2008 Blender Foundation.
19  * All rights reserved.
20  *
21  *
22  * Contributor(s): Blender Foundation
23  *
24  * ***** END GPL LICENSE BLOCK *****
25  */
26
27 /** \file blender/editors/space_node/node_intern.h
28  *  \ingroup spnode
29  */
30
31 #ifndef __NODE_INTERN_H__
32 #define __NODE_INTERN_H__
33
34 #include <stddef.h> /* for size_t */
35 #include "BKE_node.h"
36 #include "UI_interface.h"
37
38 /* internal exports only */
39
40 struct ARegion;
41 struct ARegionType;
42 struct View2D;
43 struct bContext;
44 struct wmWindow;
45 struct bNode;
46 struct bNodeSocket;
47 struct bNodeLink;
48 struct wmKeyConfig;
49
50 /* temp data to pass on to modal */
51 typedef struct bNodeLinkDrag {
52         struct bNodeLinkDrag *next, *prev;
53
54         /* List of links dragged by the operator.
55          * Note: This is a list of LinkData structs on top of the actual bNodeLinks.
56          * This way the links can be added to the node tree while being stored in this list.
57          */
58         ListBase links;
59         int in_out;
60 } bNodeLinkDrag;
61
62 /* space_node.c */
63 ARegion *node_has_buttons_region(ScrArea *sa);
64 ARegion *node_has_tools_region(ScrArea *sa);
65
66 void snode_group_offset(struct SpaceNode *snode, float *x, float *y);   /* transform between View2Ds in the tree path */
67
68 /* node_draw.c */
69 int node_get_colorid(struct bNode *node);
70 int node_get_resize_cursor(int directions);
71 void node_draw_shadow(struct SpaceNode *snode, struct bNode *node, float radius, float alpha);
72 void node_draw_default(const struct bContext *C, struct ARegion *ar, struct SpaceNode *snode,
73                        struct bNodeTree *ntree, struct bNode *node, bNodeInstanceKey key);
74 void node_draw_sockets(struct View2D *v2d, const struct bContext *C, struct bNodeTree *ntree, struct bNode *node, bool draw_outputs, bool select_all);
75 void node_update_default(const struct bContext *C, struct bNodeTree *ntree, struct bNode *node);
76 int node_select_area_default(struct bNode *node, int x, int y);
77 int node_tweak_area_default(struct bNode *node, int x, int y);
78 void node_update_nodetree(const struct bContext *C, struct bNodeTree *ntree);
79 void node_draw_nodetree(const struct bContext *C, struct ARegion *ar, struct SpaceNode *snode,
80                         struct bNodeTree *ntree, bNodeInstanceKey parent_key);
81 void drawnodespace(const bContext *C, ARegion *ar);
82
83 void node_set_cursor(struct wmWindow *win, struct SpaceNode *snode, float cursor[2]);
84         /* DPI scaled coords */
85 void node_to_view(struct bNode *node, float x, float y, float *rx, float *ry);
86 void node_to_updated_rect(struct bNode *node, rctf *r_rect);
87 void node_from_view(struct bNode *node, float x, float y, float *rx, float *ry);
88
89 /* node_buttons.c */
90 void node_buttons_register(struct ARegionType *art);
91 void NODE_OT_properties(struct wmOperatorType *ot);
92
93 /* node_toolbar.c */
94 void node_toolbar_register(struct ARegionType *art);
95 void NODE_OT_toolbar(struct wmOperatorType *ot);
96
97 /* node_ops.c */
98 void node_operatortypes(void);
99 void node_keymap(struct wmKeyConfig *keyconf);
100
101 /* node_select.c */
102 void node_deselect_all(struct SpaceNode *snode);
103 void node_socket_select(struct bNode *node, struct bNodeSocket *sock);
104 void node_socket_deselect(struct bNode *node, struct bNodeSocket *sock, const bool deselect_node);
105 void node_deselect_all_input_sockets(struct SpaceNode *snode, const bool deselect_nodes);
106 void node_deselect_all_output_sockets(struct SpaceNode *snode, const bool deselect_nodes);
107 void node_select_single(struct bContext *C, struct bNode *node);
108
109 void NODE_OT_select(struct wmOperatorType *ot);
110 void NODE_OT_select_all(struct wmOperatorType *ot);
111 void NODE_OT_select_linked_to(struct wmOperatorType *ot);
112 void NODE_OT_select_linked_from(struct wmOperatorType *ot);
113 void NODE_OT_select_border(struct wmOperatorType *ot);
114 void NODE_OT_select_circle(struct wmOperatorType *ot);
115 void NODE_OT_select_lasso(struct wmOperatorType *ot);
116 void NODE_OT_select_grouped(struct wmOperatorType *ot);
117 void NODE_OT_select_same_type_step(struct wmOperatorType *ot);
118 void NODE_OT_find_node(struct wmOperatorType *ot);
119
120 /* node_view.c */
121 int space_node_view_flag(struct bContext *C, SpaceNode *snode, ARegion *ar,
122                          const int node_flag, const int smooth_viewtx);
123
124 void NODE_OT_view_all(struct wmOperatorType *ot);
125 void NODE_OT_view_selected(struct wmOperatorType *ot);
126
127 void NODE_OT_backimage_move(struct wmOperatorType *ot);
128 void NODE_OT_backimage_zoom(struct wmOperatorType *ot);
129 void NODE_OT_backimage_fit(struct wmOperatorType *ot);
130 void NODE_OT_backimage_sample(struct wmOperatorType *ot);
131
132 /* drawnode.c */
133 void nodelink_batch_start(struct SpaceNode *snode);
134 void nodelink_batch_end(struct SpaceNode *snode);
135
136 void node_draw_link(struct View2D *v2d, struct SpaceNode *snode, struct bNodeLink *link);
137 void node_draw_link_bezier(struct View2D *v2d, struct SpaceNode *snode, struct bNodeLink *link, int th_col1, int th_col2, int th_col3);
138 bool node_link_bezier_points(struct View2D *v2d, struct SpaceNode *snode, struct bNodeLink *link, float coord_array[][2], int resol);
139 // void node_draw_link_straight(View2D *v2d, SpaceNode *snode, bNodeLink *link, int th_col1, int do_shaded, int th_col2, int do_triple, int th_col3 );
140 void draw_nodespace_back_pix(const struct bContext *C, struct ARegion *ar, struct SpaceNode *snode, bNodeInstanceKey parent_key);
141
142
143 /* node_add.c */
144 bNode *node_add_node(const struct bContext *C, const char *idname, int type, float locx, float locy);
145 void NODE_OT_add_reroute(struct wmOperatorType *ot);
146 void NODE_OT_add_file(struct wmOperatorType *ot);
147 void NODE_OT_add_mask(struct wmOperatorType *ot);
148 void NODE_OT_new_node_tree(struct wmOperatorType *ot);
149
150
151 /* node_group.c */
152 void NODE_OT_group_make(struct wmOperatorType *ot);
153 void NODE_OT_group_insert(struct wmOperatorType *ot);
154 void NODE_OT_group_ungroup(struct wmOperatorType *ot);
155 void NODE_OT_group_separate(struct wmOperatorType *ot);
156 void NODE_OT_group_edit(struct wmOperatorType *ot);
157
158
159 /* node_relationships.c */
160 bool node_connected_to_output(struct bNodeTree *ntree, struct bNode *node);
161
162 void NODE_OT_link(struct wmOperatorType *ot);
163 void NODE_OT_link_make(struct wmOperatorType *ot);
164 void NODE_OT_links_cut(struct wmOperatorType *ot);
165 void NODE_OT_links_detach(struct wmOperatorType *ot);
166
167 void NODE_OT_parent_set(struct wmOperatorType *ot);
168 void NODE_OT_join(struct wmOperatorType *ot);
169 void NODE_OT_attach(struct wmOperatorType *ot);
170 void NODE_OT_detach(struct wmOperatorType *ot);
171
172 void NODE_OT_link_viewer(struct wmOperatorType *ot);
173
174 void NODE_OT_insert_offset(wmOperatorType *ot);
175
176 /* node_edit.c */
177 void snode_notify(struct bContext *C, struct SpaceNode *snode);
178 void snode_dag_update(struct bContext *C, struct SpaceNode *snode);
179 void snode_set_context(const struct bContext *C);
180
181 void snode_update(struct SpaceNode *snode, struct bNode *node);
182 int composite_node_active(struct bContext *C);
183 int composite_node_editable(struct bContext *C);
184
185 int node_has_hidden_sockets(bNode *node);
186 void node_set_hidden_sockets(SpaceNode *snode, bNode *node, int set);
187 int node_render_changed_exec(bContext *, struct wmOperator *);
188 int node_find_indicated_socket(struct SpaceNode *snode, struct bNode **nodep, struct bNodeSocket **sockp, float cursor[2], int in_out);
189
190 void NODE_OT_duplicate(struct wmOperatorType *ot);
191 void NODE_OT_delete(struct wmOperatorType *ot);
192 void NODE_OT_delete_reconnect(struct wmOperatorType *ot);
193 void NODE_OT_resize(struct wmOperatorType *ot);
194
195 void NODE_OT_mute_toggle(struct wmOperatorType *ot);
196 void NODE_OT_hide_toggle(struct wmOperatorType *ot);
197 void NODE_OT_hide_socket_toggle(struct wmOperatorType *ot);
198 void NODE_OT_preview_toggle(struct wmOperatorType *ot);
199 void NODE_OT_options_toggle(struct wmOperatorType *ot);
200 void NODE_OT_node_copy_color(struct wmOperatorType *ot);
201
202 void NODE_OT_read_fullsamplelayers(struct wmOperatorType *ot);
203 void NODE_OT_read_viewlayers(struct wmOperatorType *ot);
204 void NODE_OT_render_changed(struct wmOperatorType *ot);
205
206 void NODE_OT_output_file_add_socket(struct wmOperatorType *ot);
207 void NODE_OT_output_file_remove_active_socket(struct wmOperatorType *ot);
208 void NODE_OT_output_file_move_active_socket(struct wmOperatorType *ot);
209
210 void NODE_OT_switch_view_update (struct wmOperatorType *ot);
211
212 /* Note: clipboard_cut is a simple macro of copy + delete */
213 void NODE_OT_clipboard_copy(struct wmOperatorType *ot);
214 void NODE_OT_clipboard_paste(struct wmOperatorType *ot);
215
216 void NODE_OT_tree_socket_add(struct wmOperatorType *ot);
217 void NODE_OT_tree_socket_remove(struct wmOperatorType *ot);
218 void NODE_OT_tree_socket_move(struct wmOperatorType *ot);
219
220 void NODE_OT_shader_script_update(struct wmOperatorType *ot);
221
222 void NODE_OT_viewer_border(struct wmOperatorType *ot);
223 void NODE_OT_clear_viewer_border(struct wmOperatorType *ot);
224
225 /* node_widgets.c */
226 void NODE_WGT_backdrop_transform(struct wmManipulatorGroupType *wgt);
227 void NODE_WGT_backdrop_crop(struct wmManipulatorGroupType *wgt);
228 void NODE_WGT_backdrop_sun_beams(struct wmManipulatorGroupType *wgt);
229 void NODE_WGT_backdrop_corner_pin(struct wmManipulatorGroupType *wgt);
230
231
232 extern const char *node_context_dir[];
233
234 // XXXXXX
235
236 // nodes draw without dpi - the view zoom is flexible
237 #define HIDDEN_RAD      (0.75f * U.widget_unit)
238 #define BASIS_RAD       (0.4f * U.widget_unit)
239 #define NODE_DYS        (U.widget_unit / 2)
240 #define NODE_DY         U.widget_unit
241 #define NODE_SOCKDY     (0.08f * U.widget_unit)
242 #define NODE_WIDTH(node)  (node->width * UI_DPI_FAC)
243 #define NODE_HEIGHT(node) (node->height * UI_DPI_FAC)
244 #define NODE_MARGIN_X   (0.75f * U.widget_unit)
245 #define NODE_SOCKSIZE   (0.25f * U.widget_unit)
246 #define NODE_LINK_RESOL 12
247
248 // XXX button events (butspace)
249 enum eNodeSpace_ButEvents {
250         B_NOP = 0,
251         B_REDR = 1,
252         B_NODE_USEMAT,
253         B_NODE_USESCENE,
254         B_NODE_USETEX,
255         B_TEXBROWSE,
256         B_TEXALONE,
257         B_TEXLOCAL,
258         B_TEXDELETE,
259         B_TEXPRV,
260         B_AUTOTEXNAME,
261         B_KEEPDATA,
262         B_NODE_EXEC,
263         B_MATPRV,
264         B_NODE_LOADIMAGE,
265         B_NODE_SETIMAGE,
266 };
267
268 #endif /* __NODE_INTERN_H__ */