node_select.c

Go to the documentation of this file.

/*
 * ***** BEGIN GPL LICENSE BLOCK *****
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version. 
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 *
 * The Original Code is Copyright (C) 2008 Blender Foundation.
 * All rights reserved.
 *
 * 
 * Contributor(s): Blender Foundation, Nathan Letwory
 *
 * ***** END GPL LICENSE BLOCK *****
 */

#include <stdio.h>

#include "BLI_listbase.h"

#include "DNA_node_types.h"
#include "DNA_scene_types.h"

#include "BKE_context.h"
#include "BKE_main.h"

#include "BLI_rect.h"
#include "BLI_utildefines.h"

#include "ED_node.h"
#include "ED_screen.h"
#include "ED_types.h"

#include "RNA_access.h"
#include "RNA_define.h"

#include "WM_api.h"
#include "WM_types.h"

#include "UI_view2d.h"
 
#include "node_intern.h"

/* ****** helpers ****** */

static bNode *node_under_mouse(bNodeTree *ntree, int mx, int my)
{
    bNode *node;
    
    for(node=ntree->nodes.last; node; node=node->prev) {
        /* node body (header and scale are in other operators) */
        if (BLI_in_rctf(&node->totr, mx, my))
            return node;
    }
    return NULL;
}

static int compare_nodes(bNode *a, bNode *b)
{
    bNode *parent;
    /* These tell if either the node or any of the parent nodes is selected.
     * A selected parent means an unselected node is also in foreground!
     */
    int a_select=(a->flag & NODE_SELECT), b_select=(b->flag & NODE_SELECT);
    int a_active=(a->flag & NODE_ACTIVE), b_active=(b->flag & NODE_ACTIVE);
    
    /* if one is an ancestor of the other */
    /* XXX there might be a better sorting algorithm for stable topological sort, this is O(n^2) worst case */
    for (parent = a->parent; parent; parent=parent->parent) {
        /* if b is an ancestor, it is always behind a */
        if (parent==b)
            return 1;
        /* any selected ancestor moves the node forward */
        if (parent->flag & NODE_ACTIVE)
            a_active = 1;
        if (parent->flag & NODE_SELECT)
            a_select = 1;
    }
    for (parent = b->parent; parent; parent=parent->parent) {
        /* if a is an ancestor, it is always behind b */
        if (parent==a)
            return 0;
        /* any selected ancestor moves the node forward */
        if (parent->flag & NODE_ACTIVE)
            b_active = 1;
        if (parent->flag & NODE_SELECT)
            b_select = 1;
    }

    /* if one of the nodes is in the background and the other not */
    if ((a->flag & NODE_BACKGROUND) && !(b->flag & NODE_BACKGROUND))
        return 0;
    else if (!(a->flag & NODE_BACKGROUND) && (b->flag & NODE_BACKGROUND))
        return 1;
    
    /* if one has a higher selection state (active > selected > nothing) */
    if (!b_active && a_active)
        return 1;
    else if (!b_select && (a_active || a_select))
        return 1;
    
    return 0;
}

/* Sorts nodes by selection: unselected nodes first, then selected,
 * then the active node at the very end. Relative order is kept intact!
 */
static void node_sort(bNodeTree *ntree)
{
    /* merge sort is the algorithm of choice here */
    bNode *first_a, *first_b, *node_a, *node_b, *tmp;
    int totnodes= BLI_countlist(&ntree->nodes);
    int k, a, b;
    
    k = 1;
    while (k < totnodes) {
        first_a = first_b = ntree->nodes.first;
        
        do {
            /* setup first_b pointer */
            for (b=0; b < k && first_b; ++b) {
                first_b = first_b->next;
            }
            /* all batches merged? */
            if (first_b==NULL)
                break;
            
            /* merge batches */
            node_a = first_a;
            node_b = first_b;
            a = b = 0;
            while (a < k && b < k && node_b) {
                if (compare_nodes(node_a, node_b)==0) {
                    node_a = node_a->next;
                    ++a;
                }
                else {
                    tmp = node_b;
                    node_b = node_b->next;
                    ++b;
                    BLI_remlink(&ntree->nodes, tmp);
                    BLI_insertlinkbefore(&ntree->nodes, node_a, tmp);
                }
            }

            /* setup first pointers for next batch */
            first_b = node_b;
            for (; b < k; ++b) {
                /* all nodes sorted? */
                if (first_b==NULL)
                    break;
                first_b = first_b->next;
            }
            first_a = first_b;
        } while (first_b);
        
        k = k << 1;
    }
}

