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