graph_ops.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
 *
 * ***** END GPL LICENSE BLOCK *****
 */

#include <stdlib.h>
#include <math.h>

#include "DNA_scene_types.h"
#include "DNA_anim_types.h"

#include "BLI_blenlib.h"
#include "BLI_utildefines.h"

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

#include "UI_view2d.h"

#include "ED_anim_api.h"
#include "ED_markers.h"
#include "ED_screen.h"
#include "ED_transform.h"

#include "graph_intern.h"

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

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

/* ************************** view-based operators **********************************/
// XXX should these really be here?

/* Set Cursor --------------------------------------------------------------------- */
/* The 'cursor' in the Graph Editor consists of two parts:
 *  1) Current Frame Indicator (as per ANIM_OT_change_frame)
 *  2) Value Indicator (stored per Graph Editor instance)
 */

/* Set the new frame number */
static void graphview_cursor_apply(bContext *C, wmOperator *op)
{
    Main *bmain= CTX_data_main(C);
    Scene *scene= CTX_data_scene(C);
    SpaceIpo *sipo= CTX_wm_space_graph(C);
    
    /* adjust the frame 
     * NOTE: sync this part of the code with ANIM_OT_change_frame
     */
    CFRA= RNA_int_get(op->ptr, "frame");
    SUBFRA=0.f;
    sound_seek_scene(bmain, scene);
    
    /* set the cursor value */
    sipo->cursorVal= RNA_float_get(op->ptr, "value");
    
    /* send notifiers - notifiers for frame should force an update for both vars ok... */
    WM_event_add_notifier(C, NC_SCENE|ND_FRAME, scene);
}

/* ... */

/* Non-modal callback for running operator without user input */
static int graphview_cursor_exec(bContext *C, wmOperator *op)
{
    graphview_cursor_apply(C, op);
    return OPERATOR_FINISHED;
}

/* ... */

/* set the operator properties from the initial event */
static void graphview_cursor_setprops(bContext *C, wmOperator *op, wmEvent *event)
{
    ARegion *ar= CTX_wm_region(C);
    float viewx, viewy;

    /* abort if not active region (should not really be possible) */
    if (ar == NULL)
        return;

    /* convert from region coordinates to View2D 'tot' space */
    UI_view2d_region_to_view(&ar->v2d, event->mval[0], event->mval[1], &viewx, &viewy);
    
    /* store the values in the operator properties */
        /* frame is rounded to the nearest int, since frames are ints */
    RNA_int_set(op->ptr, "frame", (int)floor(viewx+0.5f));
    RNA_float_set(op->ptr, "value", viewy);
}

/* Modal Operator init */
static int graphview_cursor_invoke(bContext *C, wmOperator *op, wmEvent *event)
{
    /* Change to frame that mouse is over before adding modal handler,
     * as user could click on a single frame (jump to frame) as well as
     * click-dragging over a range (modal scrubbing).
     */
    graphview_cursor_setprops(C, op, event);
    
    /* apply these changes first */
    graphview_cursor_apply(C, op);
    
    /* add temp handler */
    WM_event_add_modal_handler(C, op);
    return OPERATOR_RUNNING_MODAL;
}

/* Modal event handling of cursor changing */
static int graphview_cursor_modal(bContext *C, wmOperator *op, wmEvent *event)
{
    /* execute the events */
    switch (event->type) {
        case ESCKEY:
            return OPERATOR_FINISHED;
        
        case MOUSEMOVE:
            /* set the new values */
            graphview_cursor_setprops(C, op, event);
            graphview_cursor_apply(C, op);
            break;
        
        case LEFTMOUSE: 
        case RIGHTMOUSE:
            /* we check for either mouse-button to end, as checking for ACTIONMOUSE (which is used to init 
             * the modal op) doesn't work for some reason
             */
            if (event->val==KM_RELEASE)
                return OPERATOR_FINISHED;
            break;
    }

    return OPERATOR_RUNNING_MODAL;
}

