replace BLI_strncpy with BLI_strncpy_utf8 where input isnt ensured to be valid.
[blender.git] / source / blender / makesrna / intern / rna_animation.c
index 680a230c1a6200971c3a478d4bc9f3a41537f2fa..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"
@@ -50,6 +53,7 @@ EnumPropertyItem keyingset_path_grouping_items[] = {
 #ifdef RNA_RUNTIME
 
 #include "BKE_animsys.h"
+#include "BKE_fcurve.h"
 #include "BKE_nla.h"
 
 #include "WM_api.h"
@@ -65,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 */
@@ -147,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);
 
@@ -159,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(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 = {{0}};
+       PointerRNA dummyptr = {{NULL}};
        int have_function[3];
 
        /* setup dummy type info to store static properties in */
@@ -185,7 +195,7 @@ static StructRNA *rna_KeyingSetInfo_register(bContext *C, ReportList *reports, v
        /* 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");
@@ -242,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)
@@ -417,6 +427,24 @@ static void rna_NlaTrack_active_set(PointerRNA *ptr, PointerRNA value)
        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
 
 /* helper function for Keying Set -> keying settings */
@@ -450,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 --------------------- */
        
@@ -545,7 +573,8 @@ static void rna_def_keyingset_path(BlenderRNA *brna)
        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
@@ -635,7 +664,7 @@ 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);
        
@@ -683,7 +712,7 @@ static void rna_api_animdata_nla_tracks(BlenderRNA *brna, PropertyRNA *cprop)
        
        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 Tracks");
+       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.");
@@ -704,6 +733,28 @@ static void rna_api_animdata_nla_tracks(BlenderRNA *brna, PropertyRNA *cprop)
        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;
@@ -733,6 +784,7 @@ void rna_def_animdata(BlenderRNA *brna)
        /* 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? */
@@ -763,6 +815,8 @@ 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);