/* no undo here! */
void node_deselect_all(SpaceNode *snode)
{
    bNode *node;
    
    for(node= snode->edittree->nodes.first; node; node= node->next)
        node->flag &= ~SELECT;
}

/* return 1 if we need redraw otherwise zero. */
int node_select_same_type(SpaceNode *snode)
{
    bNode *nac, *p;
    int redraw;

    /* search for the active node. */
    for (nac= snode->edittree->nodes.first; nac; nac= nac->next) {
        if (nac->flag & SELECT)
            break;
    }

    /* no active node, return. */
    if (!nac)
        return(0);

    redraw= 0;
    for (p= snode->edittree->nodes.first; p; p= p->next) {
        if (p->type != nac->type && p->flag & SELECT) {
            /* if it's selected but different type, unselect */
            redraw= 1;
            p->flag &= ~SELECT;
        }
        else if (p->type == nac->type && (!(p->flag & SELECT))) {
            /* if it's the same type and is not selected, select! */
            redraw= 1;
            p->flag |= SELECT;
        }
    }
    return(redraw);
}

/* return 1 if we need redraw, otherwise zero.
 * dir can be 0 == next or 0 != prev.
 */
int node_select_same_type_np(SpaceNode *snode, int dir)
{
    bNode *nac, *p;

    /* search the active one. */
    for (nac= snode->edittree->nodes.first; nac; nac= nac->next) {
        if (nac->flag & SELECT)
            break;
    }

    /* no active node, return. */
    if (!nac)
        return(0);

    if (dir == 0)
        p= nac->next;
    else
        p= nac->prev;

    while (p) {
        /* Now search the next with the same type. */
        if (p->type == nac->type)
            break;

        if (dir == 0)
            p= p->next;
        else
            p= p->prev;
    }

    if (p) {
        node_deselect_all(snode);
        p->flag |= SELECT;
        return(1);
    }
    return(0);
}

void node_select_single(bContext *C, bNode *node)
{
    Main *bmain= CTX_data_main(C);
    SpaceNode *snode= CTX_wm_space_node(C);
    
    node_deselect_all(snode);
    node->flag |= SELECT;
    
    ED_node_set_active(bmain, snode->edittree, node);
    
    node_sort(snode->edittree);
    
    WM_event_add_notifier(C, NC_NODE|NA_SELECTED, NULL);
}

/* ****** Click Select ****** */
 
static bNode *node_mouse_select(Main *bmain, SpaceNode *snode, ARegion *ar, const int mval[2], short extend)
{
    bNode *node;
    float mx, my;
    
    /* get mouse coordinates in view2d space */
    mx= (float)mval[0];
    my= (float)mval[1];
    
    UI_view2d_region_to_view(&ar->v2d, mval[0], mval[1], &mx, &my);
    
    /* find the closest visible node */
    node = node_under_mouse(snode->edittree, mx, my);
    
    if (node) {
        if (extend == 0) {
            node_deselect_all(snode);
            node->flag |= SELECT;
        }
        else
            node->flag ^= SELECT;
        
        ED_node_set_active(bmain, snode->edittree, node);
        
        node_sort(snode->edittree);
    }

    return node;
}

