bpy_rna_anim.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.
 *
 * Contributor(s): Campbell Barton
 *
 * ***** END GPL LICENSE BLOCK *****
 */

#include <Python.h>
#include <float.h> /* FLT_MIN/MAX */

#include "MEM_guardedalloc.h"

#include "BLI_string.h"

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

#include "BKE_report.h"
#include "BKE_context.h"
#include "BKE_animsys.h"
#include "BKE_fcurve.h"

#include "RNA_access.h"

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

#include "bpy_rna.h"
#include "bpy_util.h"
#include "bpy_rna_anim.h"

#define TRUE 1
#define FALSE 0

/* for keyframes and drivers */
static int pyrna_struct_anim_args_parse(
        PointerRNA *ptr, const char *error_prefix, const char *path,
        const char **path_full, int *index)
{
    const int is_idbase = RNA_struct_is_ID(ptr->type);
    PropertyRNA *prop;
    PointerRNA r_ptr;

    if (ptr->data == NULL) {
        PyErr_Format(PyExc_TypeError,
                     "%.200s this struct has no data, can't be animated",
                     error_prefix);
        return -1;
    }

    /* full paths can only be given from ID base */
    if (is_idbase) {
        int r_index = -1;
        if (RNA_path_resolve_full(ptr, path, &r_ptr, &prop, &r_index) == 0) {
            prop = NULL;
        }
        else if (r_index != -1) {
            PyErr_Format(PyExc_ValueError,
                         "%.200s path includes index, must be a separate argument",
                         error_prefix, path);
            return -1;
        }
        else if (ptr->id.data != r_ptr.id.data) {
            PyErr_Format(PyExc_ValueError,
                         "%.200s path spans ID blocks",
                         error_prefix, path);
            return -1;
        }
    }
    else {
        prop = RNA_struct_find_property(ptr, path);
        r_ptr = *ptr;
    }

    if (prop == NULL) {
        PyErr_Format(PyExc_TypeError,
                     "%.200s property \"%s\" not found",
                     error_prefix, path);
        return -1;
    }

    if (!RNA_property_animateable(&r_ptr, prop)) {
        PyErr_Format(PyExc_TypeError,
                     "%.200s property \"%s\" not animatable",
                     error_prefix, path);
        return -1;
    }

    if (RNA_property_array_check(prop) == 0) {
        if ((*index) == -1) {
            *index = 0;
        }
        else {
            PyErr_Format(PyExc_TypeError,
                         "%.200s index %d was given while property \"%s\" is not an array",
                         error_prefix, *index, path);
            return -1;
        }
    }
    else {
        int array_len = RNA_property_array_length(&r_ptr, prop);
        if ((*index) < -1 || (*index) >= array_len) {
            PyErr_Format(PyExc_TypeError,
                         "%.200s index out of range \"%s\", given %d, array length is %d",
                         error_prefix, path, *index, array_len);
            return -1;
        }
    }

    if (is_idbase) {
        *path_full = BLI_strdup(path);
    }
    else {
        *path_full = RNA_path_from_ID_to_property(&r_ptr, prop);

        if (*path_full == NULL) {
            PyErr_Format(PyExc_TypeError,
                         "%.200s could not make path to \"%s\"",
                         error_prefix, path);
            return -1;
        }
    }

    return 0;
}

/* internal use for insert and delete */
static int pyrna_struct_keyframe_parse(
        PointerRNA *ptr, PyObject *args, PyObject *kw, const char *parse_str, const char *error_prefix,
        const char **path_full, int *index, float *cfra, const char **group_name) /* return values */
{
    static const char *kwlist[] = {"data_path", "index", "frame", "group", NULL};
    const char *path;

    /* note, parse_str MUST start with 's|ifs' */
    if (!PyArg_ParseTupleAndKeywords(args, kw, parse_str, (char **)kwlist, &path, index, cfra, group_name))
        return -1;

    if (pyrna_struct_anim_args_parse(ptr, error_prefix, path, path_full, index) < 0)
        return -1;

    if (*cfra == FLT_MAX)
        *cfra = CTX_data_scene(BPy_GetContext())->r.cfra;

    return 0; /* success */
}

