rna_animation.cc File Reference

#include <cstdlib>
#include "DNA_anim_types.h"
#include "BLT_translation.hh"
#include "BKE_lib_override.hh"
#include "BKE_nla.hh"
#include "RNA_define.hh"
#include "RNA_enum_types.hh"
#include "rna_internal.hh"
#include "WM_api.hh"
#include "WM_types.hh"
#include "ED_keyframing.hh"

Go to the source code of this file.

Macros
#define	KEYINGSET_IDNAME_DOC

Functions
static void	rna_def_common_keying_flags (StructRNA *srna, short reg)
static void	rna_def_keyingset_info (BlenderRNA *brna)
static void	rna_def_keyingset_path (BlenderRNA *brna)
static void	rna_def_keyingset_paths (BlenderRNA *brna, PropertyRNA *cprop)
static void	rna_def_keyingset (BlenderRNA *brna)
static void	rna_api_animdata_nla_tracks (BlenderRNA *brna, PropertyRNA *cprop)
static void	rna_api_animdata_drivers (BlenderRNA *brna, PropertyRNA *cprop)
void	rna_def_animdata_common (StructRNA *srna)
static void	rna_def_animdata (BlenderRNA *brna)
void	RNA_def_animation (BlenderRNA *brna)

Variables
const EnumPropertyItem	rna_enum_keyingset_path_grouping_items []
const EnumPropertyItem	rna_enum_keying_flag_items []
const EnumPropertyItem	rna_enum_keying_flag_api_items []

Macro Definition Documentation

KEYINGSET_IDNAME_DOC

#define KEYINGSET_IDNAME_DOC

Value:

"If this is set, the Keying Set gets a custom ID, otherwise it takes " \
"the name of the class used to define the Keying Set (for example, " \
"if the class name is \"BUILTIN_KSI_location\", and bl_idname is not " \
"set by the script, then bl_idname = \"BUILTIN_KSI_location\")"

Definition at line 1172 of file rna_animation.cc.

Referenced by rna_def_keyingset(), and rna_def_keyingset_info().

Function Documentation

rna_api_animdata_drivers()

void rna_api_animdata_drivers ( BlenderRNA * brna, PropertyRNA * cprop )

static

Definition at line 1538 of file rna_animation.cc.

References FUNC_USE_CONTEXT, FUNC_USE_MAIN, FUNC_USE_REPORTS, FUNC_USE_SELF_ID, PARM_REQUIRED, PROP_NEVER_NULL, RNA_def_function(), RNA_def_function_flag(), RNA_def_function_return(), RNA_def_function_ui_description(), RNA_def_int(), RNA_def_parameter_flags(), RNA_def_pointer(), RNA_def_property_srna(), RNA_def_string(), RNA_def_struct(), RNA_def_struct_sdna(), and RNA_def_struct_ui_text().

Referenced by rna_def_animdata().

rna_api_animdata_nla_tracks()

void rna_api_animdata_nla_tracks ( BlenderRNA * brna, PropertyRNA * cprop )

static

Definition at line 1498 of file rna_animation.cc.

References BLT_I18NCONTEXT_ID_ACTION, FUNC_USE_CONTEXT, FUNC_USE_MAIN, FUNC_USE_REPORTS, FUNC_USE_SELF_ID, NA_SELECTED, NC_ANIMATION, ND_NLA, PARM_REQUIRED, PARM_RNAPTR, PROP_EDITABLE, PROP_NEVER_NULL, PROP_NONE, PROP_POINTER, PROP_THICK_WRAP, RNA_def_function(), RNA_def_function_flag(), RNA_def_function_return(), RNA_def_function_ui_description(), RNA_def_parameter_clear_flags(), RNA_def_parameter_flags(), RNA_def_pointer(), RNA_def_property(), RNA_def_property_flag(), RNA_def_property_pointer_funcs(), RNA_def_property_srna(), RNA_def_property_struct_type(), RNA_def_property_translation_context(), RNA_def_property_ui_text(), RNA_def_property_update(), RNA_def_struct(), RNA_def_struct_sdna(), and RNA_def_struct_ui_text().