static void GRAPH_OT_cursor_set(wmOperatorType *ot)
{
    /* identifiers */
    ot->name= "Set Cursor";
    ot->idname= "GRAPH_OT_cursor_set";
    ot->description= "Interactively set the current frame number and value cursor";
    
    /* api callbacks */
    ot->exec= graphview_cursor_exec;
    ot->invoke= graphview_cursor_invoke;
    ot->modal= graphview_cursor_modal;
    ot->poll= ED_operator_graphedit_active;
    
    /* flags */
    ot->flag= OPTYPE_BLOCKING|OPTYPE_UNDO;

    /* rna */
    RNA_def_int(ot->srna, "frame", 0, MINAFRAME, MAXFRAME, "Frame", "", MINAFRAME, MAXFRAME);
    RNA_def_float(ot->srna, "value", 0, FLT_MIN, FLT_MAX, "Value", "", -100.0f, 100.0f);
}

/* ************************** registration - operator types **********************************/

void graphedit_operatortypes(void)
{
    /* view */
    WM_operatortype_append(GRAPH_OT_cursor_set);
    
    WM_operatortype_append(GRAPH_OT_previewrange_set);
    WM_operatortype_append(GRAPH_OT_view_all);
    WM_operatortype_append(GRAPH_OT_view_selected);
    WM_operatortype_append(GRAPH_OT_properties);
    
    WM_operatortype_append(GRAPH_OT_ghost_curves_create);
    WM_operatortype_append(GRAPH_OT_ghost_curves_clear);
    
    /* keyframes */
        /* selection */
    WM_operatortype_append(GRAPH_OT_clickselect);
    WM_operatortype_append(GRAPH_OT_select_all_toggle);
    WM_operatortype_append(GRAPH_OT_select_border);
    WM_operatortype_append(GRAPH_OT_select_column);
    WM_operatortype_append(GRAPH_OT_select_linked);
    WM_operatortype_append(GRAPH_OT_select_more);
    WM_operatortype_append(GRAPH_OT_select_less);
    WM_operatortype_append(GRAPH_OT_select_leftright);
    
        /* editing */
    WM_operatortype_append(GRAPH_OT_snap);
    WM_operatortype_append(GRAPH_OT_mirror);
    WM_operatortype_append(GRAPH_OT_frame_jump);
    WM_operatortype_append(GRAPH_OT_handle_type);
    WM_operatortype_append(GRAPH_OT_interpolation_type);
    WM_operatortype_append(GRAPH_OT_extrapolation_type);
    WM_operatortype_append(GRAPH_OT_sample);
    WM_operatortype_append(GRAPH_OT_bake);
    WM_operatortype_append(GRAPH_OT_sound_bake);
    WM_operatortype_append(GRAPH_OT_smooth);
    WM_operatortype_append(GRAPH_OT_clean);
    WM_operatortype_append(GRAPH_OT_euler_filter);
    WM_operatortype_append(GRAPH_OT_delete);
    WM_operatortype_append(GRAPH_OT_duplicate);
    
    WM_operatortype_append(GRAPH_OT_copy);
    WM_operatortype_append(GRAPH_OT_paste);
    
    WM_operatortype_append(GRAPH_OT_keyframe_insert);
    WM_operatortype_append(GRAPH_OT_click_insert);
    
    /* F-Curve Modifiers */
    WM_operatortype_append(GRAPH_OT_fmodifier_add);
    WM_operatortype_append(GRAPH_OT_fmodifier_copy);
    WM_operatortype_append(GRAPH_OT_fmodifier_paste);
}

void ED_operatormacros_graph(void)
{
    wmOperatorType *ot;
    wmOperatorTypeMacro *otmacro;
    
    ot= WM_operatortype_append_macro("GRAPH_OT_duplicate_move", "Duplicate", OPTYPE_UNDO|OPTYPE_REGISTER);
    if (ot) {
        ot->description= "Make a copy of all selected keyframes and move them";
        WM_operatortype_macro_define(ot, "GRAPH_OT_duplicate");
        otmacro= WM_operatortype_macro_define(ot, "TRANSFORM_OT_transform");
        RNA_enum_set(otmacro->ptr, "mode", TFM_TIME_DUPLICATE);
    }
}


/* ************************** registration - keymaps **********************************/

