bpy_rna_anim.cc File Reference

#include <Python.h>
#include <cfloat>
#include "MEM_guardedalloc.h"
#include "BLI_string.h"
#include "BLI_string_utils.hh"
#include "BLI_utildefines.h"
#include "DNA_anim_types.h"
#include "DNA_scene_types.h"
#include "ED_keyframing.hh"
#include "ANIM_keyframing.hh"
#include "BKE_anim_data.hh"
#include "BKE_animsys.h"
#include "BKE_context.hh"
#include "BKE_fcurve.hh"
#include "BKE_global.hh"
#include "BKE_idtype.hh"
#include "BKE_lib_id.hh"
#include "BKE_report.hh"
#include "RNA_access.hh"
#include "RNA_enum_types.hh"
#include "RNA_path.hh"
#include "RNA_prototypes.hh"
#include "WM_api.hh"
#include "WM_types.hh"
#include "bpy_capi_utils.hh"
#include "bpy_rna.hh"
#include "bpy_rna_anim.hh"
#include "../generic/py_capi_rna.hh"
#include "../generic/python_utildefines.hh"
#include "DEG_depsgraph.hh"
#include "DEG_depsgraph_build.hh"

Go to the source code of this file.

Functions
static int	pyrna_struct_anim_args_parse_ex (PointerRNA *ptr, const char *error_prefix, const char *path, const char **r_path_full, int *r_index, bool *r_path_no_validate)
static int	pyrna_struct_anim_args_parse (PointerRNA *ptr, const char *error_prefix, const char *path, const char **r_path_full, int *r_index)
static int	pyrna_struct_anim_args_parse_no_resolve (PointerRNA *ptr, const char *error_prefix, const char *path, const char **r_path_full)
static int	pyrna_struct_anim_args_parse_no_resolve_fallback (PointerRNA *ptr, const char *error_prefix, const char *path, const char **r_path_full, int *r_index)
static int	pyrna_struct_keyframe_parse (PointerRNA *ptr, PyObject *args, PyObject *kw, const char *parse_str, const char *error_prefix, const char **r_path_full, int *r_index, float *r_cfra, const char **r_group_name, int *r_options, eBezTriple_KeyframeType *r_keytype)
PyObject *	pyrna_struct_keyframe_insert (BPy_StructRNA *self, PyObject *args, PyObject *kw)
PyObject *	pyrna_struct_keyframe_delete (BPy_StructRNA *self, PyObject *args, PyObject *kw)
PyObject *	pyrna_struct_driver_add (BPy_StructRNA *self, PyObject *args)
PyObject *	pyrna_struct_driver_remove (BPy_StructRNA *self, PyObject *args)

Variables
char	pyrna_struct_keyframe_insert_doc []
char	pyrna_struct_keyframe_delete_doc []
char	pyrna_struct_driver_add_doc []
char	pyrna_struct_driver_remove_doc []

Detailed Description

This file defines the animation related methods used in bpy_rna.cc.

Definition in file bpy_rna_anim.cc.

Function Documentation

pyrna_struct_anim_args_parse()

static int pyrna_struct_anim_args_parse ( PointerRNA * ptr, const char * error_prefix, const char * path, const char ** r_path_full, int * r_index )

static

Definition at line 156 of file bpy_rna_anim.cc.

References ptr, and pyrna_struct_anim_args_parse_ex().

Referenced by pyrna_struct_driver_add(), and pyrna_struct_keyframe_parse().

pyrna_struct_anim_args_parse_ex()

static int pyrna_struct_anim_args_parse_ex ( PointerRNA * ptr, const char * error_prefix, const char * path, const char ** r_path_full, int * r_index, bool * r_path_no_validate )

static

Definition at line 55 of file bpy_rna_anim.cc.

References BLI_strdup(), PointerRNA::data, PointerRNA::owner_id, ptr, RNA_path_from_ID_to_property(), RNA_path_resolve_property_full(), RNA_property_animateable(), RNA_property_array_check(), RNA_property_array_length(), RNA_struct_find_property(), RNA_struct_is_ID(), and PointerRNA::type.

Referenced by pyrna_struct_anim_args_parse(), and pyrna_struct_anim_args_parse_no_resolve_fallback().

pyrna_struct_anim_args_parse_no_resolve()

static int pyrna_struct_anim_args_parse_no_resolve ( PointerRNA * ptr, const char * error_prefix, const char * path, const char ** r_path_full )

static

Unlike pyrna_struct_anim_args_parse r_path_full may be copied from path.

Definition at line 168 of file bpy_rna_anim.cc.

References BLI_string_join_by_sep_charN, BLI_string_joinN, ptr, RNA_path_from_ID_to_struct(), RNA_struct_identifier(), RNA_struct_is_ID(), and PointerRNA::type.

Referenced by pyrna_struct_anim_args_parse_no_resolve_fallback().

pyrna_struct_anim_args_parse_no_resolve_fallback()

static int pyrna_struct_anim_args_parse_no_resolve_fallback ( PointerRNA * ptr, const char * error_prefix, const char * path, const char ** r_path_full, int * r_index )

static

Definition at line 198 of file bpy_rna_anim.cc.

References ptr, pyrna_struct_anim_args_parse_ex(), and pyrna_struct_anim_args_parse_no_resolve().

Referenced by pyrna_struct_driver_remove().

pyrna_struct_driver_add()

PyObject * pyrna_struct_driver_add	(	BPy_StructRNA *	self,
		PyObject *	args )

Definition at line 584 of file bpy_rna_anim.cc.