Referenced by rna_def_animdata().

RNA_def_animation()

void RNA_def_animation

(

BlenderRNA *

brna

)

Definition at line 1807 of file rna_animation.cc.

References rna_def_animdata(), rna_def_keyingset(), rna_def_keyingset_info(), and rna_def_keyingset_path().

rna_def_animdata()

void rna_def_animdata ( BlenderRNA * brna )

static

Definition at line 1610 of file rna_animation.cc.

References ADT_CURVES_ALWAYS_VISIBLE, ADT_NLA_EDIT_ON, ADT_NLA_EVAL_OFF, NA_EDITED, NC_ANIMATION, ND_ANIMCHAN, ND_NLA, ND_NLA_ACTCHANGE, PROP_ANIMATABLE, PROP_BOOLEAN, PROP_COLLECTION, PROP_EDITABLE, PROP_ENUM, PROP_FACTOR, PROP_FLOAT, PROP_HIDDEN, PROP_ID_REFCOUNT, PROP_INT, PROP_NO_DEG_UPDATE, PROP_NONE, PROP_POINTER, PROP_STRING, PROPOVERRIDE_IGNORE, PROPOVERRIDE_LIBRARY_INSERTION, PROPOVERRIDE_NO_PROP_NAME, PROPOVERRIDE_OVERRIDABLE_LIBRARY, RNA_api_animdata(), rna_api_animdata_drivers(), rna_api_animdata_nla_tracks(), RNA_def_property(), RNA_def_property_boolean_funcs(), RNA_def_property_boolean_negative_sdna(), RNA_def_property_boolean_sdna(), RNA_def_property_clear_flag(), RNA_def_property_collection_funcs(), RNA_def_property_collection_sdna(), RNA_def_property_editable_func(), RNA_def_property_enum_items(), RNA_def_property_enum_sdna(), RNA_def_property_flag(), RNA_def_property_float_default(), RNA_def_property_float_sdna(), RNA_def_property_int_funcs(), RNA_def_property_int_sdna(), RNA_def_property_override_flag(), RNA_def_property_override_funcs(), RNA_def_property_pointer_funcs(), RNA_def_property_pointer_sdna(), RNA_def_property_range(), RNA_def_property_string_sdna(), RNA_def_property_struct_type(), RNA_def_property_ui_text(), RNA_def_property_update(), RNA_def_struct(), RNA_def_struct_path_func(), RNA_def_struct_ui_icon(), RNA_def_struct_ui_text(), RNA_define_lib_overridable(), rna_enum_nla_mode_blend_items, and rna_enum_nla_mode_extend_items.

Referenced by RNA_def_animation().

rna_def_animdata_common()

void rna_def_animdata_common

(

StructRNA *

srna

)

Definition at line 1598 of file rna_animation.cc.

References PROP_EDITABLE, PROP_NONE, PROP_POINTER, PROPOVERRIDE_OVERRIDABLE_LIBRARY, RNA_def_property(), RNA_def_property_clear_flag(), RNA_def_property_override_flag(), RNA_def_property_override_funcs(), RNA_def_property_pointer_sdna(), and RNA_def_property_ui_text().

Referenced by rna_def_annotation_data(), rna_def_armature(), rna_def_cachefile(), RNA_def_camera(), rna_def_curve(), rna_def_curves(), rna_def_grease_pencil_data(), rna_def_key(), rna_def_lattice(), rna_def_light(), rna_def_lightprobe(), rna_def_linestyle(), rna_def_mask(), RNA_def_material(), rna_def_mesh(), rna_def_metaball(), rna_def_movieclip(), rna_def_nodetree(), rna_def_object(), rna_def_particle_settings(), rna_def_pointcloud(), RNA_def_scene(), rna_def_speaker(), rna_def_texture(), rna_def_volume(), and RNA_def_world().

rna_def_common_keying_flags()

void rna_def_common_keying_flags ( StructRNA * srna, short reg )

static

Definition at line 1125 of file rna_animation.cc.

