replace BLI_strncpy with BLI_strncpy_utf8 where input isnt ensured to be valid.
[blender.git] / source / blender / makesrna / intern / rna_animation.c
index 85f070b3162974169f685a070b51e34c39e0ca2c..2f5f22c52d58991cd459fdf9a2f9494b68594d60 100644 (file)
@@ -1,6 +1,4 @@
-/**
- * $Id$
- *
+/*
  * ***** BEGIN GPL LICENSE BLOCK *****
  *
  * This program is free software; you can redistribute it and/or
  * ***** END GPL LICENSE BLOCK *****
  */
 
+/** \file blender/makesrna/intern/rna_animation.c
+ *  \ingroup RNA
+ */
+
+
 #include <stdlib.h>
 
 #include "RNA_access.h"
@@ -38,6 +41,8 @@
 
 #include "ED_keyframing.h"
 
+#include "WM_types.h"
+
 /* exported for use in API */
 EnumPropertyItem keyingset_path_grouping_items[] = {
        {KSP_GROUP_NAMED, "NAMED", 0, "Named Group", ""},
@@ -48,6 +53,10 @@ EnumPropertyItem keyingset_path_grouping_items[] = {
 #ifdef RNA_RUNTIME
 
 #include "BKE_animsys.h"
+#include "BKE_fcurve.h"
+#include "BKE_nla.h"
+
+#include "WM_api.h"
 
 static int rna_AnimData_action_editable(PointerRNA *ptr)
 {
@@ -60,6 +69,12 @@ static int rna_AnimData_action_editable(PointerRNA *ptr)
                return 1;
 }
 
+static void rna_AnimData_action_set(PointerRNA *ptr, PointerRNA value)
+{
+       ID *ownerId = (ID *)ptr->id.data;
+       BKE_animdata_set_action(NULL, ownerId, value.data);
+}
+
 /* ****************************** */
 
 /* wrapper for poll callback */
@@ -80,7 +95,7 @@ static int RKS_POLL_rna_internal(KeyingSetInfo *ksi, bContext *C)
                RNA_parameter_set_lookup(&list, "context", &C);
                
                /* execute the function */
-               ksi->ext.call(&ptr, func, &list);
+               ksi->ext.call(C, &ptr, func, &list);
                
                /* read the result */
                RNA_parameter_get_lookup(&list, "ok", &ret);
@@ -107,7 +122,7 @@ static void RKS_ITER_rna_internal(KeyingSetInfo *ksi, bContext *C, KeyingSet *ks
                RNA_parameter_set_lookup(&list, "ks", &ks);
                
                /* execute the function */
-               ksi->ext.call(&ptr, func, &list);
+               ksi->ext.call(C, &ptr, func, &list);
        RNA_parameter_list_free(&list);
 }
 
@@ -129,7 +144,7 @@ static void RKS_GEN_rna_internal(KeyingSetInfo *ksi, bContext *C, KeyingSet *ks,
                RNA_parameter_set_lookup(&list, "data", data);
                
                /* execute the function */
-               ksi->ext.call(&ptr, func, &list);
+               ksi->ext.call(C, &ptr, func, &list);
        RNA_parameter_list_free(&list);
 }
 
@@ -142,7 +157,7 @@ static StructRNA *rna_KeyingSetInfo_refine(PointerRNA *ptr)
        return (ksi->ext.srna)? ksi->ext.srna: &RNA_KeyingSetInfo;
 }
 
-static void rna_KeyingSetInfo_unregister(const bContext *C, StructRNA *type)
+static void rna_KeyingSetInfo_unregister(Main *bmain, StructRNA *type)
 {
        KeyingSetInfo *ksi= RNA_struct_blender_type_get(type);
 
@@ -154,14 +169,14 @@ static void rna_KeyingSetInfo_unregister(const bContext *C, StructRNA *type)
        RNA_struct_free(&BLENDER_RNA, type);
        
        /* unlink Blender-side data */
-       ANIM_keyingset_info_unregister(C, ksi);
+       ANIM_keyingset_info_unregister(bmain, ksi);
 }
 
-static StructRNA *rna_KeyingSetInfo_register(const bContext *C, ReportList *reports, void *data, const char *identifier, StructValidateFunc validate, StructCallbackFunc call, StructFreeFunc free)
+static StructRNA *rna_KeyingSetInfo_register(Main *bmain, ReportList *reports, void *data, const char *identifier, StructValidateFunc validate, StructCallbackFunc call, StructFreeFunc free)
 {
-       KeyingSetInfo dummyksi = {0};
+       KeyingSetInfo dummyksi = {NULL};
        KeyingSetInfo *ksi;
-       PointerRNA dummyptr;
+       PointerRNA dummyptr = {{NULL}};
        int have_function[3];
 
        /* setup dummy type info to store static properties in */
@@ -173,14 +188,14 @@ static StructRNA *rna_KeyingSetInfo_register(const bContext *C, ReportList *repo
                return NULL;
        
        if (strlen(identifier) >= sizeof(dummyksi.idname)) {
-               BKE_reportf(reports, RPT_ERROR, "registering keying set info class: '%s' is too long, maximum length is %d.", identifier, sizeof(dummyksi.idname));
+               BKE_reportf(reports, RPT_ERROR, "registering keying set info class: '%s' is too long, maximum length is %d.", identifier, (int)sizeof(dummyksi.idname));
                return NULL;
        }
        
        /* check if we have registered this info before, and remove it */
        ksi = ANIM_keyingset_info_find_named(dummyksi.idname);
        if (ksi && ksi->ext.srna)
-               rna_KeyingSetInfo_unregister(C, ksi->ext.srna);
+               rna_KeyingSetInfo_unregister(bmain, ksi->ext.srna);
        
        /* create a new KeyingSetInfo type */
        ksi= MEM_callocN(sizeof(KeyingSetInfo), "python keying set info");
@@ -198,7 +213,7 @@ static StructRNA *rna_KeyingSetInfo_register(const bContext *C, ReportList *repo
        ksi->poll= (have_function[0])? RKS_POLL_rna_internal: NULL;
        ksi->iter= (have_function[1])? RKS_ITER_rna_internal: NULL;
        ksi->generate= (have_function[2])? RKS_GEN_rna_internal: NULL;
-
+       
        /* add and register with other info as needed */
        ANIM_keyingset_info_register(ksi);
        
@@ -237,7 +252,7 @@ static void rna_ksPath_RnaPath_get(PointerRNA *ptr, char *value)
        if (ksp->rna_path)
                strcpy(value, ksp->rna_path);
        else
-               strcpy(value, "");
+               value[0]= '\0';
 }
 
 static int rna_ksPath_RnaPath_length(PointerRNA *ptr)
@@ -381,6 +396,54 @@ static void rna_KeyingSet_paths_clear(KeyingSet *keyingset, ReportList *reports)
        }
 }
 
+/* needs wrapper function to push notifier */
+static NlaTrack *rna_NlaTrack_new(AnimData *adt, bContext *C, NlaTrack *track)
+{
+       NlaTrack *new_track = add_nlatrack(adt, track);
+
+       WM_event_add_notifier(C, NC_ANIMATION|ND_NLA|NA_ADDED, NULL);
+
+       return new_track;
+}
+
+static void rna_NlaTrack_remove(AnimData *adt, bContext *C, NlaTrack *track)
+{
+       free_nlatrack(&adt->nla_tracks, track);
+
+       WM_event_add_notifier(C, NC_ANIMATION|ND_NLA|NA_REMOVED, NULL);
+}
+
+static PointerRNA rna_NlaTrack_active_get(PointerRNA *ptr)
+{
+       AnimData *adt= (AnimData*)ptr->data;
+       NlaTrack *track= BKE_nlatrack_find_active(&adt->nla_tracks);
+       return rna_pointer_inherit_refine(ptr, &RNA_NlaTrack, track);
+}
+
+static void rna_NlaTrack_active_set(PointerRNA *ptr, PointerRNA value)
+{
+       AnimData *adt= (AnimData*)ptr->data;
+       NlaTrack *track= (NlaTrack*)value.data;
+       BKE_nlatrack_set_active(&adt->nla_tracks, track);
+}
+
+
+static FCurve *rna_Driver_from_existing(AnimData *adt, bContext *C, FCurve *src_driver)
+{
+       /* verify that we've got a driver to duplicate */
+       if (ELEM(NULL, src_driver, src_driver->driver)) {
+               BKE_reportf(CTX_wm_reports(C), RPT_ERROR, "No valid driver data to create copy of");
+               return NULL;
+       }
+       else {
+               /* just make a copy of the existing one and add to self */
+               FCurve *new_fcu = copy_fcurve(src_driver);
+               
+               // XXX: if we impose any ordering on these someday, this will be problematic
+               BLI_addtail(&adt->drivers, new_fcu);
+               return new_fcu;
+       }
+}
 
 #else
 
@@ -415,7 +478,7 @@ static void rna_def_keyingset_info(BlenderRNA *brna)
        RNA_def_struct_sdna(srna, "KeyingSetInfo");
        RNA_def_struct_ui_text(srna, "Keying Set Info", "Callback function defines for builtin Keying Sets");
        RNA_def_struct_refine_func(srna, "rna_KeyingSetInfo_refine");
-       RNA_def_struct_register_funcs(srna, "rna_KeyingSetInfo_register", "rna_KeyingSetInfo_unregister");
+       RNA_def_struct_register_funcs(srna, "rna_KeyingSetInfo_register", "rna_KeyingSetInfo_unregister", NULL);
        
        /* Properties --------------------- */
        
@@ -423,7 +486,7 @@ static void rna_def_keyingset_info(BlenderRNA *brna)
                
        prop= RNA_def_property(srna, "bl_idname", PROP_STRING, PROP_NONE);
        RNA_def_property_string_sdna(prop, NULL, "idname");
-       RNA_def_property_flag(prop, PROP_REGISTER);
+       RNA_def_property_flag(prop, PROP_REGISTER|PROP_NEVER_CLAMP);
                
        /* Name */
        prop= RNA_def_property(srna, "bl_label", PROP_STRING, PROP_NONE);
@@ -482,6 +545,7 @@ static void rna_def_keyingset_path(BlenderRNA *brna)
        RNA_def_property_editable_func(prop, "rna_ksPath_id_editable");
        RNA_def_property_pointer_funcs(prop, NULL, NULL, "rna_ksPath_id_typef", NULL);
        RNA_def_property_ui_text(prop, "ID-Block", "ID-Block that keyframes for Keying Set should be added to (for Absolute Keying Sets only)");
+       RNA_def_property_update(prop, NC_SCENE|ND_KEYINGSET|NA_EDITED, NULL); // XXX: maybe a bit too noisy
        
        prop= RNA_def_property(srna, "id_type", PROP_ENUM, PROP_NONE);
        RNA_def_property_enum_sdna(prop, NULL, "idtype");
@@ -489,30 +553,37 @@ static void rna_def_keyingset_path(BlenderRNA *brna)
        RNA_def_property_enum_default(prop, ID_OB);
        RNA_def_property_enum_funcs(prop, NULL, "rna_ksPath_id_type_set", NULL);
        RNA_def_property_ui_text(prop, "ID Type", "Type of ID-block that can be used");
+       RNA_def_property_update(prop, NC_SCENE|ND_KEYINGSET|NA_EDITED, NULL); // XXX: maybe a bit too noisy
        
        /* Group */
        prop= RNA_def_property(srna, "group", PROP_STRING, PROP_NONE);
        RNA_def_property_ui_text(prop, "Group Name", "Name of Action Group to assign setting(s) for this path to");
+       RNA_def_property_update(prop, NC_SCENE|ND_KEYINGSET|NA_EDITED, NULL); // XXX: maybe a bit too noisy
        
        /* Grouping */
        prop= RNA_def_property(srna, "group_method", PROP_ENUM, PROP_NONE);
        RNA_def_property_enum_sdna(prop, NULL, "groupmode");
        RNA_def_property_enum_items(prop, keyingset_path_grouping_items);
        RNA_def_property_ui_text(prop, "Grouping Method", "Method used to define which Group-name to use");
+       RNA_def_property_update(prop, NC_SCENE|ND_KEYINGSET|NA_EDITED, NULL); // XXX: maybe a bit too noisy
        
        /* Path + Array Index */
        prop= RNA_def_property(srna, "data_path", PROP_STRING, PROP_NONE);
        RNA_def_property_string_funcs(prop, "rna_ksPath_RnaPath_get", "rna_ksPath_RnaPath_length", "rna_ksPath_RnaPath_set");
        RNA_def_property_ui_text(prop, "Data Path", "Path to property setting");
        RNA_def_struct_name_property(srna, prop); // XXX this is the best indicator for now...
-       
+       RNA_def_property_update(prop, NC_SCENE|ND_KEYINGSET|NA_EDITED, NULL);
+
+       /* called 'index' when given as function arg */
        prop= RNA_def_property(srna, "array_index", PROP_INT, PROP_NONE);
        RNA_def_property_ui_text(prop, "RNA Array Index", "Index to the specific setting if applicable");
+       RNA_def_property_update(prop, NC_SCENE|ND_KEYINGSET|NA_EDITED, NULL); // XXX: maybe a bit too noisy
        
        /* Flags */
        prop= RNA_def_property(srna, "use_entire_array", PROP_BOOLEAN, PROP_NONE);
        RNA_def_property_boolean_sdna(prop, NULL, "flag", KSP_FLAG_WHOLE_ARRAY);
        RNA_def_property_ui_text(prop, "Entire Array", "When an 'array/vector' type is chosen (Location, Rotation, Color, etc.), entire array is to be used");
+       RNA_def_property_update(prop, NC_SCENE|ND_KEYINGSET|NA_EDITED, NULL); // XXX: maybe a bit too noisy
        
        /* Keyframing Settings */
        rna_def_common_keying_flags(srna, 0);
@@ -549,10 +620,10 @@ static void rna_def_keyingset_paths(BlenderRNA *brna, PropertyRNA *cprop)
        parm= RNA_def_string(func, "data_path", "", 256, "Data-Path", "RNA-Path to destination property."); // xxx hopefully this is long enough
                RNA_def_property_flag(parm, PROP_REQUIRED);
                /* index (defaults to -1 for entire array) */
-       parm=RNA_def_int(func, "index", -1, -1, INT_MAX, "Index", "The index of the destination property (i.e. axis of Location/Rotation/etc.), or -1 for the entire array.", 0, INT_MAX);
+       RNA_def_int(func, "index", -1, -1, INT_MAX, "Index", "The index of the destination property (i.e. axis of Location/Rotation/etc.), or -1 for the entire array.", 0, INT_MAX);
                /* grouping */
-       parm=RNA_def_enum(func, "group_method", keyingset_path_grouping_items, KSP_GROUP_KSNAME, "Grouping Method", "Method used to define which Group-name to use.");
-       parm=RNA_def_string(func, "group_name", "", 64, "Group Name", "Name of Action Group to assign destination to (only if grouping mode is to use this name).");
+       RNA_def_enum(func, "group_method", keyingset_path_grouping_items, KSP_GROUP_KSNAME, "Grouping Method", "Method used to define which Group-name to use.");
+       RNA_def_string(func, "group_name", "", 64, "Group Name", "Name of Action Group to assign destination to (only if grouping mode is to use this name).");
 
 
        /* Remove Path */
@@ -593,8 +664,9 @@ static void rna_def_keyingset(BlenderRNA *brna)
        /* Name */
        prop= RNA_def_property(srna, "name", PROP_STRING, PROP_NONE);
        RNA_def_property_ui_text(prop, "Name", "");
-       RNA_def_struct_ui_icon(srna, ICON_KEY_HLT); // TODO: we need a dedicated icon
+       RNA_def_struct_ui_icon(srna, ICON_KEYINGSET);
        RNA_def_struct_name_property(srna, prop);
+       RNA_def_property_update(prop, NC_SCENE|ND_KEYINGSET|NA_RENAME, NULL);
        
        /* KeyingSetInfo (Type Info) for Builtin Sets only  */
        prop= RNA_def_property(srna, "type_info", PROP_POINTER, PROP_NONE);
@@ -625,6 +697,64 @@ static void rna_def_keyingset(BlenderRNA *brna)
 
 /* --- */
 
+static void rna_api_animdata_nla_tracks(BlenderRNA *brna, PropertyRNA *cprop)
+{
+       StructRNA *srna;
+       PropertyRNA *parm;
+       FunctionRNA *func;
+
+       PropertyRNA *prop;
+       
+       RNA_def_property_srna(cprop, "NlaTracks");
+       srna= RNA_def_struct(brna, "NlaTracks", NULL);
+       RNA_def_struct_sdna(srna, "AnimData");
+       RNA_def_struct_ui_text(srna, "NLA Tracks", "Collection of NLA Tracks");
+       
+       func = RNA_def_function(srna, "new", "rna_NlaTrack_new");
+       RNA_def_function_flag(func, FUNC_USE_CONTEXT);
+       RNA_def_function_ui_description(func, "Add a new NLA Track");
+       RNA_def_pointer(func, "prev", "NlaTrack", "", "NLA Track to add the new one after.");
+       /* return type */
+       parm = RNA_def_pointer(func, "track", "NlaTrack", "", "New NLA Track.");
+       RNA_def_function_return(func, parm);
+       
+       func = RNA_def_function(srna, "remove", "rna_NlaTrack_remove");
+       RNA_def_function_flag(func, FUNC_USE_CONTEXT);
+       RNA_def_function_ui_description(func, "Remove a NLA Track.");
+       parm = RNA_def_pointer(func, "track", "NlaTrack", "", "NLA Track to remove.");
+       RNA_def_property_flag(parm, PROP_REQUIRED|PROP_NEVER_NULL);
+
+       prop= RNA_def_property(srna, "active", PROP_POINTER, PROP_NONE);
+       RNA_def_property_struct_type(prop, "NlaTrack");
+       RNA_def_property_pointer_funcs(prop, "rna_NlaTrack_active_get", "rna_NlaTrack_active_set", NULL, NULL);
+       RNA_def_property_flag(prop, PROP_EDITABLE);
+       RNA_def_property_ui_text(prop, "Active Constraint", "Active Object constraint");
+       /* XXX: should (but doesn't) update the active track in the NLA window */
+       RNA_def_property_update(prop, NC_ANIMATION|ND_NLA|NA_SELECTED, NULL);
+}
+
+static void rna_api_animdata_drivers(BlenderRNA *brna, PropertyRNA *cprop)
+{
+       StructRNA *srna;
+       PropertyRNA *parm;
+       FunctionRNA *func;
+
+       // PropertyRNA *prop;
+       
+       RNA_def_property_srna(cprop, "AnimDataDrivers");
+       srna= RNA_def_struct(brna, "AnimDataDrivers", NULL);
+       RNA_def_struct_sdna(srna, "AnimData");
+       RNA_def_struct_ui_text(srna, "Drivers", "Collection of Driver F-Curves");
+       
+       func = RNA_def_function(srna, "from_existing", "rna_Driver_from_existing");
+       RNA_def_function_flag(func, FUNC_USE_CONTEXT);
+       RNA_def_function_ui_description(func, "Add a new driver given an existing one");
+       RNA_def_pointer(func, "src_driver", "FCurve", "", "Existing Driver F-Curve to use as template for a new one");
+       /* return type */
+       parm = RNA_def_pointer(func, "driver", "FCurve", "", "New Driver F-Curve.");
+       RNA_def_function_return(func, parm);
+}
+
 void rna_def_animdata_common(StructRNA *srna)
 {
        PropertyRNA *prop;
@@ -648,30 +778,36 @@ void rna_def_animdata(BlenderRNA *brna)
        RNA_def_property_collection_sdna(prop, NULL, "nla_tracks", NULL);
        RNA_def_property_struct_type(prop, "NlaTrack");
        RNA_def_property_ui_text(prop, "NLA Tracks", "NLA Tracks (i.e. Animation Layers)");
+
+       rna_api_animdata_nla_tracks(brna, prop);
        
        /* Active Action */
        prop= RNA_def_property(srna, "action", PROP_POINTER, PROP_NONE);
        RNA_def_property_flag(prop, PROP_EDITABLE); /* this flag as well as the dynamic test must be defined for this to be editable... */
+       RNA_def_property_pointer_funcs(prop, NULL, "rna_AnimData_action_set", NULL, "rna_Action_id_poll");
        RNA_def_property_editable_func(prop, "rna_AnimData_action_editable");
        RNA_def_property_ui_text(prop, "Action", "Active Action for this datablock");
+       RNA_def_property_update(prop, NC_ANIMATION, NULL); /* this will do? */
 
-       
        /* Active Action Settings */
        prop= RNA_def_property(srna, "action_extrapolation", PROP_ENUM, PROP_NONE);
        RNA_def_property_enum_sdna(prop, NULL, "act_extendmode");
        RNA_def_property_enum_items(prop, nla_mode_extend_items);
        RNA_def_property_ui_text(prop, "Action Extrapolation", "Action to take for gaps past the Active Action's range (when evaluating with NLA)");
+       RNA_def_property_update(prop, NC_ANIMATION|ND_NLA, NULL); /* this will do? */
        
        prop= RNA_def_property(srna, "action_blend_type", PROP_ENUM, PROP_NONE);
        RNA_def_property_enum_sdna(prop, NULL, "act_blendmode");
        RNA_def_property_enum_items(prop, nla_mode_blend_items);
        RNA_def_property_ui_text(prop, "Action Blending", "Method used for combining Active Action's result with result of NLA stack");
+       RNA_def_property_update(prop, NC_ANIMATION|ND_NLA, NULL); /* this will do? */
        
        prop= RNA_def_property(srna, "action_influence", PROP_FLOAT, PROP_NONE);
        RNA_def_property_float_sdna(prop, NULL, "act_influence");
        RNA_def_property_float_default(prop, 1.0f);
        RNA_def_property_range(prop, 0.0f, 1.0f);
        RNA_def_property_ui_text(prop, "Action Influence", "Amount the Active Action contributes to the result of the NLA stack");
+       RNA_def_property_update(prop, NC_ANIMATION|ND_NLA, NULL); /* this will do? */
        
        /* Drivers */
        prop= RNA_def_property(srna, "drivers", PROP_COLLECTION, PROP_NONE);
@@ -679,10 +815,13 @@ void rna_def_animdata(BlenderRNA *brna)
        RNA_def_property_struct_type(prop, "FCurve");
        RNA_def_property_ui_text(prop, "Drivers", "The Drivers/Expressions for this datablock");
        
+       rna_api_animdata_drivers(brna, prop);
+       
        /* General Settings */
        prop= RNA_def_property(srna, "use_nla", PROP_BOOLEAN, PROP_NONE);
        RNA_def_property_boolean_negative_sdna(prop, NULL, "flag", ADT_NLA_EVAL_OFF);
        RNA_def_property_ui_text(prop, "NLA Evaluation Enabled", "NLA stack is evaluated when evaluating this block");
+       RNA_def_property_update(prop, NC_ANIMATION|ND_NLA, NULL); /* this will do? */
 }
 
 /* --- */