char pyrna_struct_keyframe_insert_doc[] =
".. method:: keyframe_insert(data_path, index=-1, frame=bpy.context.scene.frame_current, group=\"\")\n"
"\n"
"   Insert a keyframe on the property given, adding fcurves and animation data when necessary.\n"
"\n"
"   :arg data_path: path to the property to key, analogous to the fcurve's data path.\n"
"   :type data_path: string\n"
"   :arg index: array index of the property to key. Defaults to -1 which will key all indices or a single channel if the property is not an array.\n"
"   :type index: int\n"
"   :arg frame: The frame on which the keyframe is inserted, defaulting to the current frame.\n"
"   :type frame: float\n"
"   :arg group: The name of the group the F-Curve should be added to if it doesn't exist yet.\n"
"   :type group: str\n"
"   :return: Success of keyframe insertion.\n"
"   :rtype: boolean\n"
;
PyObject *pyrna_struct_keyframe_insert(BPy_StructRNA *self, PyObject *args, PyObject *kw)
{
    /* args, pyrna_struct_keyframe_parse handles these */
    const char *path_full = NULL;
    int index = -1;
    float cfra = FLT_MAX;
    const char *group_name = NULL;

    PYRNA_STRUCT_CHECK_OBJ(self);

    if (pyrna_struct_keyframe_parse(&self->ptr, args, kw,
                                   "s|ifs:bpy_struct.keyframe_insert()", "bpy_struct.keyframe_insert()",
                                   &path_full, &index, &cfra, &group_name) == -1)
    {
        return NULL;
    }
    else {
        short result;
        ReportList reports;

        BKE_reports_init(&reports, RPT_STORE);

        result = insert_keyframe(&reports, (ID *)self->ptr.id.data, NULL, group_name, path_full, index, cfra, 0);
        MEM_freeN((void *)path_full);

        if (BPy_reports_to_error(&reports, PyExc_RuntimeError, TRUE) == -1)
            return NULL;

        return PyBool_FromLong(result);
    }
}

char pyrna_struct_keyframe_delete_doc[] =
".. method:: keyframe_delete(data_path, index=-1, frame=bpy.context.scene.frame_current, group=\"\")\n"
"\n"
"   Remove a keyframe from this properties fcurve.\n"
"\n"
"   :arg data_path: path to the property to remove a key, analogous to the fcurve's data path.\n"
"   :type data_path: string\n"
"   :arg index: array index of the property to remove a key. Defaults to -1 removing all indices or a single channel if the property is not an array.\n"
"   :type index: int\n"
"   :arg frame: The frame on which the keyframe is deleted, defaulting to the current frame.\n"
"   :type frame: float\n"
"   :arg group: The name of the group the F-Curve should be added to if it doesn't exist yet.\n"
"   :type group: str\n"
"   :return: Success of keyframe deleation.\n"
"   :rtype: boolean\n"
;
PyObject *pyrna_struct_keyframe_delete(BPy_StructRNA *self, PyObject *args, PyObject *kw)
{
    /* args, pyrna_struct_keyframe_parse handles these */
    const char *path_full = NULL;
    int index = -1;
    float cfra = FLT_MAX;
    const char *group_name = NULL;

    PYRNA_STRUCT_CHECK_OBJ(self);

    if (pyrna_struct_keyframe_parse(&self->ptr, args, kw,
                                   "s|ifs:bpy_struct.keyframe_delete()",
                                   "bpy_struct.keyframe_insert()",
                                   &path_full, &index, &cfra, &group_name) == -1)
    {
        return NULL;
    }
    else {
        short result;
        ReportList reports;

        BKE_reports_init(&reports, RPT_STORE);

        result = delete_keyframe(&reports, (ID *)self->ptr.id.data, NULL, group_name, path_full, index, cfra, 0);
        MEM_freeN((void *)path_full);

        if (BPy_reports_to_error(&reports, PyExc_RuntimeError, TRUE) == -1)
            return NULL;

        return PyBool_FromLong(result);
    }

}