static int node_select_exec(bContext *C, wmOperator *op)
{
    Main *bmain= CTX_data_main(C);
    SpaceNode *snode= CTX_wm_space_node(C);
    ARegion *ar= CTX_wm_region(C);
    int mval[2];
    short extend;
    /* bNode *node= NULL; */ /* UNUSED */
    
    /* get settings from RNA properties for operator */
    mval[0] = RNA_int_get(op->ptr, "mouse_x");
    mval[1] = RNA_int_get(op->ptr, "mouse_y");
    
    extend = RNA_boolean_get(op->ptr, "extend");
    
    /* perform the select */
    /* node= */ /* UNUSED*/ node_mouse_select(bmain, snode, ar, mval, extend);
    
    /* send notifiers */
    WM_event_add_notifier(C, NC_NODE|NA_SELECTED, NULL);
    
    /* allow tweak event to work too */
    return OPERATOR_FINISHED|OPERATOR_PASS_THROUGH;
}

static int node_select_invoke(bContext *C, wmOperator *op, wmEvent *event)
{
    RNA_int_set(op->ptr, "mouse_x", event->mval[0]);
    RNA_int_set(op->ptr, "mouse_y", event->mval[1]);

    return node_select_exec(C,op);
}


void NODE_OT_select(wmOperatorType *ot)
{
    /* identifiers */
    ot->name= "Select";
    ot->idname= "NODE_OT_select";
    ot->description= "Select the node under the cursor";
    
    /* api callbacks */
    ot->invoke= node_select_invoke;
    ot->poll= ED_operator_node_active;
    
    /* flags */
    ot->flag= OPTYPE_REGISTER|OPTYPE_UNDO;
    
    /* properties */
    RNA_def_int(ot->srna, "mouse_x", 0, INT_MIN, INT_MAX, "Mouse X", "", INT_MIN, INT_MAX);
    RNA_def_int(ot->srna, "mouse_y", 0, INT_MIN, INT_MAX, "Mouse Y", "", INT_MIN, INT_MAX);
    RNA_def_boolean(ot->srna, "extend", 0, "Extend", "");
}

/* ****** Border Select ****** */

static int node_borderselect_exec(bContext *C, wmOperator *op)
{
    SpaceNode *snode= CTX_wm_space_node(C);
    ARegion *ar= CTX_wm_region(C);
    bNode *node;
    rcti rect;
    rctf rectf;
    int gesture_mode= RNA_int_get(op->ptr, "gesture_mode");
    int extend= RNA_boolean_get(op->ptr, "extend");
    
    rect.xmin= RNA_int_get(op->ptr, "xmin");
    rect.ymin= RNA_int_get(op->ptr, "ymin");
    UI_view2d_region_to_view(&ar->v2d, rect.xmin, rect.ymin, &rectf.xmin, &rectf.ymin);
    
    rect.xmax= RNA_int_get(op->ptr, "xmax");
    rect.ymax= RNA_int_get(op->ptr, "ymax");
    UI_view2d_region_to_view(&ar->v2d, rect.xmax, rect.ymax, &rectf.xmax, &rectf.ymax);
    
    for(node= snode->edittree->nodes.first; node; node= node->next) {
        if(BLI_isect_rctf(&rectf, &node->totr, NULL)) {
            if(gesture_mode==GESTURE_MODAL_SELECT)
                node->flag |= SELECT;
            else
                node->flag &= ~SELECT;
        }
        else if(!extend) {
            node->flag &= ~SELECT;
        }
    }
    
    node_sort(snode->edittree);
    
    WM_event_add_notifier(C, NC_NODE|NA_SELECTED, NULL);

    return OPERATOR_FINISHED;
}

static int node_border_select_invoke(bContext *C, wmOperator *op, wmEvent *event)
{
    int tweak = RNA_boolean_get(op->ptr, "tweak");
    
    if (tweak) {
        /* prevent initiating the border select if the mouse is over a node */
        /* this allows border select on empty space, but drag-translate on nodes */
        SpaceNode *snode= CTX_wm_space_node(C);
        ARegion *ar= CTX_wm_region(C);
        float mx, my;

        UI_view2d_region_to_view(&ar->v2d, event->mval[0], event->mval[1], &mx, &my);
        
        if (node_under_mouse(snode->edittree, mx, my))
            return OPERATOR_CANCELLED|OPERATOR_PASS_THROUGH;
    }
    
    return WM_border_select_invoke(C, op, event);
}