References INSERTKEY_MATRIX, INSERTKEY_NEEDED, PROP_BOOLEAN, PROP_NONE, PROP_REGISTER_OPTIONAL, RNA_def_property(), RNA_def_property_boolean_sdna(), RNA_def_property_flag(), and RNA_def_property_ui_text().

Referenced by rna_def_keyingset(), and rna_def_keyingset_path().

rna_def_keyingset()

void rna_def_keyingset ( BlenderRNA * brna )

static

Definition at line 1433 of file rna_animation.cc.

References KEYINGSET_ABSOLUTE, KEYINGSET_IDNAME_DOC, NA_RENAME, NC_SCENE, ND_KEYINGSET, PROP_BOOLEAN, PROP_COLLECTION, PROP_EDITABLE, PROP_NONE, PROP_POINTER, PROP_REGISTER, PROP_STRING, RNA_api_keyingset(), rna_def_common_keying_flags(), rna_def_keyingset_paths(), RNA_def_property(), RNA_def_property_boolean_sdna(), RNA_def_property_clear_flag(), RNA_def_property_collection_sdna(), RNA_def_property_flag(), RNA_def_property_pointer_funcs(), RNA_def_property_string_funcs(), RNA_def_property_string_maxlength(), RNA_def_property_string_sdna(), RNA_def_property_struct_type(), RNA_def_property_ui_text(), RNA_def_property_update(), RNA_def_struct(), RNA_def_struct_name_property(), RNA_def_struct_ui_icon(), RNA_def_struct_ui_text(), and RNA_DYN_DESCR_MAX.

Referenced by RNA_def_animation().

rna_def_keyingset_info()

void rna_def_keyingset_info ( BlenderRNA * brna )

static

Definition at line 1178 of file rna_animation.cc.

References FUNC_REGISTER, KEYINGSET_IDNAME_DOC, PARM_REQUIRED, PARM_RNAPTR, PROP_ENUM, PROP_ENUM_FLAG, PROP_NEVER_NULL, PROP_NONE, PROP_REGISTER, PROP_REGISTER_OPTIONAL, PROP_STRING, RNA_def_boolean(), RNA_def_function(), RNA_def_function_flag(), RNA_def_function_return(), RNA_def_function_ui_description(), RNA_def_parameter_flags(), RNA_def_pointer(), RNA_def_property(), RNA_def_property_enum_items(), RNA_def_property_enum_sdna(), RNA_def_property_flag(), RNA_def_property_string_maxlength(), RNA_def_property_string_sdna(), RNA_def_property_ui_text(), RNA_def_struct(), RNA_def_struct_name_property(), RNA_def_struct_refine_func(), RNA_def_struct_register_funcs(), RNA_def_struct_sdna(), RNA_def_struct_ui_text(), RNA_define_verify_sdna(), RNA_DYN_DESCR_MAX, and rna_enum_keying_flag_items.

Referenced by RNA_def_animation().

rna_def_keyingset_path()

void rna_def_keyingset_path ( BlenderRNA * brna )

static

Definition at line 1263 of file rna_animation.cc.

References BLT_I18NCONTEXT_ID_ID, ID_OB, KSP_FLAG_WHOLE_ARRAY, NA_EDITED, NC_SCENE, ND_KEYINGSET, PROP_BOOLEAN, PROP_EDITABLE, PROP_ENUM, PROP_INT, PROP_NONE, PROP_POINTER, PROP_STRING, rna_def_common_keying_flags(), RNA_def_property(), RNA_def_property_boolean_sdna(), RNA_def_property_editable_func(), RNA_def_property_enum_default(), RNA_def_property_enum_funcs(), RNA_def_property_enum_items(), RNA_def_property_enum_sdna(), RNA_def_property_flag(), RNA_def_property_pointer_funcs(), RNA_def_property_string_funcs(), RNA_def_property_struct_type(), RNA_def_property_translation_context(), RNA_def_property_ui_text(), RNA_def_property_update(), RNA_def_struct(), RNA_def_struct_name_property(), RNA_def_struct_sdna(), RNA_def_struct_ui_text(), rna_enum_id_type_items, and rna_enum_keyingset_path_grouping_items.