char pyrna_struct_driver_add_doc[] =
".. method:: driver_add(path, index=-1)\n"
"\n"
"   Adds driver(s) to the given property\n"
"\n"
"   :arg path: path to the property to drive, analogous to the fcurve's data path.\n"
"   :type path: string\n"
"   :arg index: array index of the property drive. Defaults to -1 for all indices or a single channel if the property is not an array.\n"
"   :type index: int\n"
"   :return: The driver(s) added.\n"
"   :rtype: :class:`bpy.types.FCurve` or list if index is -1 with an array property.\n"
;
PyObject *pyrna_struct_driver_add(BPy_StructRNA *self, PyObject *args)
{
    const char *path, *path_full;
    int index = -1;

    PYRNA_STRUCT_CHECK_OBJ(self);

    if (!PyArg_ParseTuple(args, "s|i:driver_add", &path, &index))
        return NULL;

    if (pyrna_struct_anim_args_parse(&self->ptr, "bpy_struct.driver_add():", path, &path_full, &index) < 0) {
        return NULL;
    }
    else {
        PyObject *ret = NULL;
        ReportList reports;
        int result;

        BKE_reports_init(&reports, RPT_STORE);

        result = ANIM_add_driver(&reports, (ID *)self->ptr.id.data, path_full, index, 0, DRIVER_TYPE_PYTHON);

        if (BPy_reports_to_error(&reports, PyExc_RuntimeError, TRUE) == -1)
            return NULL;

        if (result) {
            ID *id = self->ptr.id.data;
            AnimData *adt = BKE_animdata_from_id(id);
            FCurve *fcu;

            PointerRNA tptr;
            PyObject *item;

            if (index == -1) { /* all, use a list */
                int i = 0;
                ret = PyList_New(0);
                while ((fcu = list_find_fcurve(&adt->drivers, path_full, i++))) {
                    RNA_pointer_create(id, &RNA_FCurve, fcu, &tptr);
                    item = pyrna_struct_CreatePyObject(&tptr);
                    PyList_Append(ret, item);
                    Py_DECREF(item);
                }
            }
            else {
                fcu = list_find_fcurve(&adt->drivers, path_full, index);
                RNA_pointer_create(id, &RNA_FCurve, fcu, &tptr);
                ret = pyrna_struct_CreatePyObject(&tptr);
            }
            
            WM_event_add_notifier(BPy_GetContext(), NC_ANIMATION|ND_FCURVES_ORDER, NULL);
        }
        else {
            /* XXX, should be handled by reports, */
            PyErr_SetString(PyExc_TypeError, "bpy_struct.driver_add(): failed because of an internal error");
            return NULL;
        }

        MEM_freeN((void *)path_full);

        return ret;
    }
}


char pyrna_struct_driver_remove_doc[] =
".. method:: driver_remove(path, index=-1)\n"
"\n"
"   Remove driver(s) from the given property\n"
"\n"
"   :arg path: path to the property to drive, analogous to the fcurve's data path.\n"
"   :type path: string\n"
"   :arg index: array index of the property drive. Defaults to -1 for all indices or a single channel if the property is not an array.\n"
"   :type index: int\n"
"   :return: Success of driver removal.\n"
"   :rtype: boolean\n"
;
PyObject *pyrna_struct_driver_remove(BPy_StructRNA *self, PyObject *args)
{
    const char *path, *path_full;
    int index = -1;

    PYRNA_STRUCT_CHECK_OBJ(self);

    if (!PyArg_ParseTuple(args, "s|i:driver_remove", &path, &index))
        return NULL;

    if (pyrna_struct_anim_args_parse(&self->ptr, "bpy_struct.driver_remove():", path, &path_full, &index) < 0) {
        return NULL;
    }
    else {
        short result;
        ReportList reports;

        BKE_reports_init(&reports, RPT_STORE);

        result = ANIM_remove_driver(&reports, (ID *)self->ptr.id.data, path_full, index, 0);

        MEM_freeN((void *)path_full);

        if (BPy_reports_to_error(&reports, PyExc_RuntimeError, TRUE) == -1)
            return NULL;
        
        WM_event_add_notifier(BPy_GetContext(), NC_ANIMATION|ND_FCURVES_ORDER, NULL);

        return PyBool_FromLong(result);
    }
}