void NODE_OT_select_border(wmOperatorType *ot)
{
    /* identifiers */
    ot->name= "Border Select";
    ot->idname= "NODE_OT_select_border";
    ot->description= "Use box selection to select nodes";
    
    /* api callbacks */
    ot->invoke= node_border_select_invoke;
    ot->exec= node_borderselect_exec;
    ot->modal= WM_border_select_modal;
    ot->cancel= WM_border_select_cancel;
    
    ot->poll= ED_operator_node_active;
    
    /* flags */
    ot->flag= OPTYPE_REGISTER|OPTYPE_UNDO;
    
    /* rna */
    WM_operator_properties_gesture_border(ot, TRUE);
    RNA_def_boolean(ot->srna, "tweak", 0, "Tweak", "Only activate when mouse is not over a node - useful for tweak gesture");
}

/* ****** Select/Deselect All ****** */

static int node_select_all_exec(bContext *C, wmOperator *UNUSED(op))
{
    SpaceNode *snode = CTX_wm_space_node(C);
    bNode *first = snode->edittree->nodes.first;
    bNode *node;
    int count= 0;

    for(node=first; node; node=node->next)
        if(node->flag & NODE_SELECT)
            count++;

    if(count) {
        for(node=first; node; node=node->next)
            node->flag &= ~NODE_SELECT;
    }
    else {
        for(node=first; node; node=node->next)
            node->flag |= NODE_SELECT;
    }
    
    node_sort(snode->edittree);
    
    WM_event_add_notifier(C, NC_NODE|NA_SELECTED, NULL);
    return OPERATOR_FINISHED;
}

void NODE_OT_select_all(wmOperatorType *ot)
{
    /* identifiers */
    ot->name = "Select or Deselect All";
    ot->description = "(De)select all nodes";
    ot->idname = "NODE_OT_select_all";
    
    /* api callbacks */
    ot->exec = node_select_all_exec;
    ot->poll = ED_operator_node_active;
    
    /* flags */
    ot->flag = OPTYPE_REGISTER|OPTYPE_UNDO;
}

/* ****** Select Linked To ****** */

static int node_select_linked_to_exec(bContext *C, wmOperator *UNUSED(op))
{
    SpaceNode *snode = CTX_wm_space_node(C);
    bNodeLink *link;
    bNode *node;
    
    for (node=snode->edittree->nodes.first; node; node=node->next)
        node->flag &= ~NODE_TEST;

    for (link=snode->edittree->links.first; link; link=link->next) {
        if (link->fromnode && link->tonode && (link->fromnode->flag & NODE_SELECT))
            link->tonode->flag |= NODE_TEST;
    }
    
    for (node=snode->edittree->nodes.first; node; node=node->next) {
        if (node->flag & NODE_TEST)
            node->flag |= NODE_SELECT;
    }
    
    node_sort(snode->edittree);
    
    WM_event_add_notifier(C, NC_NODE|NA_SELECTED, NULL);
    return OPERATOR_FINISHED;
}

void NODE_OT_select_linked_to(wmOperatorType *ot)
{
    /* identifiers */
    ot->name = "Select Linked To";
    ot->description = "Select nodes linked to the selected ones";
    ot->idname = "NODE_OT_select_linked_to";
    
    /* api callbacks */
    ot->exec = node_select_linked_to_exec;
    ot->poll = ED_operator_node_active;
    
    /* flags */
    ot->flag = OPTYPE_REGISTER|OPTYPE_UNDO;
}

/* ****** Select Linked From ****** */

