Merging r58475 through r58700 from trunk into soc-2013-depsgraph_mt
[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 wmWindowManager;
46 struct wmEvent;
47 struct bNode;
48 struct bNodeSocket;
49 struct bNodeLink;
50 struct Main;
51 struct wmKeyConfig;
52
53 /* temp data to pass on to modal */
54 typedef struct bNodeLinkDrag {
55         struct bNodeLinkDrag *next, *prev;
56         
57         /* List of links dragged by the operator.
58          * Note: This is a list of LinkData structs on top of the actual bNodeLinks.
59          * This way the links can be added to the node tree while being stored in this list.
60          */
61         ListBase links;
62         int in_out;
63 } bNodeLinkDrag;
64
65 /* space_node.c */
66 ARegion *node_has_buttons_region(ScrArea *sa);
67 ARegion *node_has_tools_region(ScrArea *sa);
68
69 void snode_group_offset(struct SpaceNode *snode, float *x, float *y);   /* transform between View2Ds in the tree path */
70
71 /* node_draw.c */
72 int node_get_colorid(struct bNode *node);
73 void node_socket_circle_draw(const struct bContext *C, struct bNodeTree *ntree, struct bNode *node,
74                              struct bNodeSocket *sock, float size, int highlight);
75 int node_get_resize_cursor(int directions);
76 void node_draw_shadow(struct SpaceNode *snode, struct bNode *node, float radius, float alpha);
77 void node_draw_default(const struct bContext *C, struct ARegion *ar, struct SpaceNode *snode,
78                        struct bNodeTree *ntree, struct bNode *node, bNodeInstanceKey key);
79 void node_update_default(const struct bContext *C, struct bNodeTree *ntree, struct bNode *node);
80 int node_select_area_default(struct bNode *node, int x, int y);
81 int node_tweak_area_default(struct bNode *node, int x, int y);
82 void node_update_nodetree(const struct bContext *C, struct bNodeTree *ntree);
83 void node_draw_nodetree(const struct bContext *C, struct ARegion *ar, struct SpaceNode *snode,
84                         struct bNodeTree *ntree, bNodeInstanceKey parent_key);
85 void drawnodespace(const bContext *C, ARegion *ar);
86
87 void node_set_cursor(struct wmWindow *win, struct SpaceNode *snode);
88         /* DPI scaled coords */
89 void node_to_view(struct bNode *node, float x, float y, float *rx, float *ry);
90 void node_from_view(struct bNode *node, float x, float y, float *rx, float *ry);
91
92 /* node_buttons.c */
93 void node_buttons_register(struct ARegionType *art);
94 void NODE_OT_properties(struct wmOperatorType *ot);
95
96 /* node_toolbar.c */
97 void node_toolbar_register(struct ARegionType *art);
98 void NODE_OT_toolbar(struct wmOperatorType *ot);
99
100 /* node_ops.c */
101 void node_operatortypes(void);
102 void node_keymap(struct wmKeyConfig *keyconf);
103
104 /* node_select.c */
105 void node_deselect_all(struct SpaceNode *snode);
106 void node_socket_select(struct bNode *node, struct bNodeSocket *sock);
107 void node_socket_deselect(struct bNode *node, struct bNodeSocket *sock, int deselect_node);
108 void node_deselect_all_input_sockets(struct SpaceNode *snode, int deselect_nodes);
109 void node_deselect_all_output_sockets(struct SpaceNode *snode, int deselect_nodes);
110 int node_select_same_type(struct SpaceNode *snode);
111 int node_select_same_type_np(struct SpaceNode *snode, int dir);
112 void node_select_single(struct bContext *C, struct bNode *node);
113
114 void NODE_OT_select(struct wmOperatorType *ot);
115 void NODE_OT_select_all(struct wmOperatorType *ot);
116 void NODE_OT_select_linked_to(struct wmOperatorType *ot);
117 void NODE_OT_select_linked_from(struct wmOperatorType *ot);
118 void NODE_OT_select_border(struct wmOperatorType *ot);
119 void NODE_OT_select_lasso(struct wmOperatorType *ot);
120 void NODE_OT_select_same_type(struct wmOperatorType *ot);
121 void NODE_OT_select_same_type_step(struct wmOperatorType *ot);
122 void NODE_OT_find_node(struct wmOperatorType *ot);
123
124 /* node_view.c */
125 int space_node_view_flag(struct bContext *C, SpaceNode *snode, ARegion *ar, const int node_flag);
126
127 void NODE_OT_view_all(struct wmOperatorType *ot);
128 void NODE_OT_view_selected(struct wmOperatorType *ot);
129
130 void NODE_OT_backimage_move(struct wmOperatorType *ot);
131 void NODE_OT_backimage_zoom(struct wmOperatorType *ot);
132 void NODE_OT_backimage_sample(struct wmOperatorType *ot);
133
134 /* drawnode.c */
135 void node_draw_link(struct View2D *v2d, struct SpaceNode *snode, struct bNodeLink *link);
136 void node_draw_link_bezier(struct View2D *v2d, struct SpaceNode *snode, struct bNodeLink *link, int th_col1, int do_shaded, int th_col2, int do_triple, int th_col3);
137 int  node_link_bezier_points(struct View2D *v2d, struct SpaceNode *snode, struct bNodeLink *link, float coord_array[][2], int resol);
138 // 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 );
139 void draw_nodespace_back_pix(const struct bContext *C, struct ARegion *ar, struct SpaceNode *snode, bNodeInstanceKey parent_key);
140
141
142 /* node_add.c */
143 bNode *node_add_node(const struct bContext *C, const char *idname, int type, float locx, float locy);
144 void NODE_OT_add_reroute(struct wmOperatorType *ot);
145 void NODE_OT_add_file(struct wmOperatorType *ot);
146 void NODE_OT_add_mask(struct wmOperatorType *ot);
147 void NODE_OT_new_node_tree(struct wmOperatorType *ot);
148
149
150 /* node_group.c */
151 void NODE_OT_group_make(struct wmOperatorType *ot);
152 void NODE_OT_group_insert(struct wmOperatorType *ot);
153 void NODE_OT_group_ungroup(struct wmOperatorType *ot);
154 void NODE_OT_group_separate(struct wmOperatorType *ot);
155 void NODE_OT_group_edit(struct wmOperatorType *ot);
156
157
158 /* node_relationships.c */
159 void NODE_OT_link(struct wmOperatorType *ot);
160 void NODE_OT_link_make(struct wmOperatorType *ot);
161 void NODE_OT_links_cut(struct wmOperatorType *ot);
162 void NODE_OT_links_detach(struct wmOperatorType *ot);
163
164 void NODE_OT_parent_set(struct wmOperatorType *ot);
165 void NODE_OT_parent_clear(struct wmOperatorType *ot);
166 void NODE_OT_join(struct wmOperatorType *ot);
167 void NODE_OT_attach(struct wmOperatorType *ot);
168 void NODE_OT_detach(struct wmOperatorType *ot);
169
170 void NODE_OT_show_cyclic_dependencies(struct wmOperatorType *ot);
171 void NODE_OT_link_viewer(struct wmOperatorType *ot);
172
173 /* node_edit.c */
174 void snode_notify(struct bContext *C, struct SpaceNode *snode);
175 void snode_dag_update(struct bContext *C, struct SpaceNode *snode);
176 void snode_set_context(const struct bContext *C);
177
178 void snode_update(struct SpaceNode *snode, struct bNode *node);
179 int composite_node_active(struct bContext *C);
180 int composite_node_editable(struct bContext *C);
181
182 int node_has_hidden_sockets(bNode *node);
183 void node_set_hidden_sockets(SpaceNode *snode, bNode *node, int set);
184 int node_render_changed_exec(bContext *, struct wmOperator *);
185 int node_find_indicated_socket(struct SpaceNode *snode, struct bNode **nodep, struct bNodeSocket **sockp, int in_out);
186
187 void NODE_OT_duplicate(struct wmOperatorType *ot);
188 void NODE_OT_delete(struct wmOperatorType *ot);
189 void NODE_OT_delete_reconnect(struct wmOperatorType *ot);
190 void NODE_OT_resize(struct wmOperatorType *ot);
191
192 void NODE_OT_mute_toggle(struct wmOperatorType *ot);
193 void NODE_OT_hide_toggle(struct wmOperatorType *ot);
194 void NODE_OT_hide_socket_toggle(struct wmOperatorType *ot);
195 void NODE_OT_preview_toggle(struct wmOperatorType *ot);
196 void NODE_OT_options_toggle(struct wmOperatorType *ot);
197 void NODE_OT_node_copy_color(struct wmOperatorType *ot);
198
199 void NODE_OT_read_fullsamplelayers(struct wmOperatorType *ot);
200 void NODE_OT_read_renderlayers(struct wmOperatorType *ot);
201 void NODE_OT_render_changed(struct wmOperatorType *ot);
202
203 void NODE_OT_output_file_add_socket(struct wmOperatorType *ot);
204 void NODE_OT_output_file_remove_active_socket(struct wmOperatorType *ot);
205 void NODE_OT_output_file_move_active_socket(struct wmOperatorType *ot);
206
207 /* Note: clipboard_cut is a simple macro of copy + delete */
208 void NODE_OT_clipboard_copy(struct wmOperatorType *ot);
209 void NODE_OT_clipboard_paste(struct wmOperatorType *ot);
210
211 void NODE_OT_tree_socket_add(struct wmOperatorType *ot);
212 void NODE_OT_tree_socket_remove(struct wmOperatorType *ot);
213 void NODE_OT_tree_socket_move(struct wmOperatorType *ot);
214
215 void NODE_OT_shader_script_update(struct wmOperatorType *ot);
216
217 void NODE_OT_viewer_border(struct wmOperatorType *ot);
218
219 extern const char *node_context_dir[];
220
221 // XXXXXX
222
223 // nodes draw without dpi - the view zoom is flexible
224 #define HIDDEN_RAD      (0.75f * U.widget_unit)
225 #define BASIS_RAD       (0.4f * U.widget_unit)
226 #define NODE_DYS        (U.widget_unit / 2)
227 #define NODE_DY         U.widget_unit
228 #define NODE_SOCKDY     (0.08f * U.widget_unit)
229 #define NODE_WIDTH(node)        (node->width * UI_DPI_FAC)
230 #define NODE_MARGIN_X   (0.75f * U.widget_unit)
231 #define NODE_SOCKSIZE   (0.25f * U.widget_unit)
232 #define NODE_LINK_RESOL 12
233
234 // XXX button events (butspace)
235 enum eNodeSpace_ButEvents {
236         B_NOP = 0,
237         B_REDR = 1,
238         B_NODE_USEMAT,
239         B_NODE_USESCENE,
240         B_NODE_USETEX,
241         B_TEXBROWSE,
242         B_TEXALONE,
243         B_TEXLOCAL,
244         B_TEXDELETE,
245         B_TEXPRV,
246         B_AUTOTEXNAME,
247         B_KEEPDATA,
248         B_NODE_EXEC,
249         B_MATPRV,
250         B_NODE_LOADIMAGE,
251         B_NODE_SETIMAGE,
252 };
253
254 #endif /* __NODE_INTERN_H__ */