Referenced by RNA_def_animation().

rna_def_keyingset_paths()

void rna_def_keyingset_paths ( BlenderRNA * brna, PropertyRNA * cprop )

static

Definition at line 1341 of file rna_animation.cc.

References FUNC_USE_REPORTS, KSP_GROUP_KSNAME, PARM_REQUIRED, PARM_RNAPTR, PROP_EDITABLE, PROP_INT, PROP_NEVER_NULL, PROP_NONE, PROP_POINTER, PROP_THICK_WRAP, RNA_def_enum(), RNA_def_function(), RNA_def_function_flag(), RNA_def_function_return(), RNA_def_function_ui_description(), RNA_def_int(), RNA_def_parameter_clear_flags(), RNA_def_parameter_flags(), RNA_def_pointer(), RNA_def_property(), RNA_def_property_editable_func(), RNA_def_property_flag(), RNA_def_property_int_funcs(), RNA_def_property_int_sdna(), RNA_def_property_pointer_funcs(), RNA_def_property_srna(), RNA_def_property_struct_type(), RNA_def_property_ui_text(), RNA_def_string(), RNA_def_struct(), RNA_def_struct_sdna(), RNA_def_struct_ui_text(), and rna_enum_keyingset_path_grouping_items.

Referenced by rna_def_keyingset().

Variable Documentation

rna_enum_keying_flag_api_items

const EnumPropertyItem rna_enum_keying_flag_api_items[]

Initial value:

                                                      = {
    {INSERTKEY_NEEDED,
     "INSERTKEY_NEEDED",
     0,
     "Only Needed",
     "Only insert keyframes where they're needed in the relevant F-Curves"},
    {INSERTKEY_MATRIX,
     "INSERTKEY_VISUAL",
     0,
     "Visual Keying",
     "Insert keyframes based on 'visual transforms'"},
    {INSERTKEY_REPLACE,
     "INSERTKEY_REPLACE",
     0,
     "Replace Existing",
     "Only replace existing keyframes"},
    {INSERTKEY_AVAILABLE,
     "INSERTKEY_AVAILABLE",
     0,
     "Only Available",
     "Don't create F-Curves when they don't already exist"},
    {INSERTKEY_CYCLE_AWARE,
     "INSERTKEY_CYCLE_AWARE",
     0,
     "Cycle Aware Keying",
     "When inserting into a curve with cyclic extrapolation, remap the keyframe inside "
     "the cycle time range, and if changing an end key, also update the other one"},
    {0, nullptr, 0, nullptr, nullptr},
}

Definition at line 57 of file rna_animation.cc.

Referenced by pyrna_struct_keyframe_parse().

rna_enum_keying_flag_items

const EnumPropertyItem rna_enum_keying_flag_items[]

Initial value:

                                                  = {
    {INSERTKEY_NEEDED,
     "INSERTKEY_NEEDED",
     0,
     "Only Needed",
     "Only insert keyframes where they're needed in the relevant F-Curves"},
    {INSERTKEY_MATRIX,
     "INSERTKEY_VISUAL",
     0,
     "Visual Keying",
     "Insert keyframes based on 'visual transforms'"},
    {0, nullptr, 0, nullptr, nullptr},
}

Definition at line 42 of file rna_animation.cc.

Referenced by rna_def_keyingset_info().

rna_enum_keyingset_path_grouping_items

const EnumPropertyItem rna_enum_keyingset_path_grouping_items[]

Initial value:

                                                              = {
    {KSP_GROUP_NAMED, "NAMED", 0, "Named Group", ""},
    {KSP_GROUP_NONE, "NONE", 0, "None", ""},
    {KSP_GROUP_KSNAME, "KEYINGSET", 0, "Keying Set Name", ""},
    {0, nullptr, 0, nullptr, nullptr},
}

Definition at line 31 of file rna_animation.cc.

Referenced by rna_def_keyingset_path(), and rna_def_keyingset_paths().