static int node_select_linked_from_exec(bContext *C, wmOperator *UNUSED(op))
{
    SpaceNode *snode = CTX_wm_space_node(C);
    bNodeLink *link;
    bNode *node;
    
    for(node=snode->edittree->nodes.first; node; node=node->next)
        node->flag &= ~NODE_TEST;

    for(link=snode->edittree->links.first; link; link=link->next) {
        if(link->fromnode && link->tonode && (link->tonode->flag & NODE_SELECT))
            link->fromnode->flag |= NODE_TEST;
    }
    
    for(node=snode->edittree->nodes.first; node; node=node->next) {
        if(node->flag & NODE_TEST)
            node->flag |= NODE_SELECT;
    }
    
    node_sort(snode->edittree);
    
    WM_event_add_notifier(C, NC_NODE|NA_SELECTED, NULL);
    return OPERATOR_FINISHED;
}

void NODE_OT_select_linked_from(wmOperatorType *ot)
{
    /* identifiers */
    ot->name = "Select Linked From";
    ot->description = "Select nodes linked from the selected ones";
    ot->idname = "NODE_OT_select_linked_from";
    
    /* api callbacks */
    ot->exec = node_select_linked_from_exec;
    ot->poll = ED_operator_node_active;
    
    /* flags */
    ot->flag = OPTYPE_REGISTER|OPTYPE_UNDO;
}

/* ****** Select Same Type ****** */

static int node_select_same_type_exec(bContext *C, wmOperator *UNUSED(op))
{
    SpaceNode *snode = CTX_wm_space_node(C);

    node_select_same_type(snode);

    node_sort(snode->edittree);

    WM_event_add_notifier(C, NC_NODE|NA_SELECTED, NULL);
    return OPERATOR_FINISHED;
}

void NODE_OT_select_same_type(wmOperatorType *ot)
{
    /* identifiers */
    ot->name = "Select Same Type";
    ot->description = "Select all the nodes of the same type";
    ot->idname = "NODE_OT_select_same_type";
    
    /* api callbacks */
    ot->exec = node_select_same_type_exec;
    ot->poll = ED_operator_node_active;
    
    /* flags */
    ot->flag = OPTYPE_REGISTER|OPTYPE_UNDO;
}

/* ****** Select The Next/Prev Node Of The Same Type ****** */

static int node_select_same_type_next_exec(bContext *C, wmOperator *UNUSED(op))
{
    SpaceNode *snode = CTX_wm_space_node(C);

    node_select_same_type_np(snode, 0);

    node_sort(snode->edittree);

    WM_event_add_notifier(C, NC_NODE|NA_SELECTED, NULL);

    return OPERATOR_FINISHED;
}

void NODE_OT_select_same_type_next(wmOperatorType *ot)
{
    /* identifiers */
    ot->name = "Select Same Type Next";
    ot->description = "Select the next node of the same type";
    ot->idname = "NODE_OT_select_same_type_next";
    
    /* api callbacks */
    ot->exec = node_select_same_type_next_exec;
    ot->poll = ED_operator_node_active;
    
    /* flags */
    ot->flag = OPTYPE_REGISTER|OPTYPE_UNDO;
}

static int node_select_same_type_prev_exec(bContext *C, wmOperator *UNUSED(op))
{
    SpaceNode *snode = CTX_wm_space_node(C);

    node_select_same_type_np(snode, 1);

    node_sort(snode->edittree);

    WM_event_add_notifier(C, NC_NODE|NA_SELECTED, NULL);
    return OPERATOR_FINISHED;
}

void NODE_OT_select_same_type_prev(wmOperatorType *ot)
{
    /* identifiers */
    ot->name = "Select Same Type Prev";
    ot->description = "Select the prev node of the same type";
    ot->idname = "NODE_OT_select_same_type_prev";
    
    /* api callbacks */
    ot->exec = node_select_same_type_prev_exec;
    ot->poll = ED_operator_node_active;
    
    /* flags */
    ot->flag = OPTYPE_REGISTER|OPTYPE_UNDO;
}