References ANIM_add_driver(), BKE_animdata_from_id(), BKE_fcurve_find(), BKE_reports_init(), BPY_context_get(), BPy_reports_to_error(), CREATEDRIVER_WITH_FMODIFIER, CTX_data_main(), DEG_id_tag_update(), DEG_relations_tag_update(), DRIVER_TYPE_PYTHON, AnimData::drivers, ID_RECALC_SYNC_TO_EVAL, MEM_freeN(), NC_ANIMATION, ND_FCURVES_ORDER, pyrna_struct_anim_args_parse(), PYRNA_STRUCT_CHECK_OBJ, pyrna_struct_CreatePyObject(), result, ret, RNA_pointer_create(), RPT_STORE, self, and WM_event_add_notifier().

pyrna_struct_driver_remove()

PyObject * pyrna_struct_driver_remove	(	BPy_StructRNA *	self,
		PyObject *	args )

Definition at line 668 of file bpy_rna_anim.cc.

References ANIM_remove_driver(), BKE_reports_init(), BPY_context_get(), BPy_reports_to_error(), CTX_data_main(), DEG_relations_tag_update(), MEM_freeN(), NC_ANIMATION, ND_FCURVES_ORDER, pyrna_struct_anim_args_parse_no_resolve_fallback(), PYRNA_STRUCT_CHECK_OBJ, result, RPT_STORE, self, and WM_event_add_notifier().

pyrna_struct_keyframe_delete()

PyObject * pyrna_struct_keyframe_delete	(	BPy_StructRNA *	self,
		PyObject *	args,
		PyObject *	kw )

Definition at line 469 of file bpy_rna_anim.cc.

References FCurve::bezt, BKE_fcurve_bezt_binarysearch_index(), BKE_fcurve_delete_key(), BKE_fcurve_find(), BKE_fcurve_handles_recalc(), BKE_fcurve_is_protected(), BKE_idtype_idcode_to_name(), BKE_reportf(), BKE_reports_init(), BLI_assert, BPy_reports_to_error(), PointerRNA::data, blender::animrig::delete_keyframe(), NlaStrip::fcurves, FLT_MAX, G, GS, RNAPath::index, MEM_freeN(), NlaStrip::name, PointerRNA::owner_id, ptr, PYRNA_STRUCT_CHECK_OBJ, pyrna_struct_keyframe_parse(), RNA_property_identifier(), RNA_struct_find_property(), RPT_ERROR, RPT_STORE, RPT_WARNING, self, and FCurve::totvert.

pyrna_struct_keyframe_insert()

PyObject * pyrna_struct_keyframe_insert	(	BPy_StructRNA *	self,
		PyObject *	args,
		PyObject *	kw )

Definition at line 328 of file bpy_rna_anim.cc.

References BEZT_KEYTYPE_KEYFRAME, BKE_animsys_eval_context_construct(), BKE_fcurve_find(), BKE_id_is_in_global_main(), BKE_report_print_level_set(), BKE_reportf(), BKE_reports_free(), BKE_reports_init(), BLI_assert, BPY_context_get(), BPy_reports_to_error(), BPy_reports_write_stdout(), CTX_data_depsgraph_pointer(), PointerRNA::data, depsgraph, NlaStrip::fcurves, FLT_MAX, G, G_MAIN, blender::animrig::CombinedKeyingResult::generate_reports(), blender::animrig::CombinedKeyingResult::get_count(), MEM_freeN(), NA_EDITED, NC_ANIMATION, ND_ANIMCHAN, options, ptr, PYRNA_STRUCT_CHECK_OBJ, pyrna_struct_keyframe_parse(), RNA_id_pointer_create(), RNA_property_identifier(), RNA_struct_find_property(), RPT_DEBUG, RPT_ERROR, RPT_STORE, RPT_WARNING, self, and WM_event_add_notifier().

pyrna_struct_keyframe_parse()

static int pyrna_struct_keyframe_parse ( PointerRNA * ptr, PyObject * args, PyObject * kw, const char * parse_str, const char * error_prefix, const char ** r_path_full, int * r_index, float * r_cfra, const char ** r_group_name, int * r_options, eBezTriple_KeyframeType * r_keytype )

static

Definition at line 221 of file bpy_rna_anim.cc.

References BPY_context_get(), RenderData::cfra, CTX_data_scene(), FLT_MAX, INSERTKEY_NO_USERPREF, ptr, pyrna_enum_bitfield_from_set(), pyrna_enum_value_from_id(), pyrna_struct_anim_args_parse(), Scene::r, rna_enum_beztriple_keyframe_type_items, and rna_enum_keying_flag_api_items.

Referenced by pyrna_struct_keyframe_delete(), and pyrna_struct_keyframe_insert().

Variable Documentation

pyrna_struct_driver_add_doc

char pyrna_struct_driver_add_doc[]

Initial value:

=
    ".. 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: str\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 added or a list of drivers when index is -1.\n"
    "   :rtype: :class:`bpy.types.FCurve` | list[:class:`bpy.types.FCurve`]\n"

Definition at line 572 of file bpy_rna_anim.cc.

pyrna_struct_driver_remove_doc

char pyrna_struct_driver_remove_doc[]

Initial value:

=
    ".. 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: str\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: bool\n"

Definition at line 656 of file bpy_rna_anim.cc.

pyrna_struct_keyframe_delete_doc

char pyrna_struct_keyframe_delete_doc[]

Initial value:

=
    ".. 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: str\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 deletion.\n"
    "   :rtype: bool\n"

Definition at line 450 of file bpy_rna_anim.cc.

pyrna_struct_keyframe_insert_doc

char pyrna_struct_keyframe_insert_doc[]

Definition at line 291 of file bpy_rna_anim.cc.