static void graphedit_keymap_keyframes (wmKeyConfig *keyconf, wmKeyMap *keymap)
{
    wmKeyMapItem *kmi;
    
    /* view */
    kmi = WM_keymap_add_item(keymap, "WM_OT_context_toggle", HKEY, KM_PRESS, KM_CTRL, 0);
    RNA_string_set(kmi->ptr, "data_path", "space_data.show_handles");

        /* NOTE: 'ACTIONMOUSE' not 'LEFTMOUSE', as user may have swapped mouse-buttons
         * This keymap is supposed to override ANIM_OT_change_frame, which does the same except it doesn't do y-values
         */
    WM_keymap_add_item(keymap, "GRAPH_OT_cursor_set", ACTIONMOUSE, KM_PRESS, 0, 0);
    
    
    /* graph_select.c - selection tools */
        /* click-select */
    kmi = WM_keymap_add_item(keymap, "GRAPH_OT_clickselect", SELECTMOUSE, KM_PRESS, 0, 0);
        RNA_boolean_set(kmi->ptr, "extend", FALSE);
        RNA_boolean_set(kmi->ptr, "curves", FALSE);
        RNA_boolean_set(kmi->ptr, "column", FALSE);
    kmi= WM_keymap_add_item(keymap, "GRAPH_OT_clickselect", SELECTMOUSE, KM_PRESS, KM_ALT, 0);
        RNA_boolean_set(kmi->ptr, "extend", FALSE);
        RNA_boolean_set(kmi->ptr, "curves", FALSE);
        RNA_boolean_set(kmi->ptr, "column", TRUE);
    kmi= WM_keymap_add_item(keymap, "GRAPH_OT_clickselect", SELECTMOUSE, KM_PRESS, KM_SHIFT, 0);
        RNA_boolean_set(kmi->ptr, "extend", TRUE);
        RNA_boolean_set(kmi->ptr, "curves", FALSE);
        RNA_boolean_set(kmi->ptr, "column", FALSE);
    kmi= WM_keymap_add_item(keymap, "GRAPH_OT_clickselect", SELECTMOUSE, KM_PRESS, KM_ALT|KM_SHIFT, 0);
        RNA_boolean_set(kmi->ptr, "extend", TRUE);
        RNA_boolean_set(kmi->ptr, "curves", FALSE);
        RNA_boolean_set(kmi->ptr, "column", TRUE);
    kmi= WM_keymap_add_item(keymap, "GRAPH_OT_clickselect", SELECTMOUSE, KM_PRESS, KM_CTRL|KM_ALT, 0);
        RNA_boolean_set(kmi->ptr, "extend", FALSE);
        RNA_boolean_set(kmi->ptr, "curves", TRUE);
        RNA_boolean_set(kmi->ptr, "column", FALSE);
    kmi= WM_keymap_add_item(keymap, "GRAPH_OT_clickselect", SELECTMOUSE, KM_PRESS, KM_CTRL|KM_ALT|KM_SHIFT, 0);
        RNA_boolean_set(kmi->ptr, "extend", TRUE);
        RNA_boolean_set(kmi->ptr, "curves", TRUE);
        RNA_boolean_set(kmi->ptr, "column", FALSE);
    
    /* select left/right */
    kmi = WM_keymap_add_item(keymap, "GRAPH_OT_select_leftright", SELECTMOUSE, KM_PRESS, KM_CTRL, 0);
        RNA_boolean_set(kmi->ptr, "extend", FALSE);
        RNA_enum_set(kmi->ptr, "mode", GRAPHKEYS_LRSEL_TEST);
    kmi= WM_keymap_add_item(keymap, "GRAPH_OT_select_leftright", SELECTMOUSE, KM_PRESS, KM_CTRL|KM_SHIFT, 0);
        RNA_boolean_set(kmi->ptr, "extend", TRUE);
        RNA_enum_set(kmi->ptr, "mode", GRAPHKEYS_LRSEL_TEST);
    
    kmi= WM_keymap_add_item(keymap, "GRAPH_OT_select_leftright", LEFTBRACKETKEY, KM_PRESS, 0, 0);
        RNA_boolean_set(kmi->ptr, "extend", FALSE);
        RNA_enum_set(kmi->ptr, "mode", GRAPHKEYS_LRSEL_LEFT);
    kmi= WM_keymap_add_item(keymap, "GRAPH_OT_select_leftright", RIGHTBRACKETKEY, KM_PRESS, 0, 0);
        RNA_boolean_set(kmi->ptr, "extend", FALSE);
        RNA_enum_set(kmi->ptr, "mode", GRAPHKEYS_LRSEL_RIGHT);
    
        /* deselect all */
    kmi = WM_keymap_add_item(keymap, "GRAPH_OT_select_all_toggle", AKEY, KM_PRESS, 0, 0);
        RNA_boolean_set(kmi->ptr, "invert", FALSE);
    kmi = WM_keymap_add_item(keymap, "GRAPH_OT_select_all_toggle", IKEY, KM_PRESS, KM_CTRL, 0);
        RNA_boolean_set(kmi->ptr, "invert", TRUE);
    
        /* borderselect */
    kmi = WM_keymap_add_item(keymap, "GRAPH_OT_select_border", BKEY, KM_PRESS, 0, 0);
        RNA_boolean_set(kmi->ptr, "axis_range", FALSE);
        RNA_boolean_set(kmi->ptr, "include_handles", FALSE);
    kmi = WM_keymap_add_item(keymap, "GRAPH_OT_select_border", BKEY, KM_PRESS, KM_ALT, 0);
        RNA_boolean_set(kmi->ptr, "axis_range", TRUE);
        RNA_boolean_set(kmi->ptr, "include_handles", FALSE);
        
    kmi = WM_keymap_add_item(keymap, "GRAPH_OT_select_border", BKEY, KM_PRESS, KM_CTRL, 0);
        RNA_boolean_set(kmi->ptr, "axis_range", FALSE);
        RNA_boolean_set(kmi->ptr, "include_handles", TRUE);
    kmi = WM_keymap_add_item(keymap, "GRAPH_OT_select_border", BKEY, KM_PRESS, KM_CTRL|KM_ALT, 0);
        RNA_boolean_set(kmi->ptr, "axis_range", TRUE);
        RNA_boolean_set(kmi->ptr, "include_handles", TRUE);
        
        /* column select */
    RNA_enum_set(WM_keymap_add_item(keymap, "GRAPH_OT_select_column", KKEY, KM_PRESS, 0, 0)->ptr, "mode", GRAPHKEYS_COLUMNSEL_KEYS);
    RNA_enum_set(WM_keymap_add_item(keymap, "GRAPH_OT_select_column", KKEY, KM_PRESS, KM_CTRL, 0)->ptr, "mode", GRAPHKEYS_COLUMNSEL_CFRA);
    RNA_enum_set(WM_keymap_add_item(keymap, "GRAPH_OT_select_column", KKEY, KM_PRESS, KM_SHIFT, 0)->ptr, "mode", GRAPHKEYS_COLUMNSEL_MARKERS_COLUMN);
    RNA_enum_set(WM_keymap_add_item(keymap, "GRAPH_OT_select_column", KKEY, KM_PRESS, KM_ALT, 0)->ptr, "mode", GRAPHKEYS_COLUMNSEL_MARKERS_BETWEEN);
    
        /* select more/less */
    WM_keymap_add_item(keymap, "GRAPH_OT_select_more", PADPLUSKEY, KM_PRESS, KM_CTRL, 0);
    WM_keymap_add_item(keymap, "GRAPH_OT_select_less", PADMINUS, KM_PRESS, KM_CTRL, 0);
    
        /* select linked */
    WM_keymap_add_item(keymap, "GRAPH_OT_select_linked", LKEY, KM_PRESS, 0, 0);
    
    
    /* graph_edit.c */
        /* snap - current frame to selected keys */
        // TODO: maybe since this is called jump, we're better to have it on <something>-J?
    WM_keymap_add_item(keymap, "GRAPH_OT_frame_jump", SKEY, KM_PRESS, KM_CTRL|KM_SHIFT, 0);
        
        /* menu + single-step transform */
    WM_keymap_add_item(keymap, "GRAPH_OT_snap", SKEY, KM_PRESS, KM_SHIFT, 0);
    WM_keymap_add_item(keymap, "GRAPH_OT_mirror", MKEY, KM_PRESS, KM_SHIFT, 0);
    
    WM_keymap_add_item(keymap, "GRAPH_OT_handle_type", VKEY, KM_PRESS, 0, 0);

    WM_keymap_add_item(keymap, "GRAPH_OT_interpolation_type", TKEY, KM_PRESS, 0, 0);
    
        /* destructive */
    WM_keymap_add_item(keymap, "GRAPH_OT_clean", OKEY, KM_PRESS, 0, 0);
    WM_keymap_add_item(keymap, "GRAPH_OT_smooth", OKEY, KM_PRESS, KM_ALT, 0);
    WM_keymap_add_item(keymap, "GRAPH_OT_sample", OKEY, KM_PRESS, KM_SHIFT, 0);
    
    WM_keymap_add_item(keymap, "GRAPH_OT_bake", CKEY, KM_PRESS, KM_ALT, 0);
    
    WM_keymap_add_item(keymap, "GRAPH_OT_delete", XKEY, KM_PRESS, 0, 0);
    WM_keymap_add_item(keymap, "GRAPH_OT_delete", DELKEY, KM_PRESS, 0, 0);
    
    WM_keymap_add_item(keymap, "GRAPH_OT_duplicate_move", DKEY, KM_PRESS, KM_SHIFT, 0);
    
        /* insertkey */
    WM_keymap_add_item(keymap, "GRAPH_OT_keyframe_insert", IKEY, KM_PRESS, 0, 0);
    WM_keymap_add_item(keymap, "GRAPH_OT_click_insert", LEFTMOUSE, KM_CLICK, KM_CTRL, 0);
    
        /* copy/paste */
    WM_keymap_add_item(keymap, "GRAPH_OT_copy", CKEY, KM_PRESS, KM_CTRL, 0);
    WM_keymap_add_item(keymap, "GRAPH_OT_paste", VKEY, KM_PRESS, KM_CTRL, 0);
    
        /* auto-set range */
    WM_keymap_add_item(keymap, "GRAPH_OT_previewrange_set", PKEY, KM_PRESS, KM_CTRL|KM_ALT, 0);
    WM_keymap_add_item(keymap, "GRAPH_OT_view_all", HOMEKEY, KM_PRESS, 0, 0);
    WM_keymap_add_item(keymap, "GRAPH_OT_view_selected", PADPERIOD, KM_PRESS, 0, 0);
    
        /* F-Modifiers */
    kmi = WM_keymap_add_item(keymap, "GRAPH_OT_fmodifier_add", MKEY, KM_PRESS, KM_CTRL|KM_SHIFT, 0);
    RNA_boolean_set(kmi->ptr, "only_active", FALSE);
    
    /* animation module */
        /* channels list 
         * NOTE: these operators were originally for the channels list, but are added here too for convenience...
         */
    WM_keymap_add_item(keymap, "ANIM_OT_channels_editable_toggle", TABKEY, KM_PRESS, 0, 0);
    
    /* transform system */
    transform_keymap_for_space(keyconf, keymap, SPACE_IPO);
    
    /* special markers hotkeys for anim editors: see note in definition of this function */
    ED_marker_keymap_animedit_conflictfree(keymap);
}

/* --------------- */

void graphedit_keymap(wmKeyConfig *keyconf)
{
    wmKeyMap *keymap;
    
    /* keymap for all regions */
    keymap= WM_keymap_find(keyconf, "Graph Editor Generic", SPACE_IPO, 0);
    WM_keymap_add_item(keymap, "GRAPH_OT_properties", NKEY, KM_PRESS, 0, 0);
        /* extrapolation works on channels, not keys */
    WM_keymap_add_item(keymap, "GRAPH_OT_extrapolation_type", EKEY, KM_PRESS, KM_SHIFT, 0);

    /* channels */
    /* Channels are not directly handled by the Graph Editor module, but are inherited from the Animation module. 
     * All the relevant operations, keymaps, drawing, etc. can therefore all be found in that module instead, as these
     * are all used for the Graph Editor too.
     */
    
    /* keyframes */
    keymap= WM_keymap_find(keyconf, "Graph Editor", SPACE_IPO, 0);
    graphedit_keymap_keyframes(keyconf, keymap);
}