doxygen: blender/editors tagged.
[blender.git] / source / blender / editors / space_node / node_select.c
1 /*
2  * $Id$
3  *
4  * ***** BEGIN GPL LICENSE BLOCK *****
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version 2
9  * of the License, or (at your option) any later version. 
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software Foundation,
18  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
19  *
20  * The Original Code is Copyright (C) 2008 Blender Foundation.
21  * All rights reserved.
22  *
23  * 
24  * Contributor(s): Blender Foundation, Nathan Letwory
25  *
26  * ***** END GPL LICENSE BLOCK *****
27  */
28
29 /** \file blender/editors/space_node/node_select.c
30  *  \ingroup spnode
31  */
32
33
34 #include <stdio.h>
35
36 #include "DNA_node_types.h"
37 #include "DNA_scene_types.h"
38
39 #include "BKE_context.h"
40
41 #include "BLI_rect.h"
42 #include "BLI_utildefines.h"
43
44 #include "ED_screen.h"
45 #include "ED_types.h"
46
47 #include "RNA_access.h"
48 #include "RNA_define.h"
49
50 #include "WM_api.h"
51 #include "WM_types.h"
52
53 #include "UI_view2d.h"
54  
55 #include "node_intern.h"
56
57 /* ****** helpers ****** */
58
59 static bNode *node_under_mouse(bNodeTree *ntree, int mx, int my)
60 {
61         bNode *node;
62         
63         for(next_node(ntree); (node=next_node(NULL));) {
64                 /* node body (header and scale are in other operators) */
65                 if (BLI_in_rctf(&node->totr, mx, my))
66                         return node;
67         }
68         return NULL;
69 }
70
71 /* ****** Click Select ****** */
72  
73 static bNode *node_mouse_select(SpaceNode *snode, ARegion *ar, short *mval, short extend)
74 {
75         bNode *node;
76         float mx, my;
77         
78         /* get mouse coordinates in view2d space */
79         mx= (float)mval[0];
80         my= (float)mval[1];
81         
82         UI_view2d_region_to_view(&ar->v2d, mval[0], mval[1], &mx, &my);
83         
84         /* find the closest visible node */
85         node = node_under_mouse(snode->edittree, mx, my);
86         
87         if (node) {
88                 if (extend == 0) {
89                         node_deselectall(snode);
90                         node->flag |= SELECT;
91                 }
92                 else
93                         node->flag ^= SELECT;
94                         
95                 node_set_active(snode, node);
96         }
97
98         return node;
99 }
100
101 static int node_select_exec(bContext *C, wmOperator *op)
102 {
103         SpaceNode *snode= CTX_wm_space_node(C);
104         ARegion *ar= CTX_wm_region(C);
105         short mval[2];
106         short extend;
107         bNode *node= NULL;
108         
109         /* get settings from RNA properties for operator */
110         mval[0] = RNA_int_get(op->ptr, "mouse_x");
111         mval[1] = RNA_int_get(op->ptr, "mouse_y");
112         
113         extend = RNA_boolean_get(op->ptr, "extend");
114         
115         /* perform the select */
116         node= node_mouse_select(snode, ar, mval, extend);
117         
118         /* send notifiers */
119         WM_event_add_notifier(C, NC_NODE|NA_SELECTED, NULL);
120         
121         /* allow tweak event to work too */
122         return OPERATOR_FINISHED|OPERATOR_PASS_THROUGH;
123 }
124
125 static int node_select_invoke(bContext *C, wmOperator *op, wmEvent *event)
126 {
127         ARegion *ar= CTX_wm_region(C);
128         short mval[2];  
129         
130         mval[0]= event->x - ar->winrct.xmin;
131         mval[1]= event->y - ar->winrct.ymin;
132         
133         RNA_int_set(op->ptr, "mouse_x", mval[0]);
134         RNA_int_set(op->ptr, "mouse_y", mval[1]);
135
136         return node_select_exec(C,op);
137 }
138
139
140 void NODE_OT_select(wmOperatorType *ot)
141 {
142         /* identifiers */
143         ot->name= "Select";
144         ot->idname= "NODE_OT_select";
145         ot->description= "Select node under cursor";
146         
147         /* api callbacks */
148         ot->invoke= node_select_invoke;
149         ot->poll= ED_operator_node_active;
150         
151         /* flags */
152         ot->flag= OPTYPE_REGISTER|OPTYPE_UNDO;
153         
154         /* properties */
155         RNA_def_int(ot->srna, "mouse_x", 0, INT_MIN, INT_MAX, "Mouse X", "", INT_MIN, INT_MAX);
156         RNA_def_int(ot->srna, "mouse_y", 0, INT_MIN, INT_MAX, "Mouse Y", "", INT_MIN, INT_MAX);
157         RNA_def_boolean(ot->srna, "extend", 0, "Extend", "");
158 }
159
160 /* ****** Border Select ****** */
161
162 static int node_borderselect_exec(bContext *C, wmOperator *op)
163 {
164         SpaceNode *snode= CTX_wm_space_node(C);
165         ARegion *ar= CTX_wm_region(C);
166         bNode *node;
167         rcti rect;
168         rctf rectf;
169         int gesture_mode= RNA_int_get(op->ptr, "gesture_mode");
170         
171         rect.xmin= RNA_int_get(op->ptr, "xmin");
172         rect.ymin= RNA_int_get(op->ptr, "ymin");
173         UI_view2d_region_to_view(&ar->v2d, rect.xmin, rect.ymin, &rectf.xmin, &rectf.ymin);
174         
175         rect.xmax= RNA_int_get(op->ptr, "xmax");
176         rect.ymax= RNA_int_get(op->ptr, "ymax");
177         UI_view2d_region_to_view(&ar->v2d, rect.xmax, rect.ymax, &rectf.xmax, &rectf.ymax);
178         
179         for(node= snode->edittree->nodes.first; node; node= node->next) {
180                 if(BLI_isect_rctf(&rectf, &node->totr, NULL)) {
181                         if(gesture_mode==GESTURE_MODAL_SELECT)
182                                 node->flag |= SELECT;
183                         else
184                                 node->flag &= ~SELECT;
185                 }
186         }
187         
188         WM_event_add_notifier(C, NC_NODE|NA_SELECTED, NULL);
189
190         return OPERATOR_FINISHED;
191 }
192
193 static int node_border_select_invoke(bContext *C, wmOperator *op, wmEvent *event)
194 {
195         int tweak = RNA_boolean_get(op->ptr, "tweak");
196         
197         if (tweak) {
198                 /* prevent initiating the border select if the mouse is over a node */
199                 /* this allows border select on empty space, but drag-translate on nodes */
200                 SpaceNode *snode= CTX_wm_space_node(C);
201                 ARegion *ar= CTX_wm_region(C);
202                 short mval[2];
203                 float mx, my;
204                 
205                 mval[0]= event->x - ar->winrct.xmin;
206                 mval[1]= event->y - ar->winrct.ymin;
207                 
208                 /* get mouse coordinates in view2d space */
209                 mx= (float)mval[0];
210                 my= (float)mval[1];
211                 
212                 UI_view2d_region_to_view(&ar->v2d, mval[0], mval[1], &mx, &my);
213                 
214                 if (node_under_mouse(snode->edittree, mx, my))
215                         return OPERATOR_CANCELLED|OPERATOR_PASS_THROUGH;
216         }
217         
218         return WM_border_select_invoke(C, op, event);
219 }
220
221 void NODE_OT_select_border(wmOperatorType *ot)
222 {
223         /* identifiers */
224         ot->name= "Border Select";
225         ot->idname= "NODE_OT_select_border";
226         ot->description= "Use box selection to select nodes";
227         
228         /* api callbacks */
229         ot->invoke= node_border_select_invoke;
230         ot->exec= node_borderselect_exec;
231         ot->modal= WM_border_select_modal;
232         
233         ot->poll= ED_operator_node_active;
234         
235         /* flags */
236         ot->flag= OPTYPE_REGISTER|OPTYPE_UNDO;
237         
238         /* rna */
239         WM_operator_properties_gesture_border(ot, FALSE);
240         RNA_def_boolean(ot->srna, "tweak", 0, "Tweak", "Only activate when mouse is not over a node - useful for tweak gesture");
241 }
242
243 /* ****** Select/Deselect All ****** */
244
245 static int node_select_all_exec(bContext *C, wmOperator *UNUSED(op))
246 {
247         SpaceNode *snode = CTX_wm_space_node(C);
248         bNode *first = snode->edittree->nodes.first;
249         bNode *node;
250         int count= 0;
251
252         for(node=first; node; node=node->next)
253                 if(node->flag & NODE_SELECT)
254                         count++;
255
256         if(count) {
257                 for(node=first; node; node=node->next)
258                         node->flag &= ~NODE_SELECT;
259         }
260         else {
261                 for(node=first; node; node=node->next)
262                         node->flag |= NODE_SELECT;
263         }
264         
265         WM_event_add_notifier(C, NC_NODE|NA_SELECTED, NULL);
266         return OPERATOR_FINISHED;
267 }
268
269 void NODE_OT_select_all(wmOperatorType *ot)
270 {
271         /* identifiers */
272         ot->name = "Select or Deselect All";
273         ot->description = "(De)select all nodes";
274         ot->idname = "NODE_OT_select_all";
275         
276         /* api callbacks */
277         ot->exec = node_select_all_exec;
278         ot->poll = ED_operator_node_active;
279         
280         /* flags */
281         ot->flag = OPTYPE_REGISTER|OPTYPE_UNDO;
282 }
283
284 /* ****** Select Linked To ****** */
285
286 static int node_select_linked_to_exec(bContext *C, wmOperator *UNUSED(op))
287 {
288         SpaceNode *snode = CTX_wm_space_node(C);
289         bNodeLink *link;
290         bNode *node;
291         
292         for (node=snode->edittree->nodes.first; node; node=node->next)
293                 node->flag &= ~NODE_TEST;
294
295         for (link=snode->edittree->links.first; link; link=link->next) {
296                 if (link->fromnode && link->tonode && (link->fromnode->flag & NODE_SELECT))
297                         link->tonode->flag |= NODE_TEST;
298         }
299         
300         for (node=snode->edittree->nodes.first; node; node=node->next) {
301                 if (node->flag & NODE_TEST)
302                         node->flag |= NODE_SELECT;
303         }
304         
305         WM_event_add_notifier(C, NC_NODE|NA_SELECTED, NULL);
306         return OPERATOR_FINISHED;
307 }
308
309 void NODE_OT_select_linked_to(wmOperatorType *ot)
310 {
311         /* identifiers */
312         ot->name = "Select Linked To";
313         ot->description = "Select nodes linked to the selected ones";
314         ot->idname = "NODE_OT_select_linked_to";
315         
316         /* api callbacks */
317         ot->exec = node_select_linked_to_exec;
318         ot->poll = ED_operator_node_active;
319         
320         /* flags */
321         ot->flag = OPTYPE_REGISTER|OPTYPE_UNDO;
322 }
323
324 /* ****** Select Linked From ****** */
325
326 static int node_select_linked_from_exec(bContext *C, wmOperator *UNUSED(op))
327 {
328         SpaceNode *snode = CTX_wm_space_node(C);
329         bNodeLink *link;
330         bNode *node;
331         
332         for(node=snode->edittree->nodes.first; node; node=node->next)
333                 node->flag &= ~NODE_TEST;
334
335         for(link=snode->edittree->links.first; link; link=link->next) {
336                 if(link->fromnode && link->tonode && (link->tonode->flag & NODE_SELECT))
337                         link->fromnode->flag |= NODE_TEST;
338         }
339         
340         for(node=snode->edittree->nodes.first; node; node=node->next) {
341                 if(node->flag & NODE_TEST)
342                         node->flag |= NODE_SELECT;
343         }
344         
345         WM_event_add_notifier(C, NC_NODE|NA_SELECTED, NULL);
346         return OPERATOR_FINISHED;
347 }
348
349 void NODE_OT_select_linked_from(wmOperatorType *ot)
350 {
351         /* identifiers */
352         ot->name = "Select Linked From";
353         ot->description = "Select nodes linked from the selected ones";
354         ot->idname = "NODE_OT_select_linked_from";
355         
356         /* api callbacks */
357         ot->exec = node_select_linked_from_exec;
358         ot->poll = ED_operator_node_active;
359         
360         /* flags */
361         ot->flag = OPTYPE_REGISTER|OPTYPE_UNDO;
362 }
363
364 /* ****** Select Same Type ****** */
365
366 static int node_select_same_type_exec(bContext *C, wmOperator *UNUSED(op))
367 {
368         SpaceNode *snode = CTX_wm_space_node(C);
369
370         node_select_same_type(snode);
371         WM_event_add_notifier(C, NC_NODE|NA_SELECTED, NULL);
372         return OPERATOR_FINISHED;
373 }
374
375 void NODE_OT_select_same_type(wmOperatorType *ot)
376 {
377         /* identifiers */
378         ot->name = "Select Same Type";
379         ot->description = "Select all the same type";
380         ot->idname = "NODE_OT_select_same_type";
381         
382         /* api callbacks */
383         ot->exec = node_select_same_type_exec;
384         ot->poll = ED_operator_node_active;
385         
386         /* flags */
387         ot->flag = OPTYPE_REGISTER|OPTYPE_UNDO;
388 }
389
390 /* ****** Select The Next/Prev Node Of The Same Type ****** */
391
392 static int node_select_same_type_next_exec(bContext *C, wmOperator *UNUSED(op))
393 {
394         SpaceNode *snode = CTX_wm_space_node(C);
395
396         node_select_same_type_np(snode, 0);
397         WM_event_add_notifier(C, NC_NODE|NA_SELECTED, NULL);
398         return OPERATOR_FINISHED;
399 }
400
401 void NODE_OT_select_same_type_next(wmOperatorType *ot)
402 {
403         /* identifiers */
404         ot->name = "Select Same Type Next";
405         ot->description = "Select the next node of the same type.";
406         ot->idname = "NODE_OT_select_same_type_next";
407         
408         /* api callbacks */
409         ot->exec = node_select_same_type_next_exec;
410         ot->poll = ED_operator_node_active;
411         
412         /* flags */
413         ot->flag = OPTYPE_REGISTER|OPTYPE_UNDO;
414 }
415
416 static int node_select_same_type_prev_exec(bContext *C, wmOperator *UNUSED(op))
417 {
418         SpaceNode *snode = CTX_wm_space_node(C);
419
420         node_select_same_type_np(snode, 1);
421         WM_event_add_notifier(C, NC_NODE|NA_SELECTED, NULL);
422         return OPERATOR_FINISHED;
423 }
424
425 void NODE_OT_select_same_type_prev(wmOperatorType *ot)
426 {
427         /* identifiers */
428         ot->name = "Select Same Type Prev";
429         ot->description = "Select the prev node of the same type.";
430         ot->idname = "NODE_OT_select_same_type_prev";
431         
432         /* api callbacks */
433         ot->exec = node_select_same_type_prev_exec;
434         ot->poll = ED_operator_node_active;
435         
436         /* flags */
437         ot->flag = OPTYPE_REGISTER|OPTYPE_UNDO;
438 }