Keying Sets: Wrapped KeyingSets in RNA

* The settings of KeyingSets can now be viewed/modified through RNA. 
* Shuffled RNA wrapping for AnimData over to its own file 
* Moved insert-key flags to DNA_anim_types.h, as they're now used for KeyingSets.

6 files changed, 231 insertions, 47 deletions

diff --git a/source/blender/makesrna/RNA_access.h b/source/blender/makesrna/RNA_access.h
index 4271dcbe8c5..f286cd46479 100644
--- a/source/blender/makesrna/RNA_access.h
+++ b/source/blender/makesrna/RNA_access.h
@@ -117,6 +117,8 @@ extern StructRNA RNA_IntProperty;
 extern StructRNA RNA_JoystickSensor;
 extern StructRNA RNA_Key;
 extern StructRNA RNA_KeyboardSensor;
+extern StructRNA RNA_KeyingSet;
+extern StructRNA RNA_KeyingSetPath;
 extern StructRNA RNA_Lamp;
 extern StructRNA RNA_LampSkySettings;
 extern StructRNA RNA_LampTextureSlot;
diff --git a/source/blender/makesrna/intern/makesrna.c b/source/blender/makesrna/intern/makesrna.c
index 800ee1f5ca1..7f9d82b3dc3 100644
--- a/source/blender/makesrna/intern/makesrna.c
+++ b/source/blender/makesrna/intern/makesrna.c
@@ -1246,7 +1246,8 @@ typedef struct RNAProcessItem {
 RNAProcessItem PROCESS_ITEMS[]= {
 	{"rna_ID.c", RNA_def_ID},
 	{"rna_texture.c", RNA_def_texture},
-	{"rna_action.c", RNA_def_animation},
+	{"rna_action.c", RNA_def_action},
+	{"rna_animation.c", RNA_def_animation},
 	{"rna_actuator.c", RNA_def_actuator},
 	{"rna_armature.c", RNA_def_armature},
 	{"rna_brush.c", RNA_def_brush},
diff --git a/source/blender/makesrna/intern/rna_action.c b/source/blender/makesrna/intern/rna_action.c
index 5143160c69e..03a4ed27e9a 100755
--- a/source/blender/makesrna/intern/rna_action.c
+++ b/source/blender/makesrna/intern/rna_action.c
@@ -261,59 +261,17 @@ void rna_def_action(BlenderRNA *brna)
 	RNA_def_property_ui_text(prop, "Pose Markers", "Markers specific to this Action, for labeling poses.");
 }
 
-/* --- */
-
-void rna_def_animdata_common(StructRNA *srna)
-{
-	PropertyRNA *prop;
-	
-	prop= RNA_def_property(srna, "animation_data", PROP_POINTER, PROP_NONE);
-	RNA_def_property_pointer_sdna(prop, NULL, "adt");
-	RNA_def_property_flag(prop, PROP_NOT_EDITABLE);
-	RNA_def_property_ui_text(prop, "Animation Data", "Animation data for this datablock.");	
-}
-
-void rna_def_animdata(BlenderRNA *brna)
-{
-	StructRNA *srna;
-	PropertyRNA *prop;
-	
-	srna= RNA_def_struct(brna, "AnimData", NULL);
-	//RNA_def_struct_sdna(srna, "AnimData");
-	RNA_def_struct_ui_text(srna, "Animation Data", "Animation data for datablock.");
-	
-	/* NLA */
-	prop= RNA_def_property(srna, "nla_tracks", PROP_COLLECTION, PROP_NONE);
-	RNA_def_property_collection_sdna(prop, NULL, "nla_tracks", NULL);
-	RNA_def_property_struct_type(prop, "UnknownType"); // XXX!
-	RNA_def_property_ui_text(prop, "NLA Tracks", "NLA Tracks (i.e. Animation Layers).");
-	
-	/* Action */
-	prop= RNA_def_property(srna, "action", PROP_POINTER, PROP_NONE);
-	RNA_def_property_ui_text(prop, "Action", "Active Action for this datablock.");	
-	
-	/* Drivers */
-	prop= RNA_def_property(srna, "drivers", PROP_COLLECTION, PROP_NONE);
-	RNA_def_property_collection_sdna(prop, NULL, "drivers", NULL);
-	RNA_def_property_struct_type(prop, "FCurve");
-	RNA_def_property_ui_text(prop, "Drivers", "The Drivers/Expressions for this datablock.");
-	
-	/* Settings */
-}
-
-/* --- */
+/* --------- */
 
-void RNA_def_animation(BlenderRNA *brna)
+void RNA_def_action(BlenderRNA *brna)
 {
-	// XXX move this into its own file?
-	rna_def_animdata(brna);
-	
 	rna_def_action(brna);
 	rna_def_action_group(brna);
 	
-	// XXX move these to their own file?
+	// should these be in their own file, or is that overkill?
 	rna_def_fcurve(brna);
 	rna_def_channeldriver(brna);
 }
 
+
 #endif
diff --git a/source/blender/makesrna/intern/rna_animation.c b/source/blender/makesrna/intern/rna_animation.c
new file mode 100644
index 00000000000..95091741db4
--- /dev/null
+++ b/source/blender/makesrna/intern/rna_animation.c
@@ -0,0 +1,213 @@
+/**
+ * $Id$
+ *
+ * ***** 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., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
+ *
+ * Contributor(s): Blender Foundation (2008), Roland Hess
+ *
+ * ***** END GPL LICENSE BLOCK *****
+ */
+
+#include <stdlib.h>
+
+#include "RNA_define.h"
+#include "RNA_types.h"
+
+#include "rna_internal.h"
+
+#include "DNA_anim_types.h"
+#include "DNA_action_types.h"
+#include "DNA_scene_types.h"
+
+#include "MEM_guardedalloc.h"
+
+#ifdef RNA_RUNTIME
+
+static void rna_ksPath_RnaPath_get(PointerRNA *ptr, char *value)
+{
+	KS_Path *ksp= (KS_Path *)ptr->data;
+
+	if (ksp->rna_path)
+		strcpy(value, ksp->rna_path);
+	else
+		strcpy(value, "");
+}
+
+static int rna_ksPath_RnaPath_length(PointerRNA *ptr)
+{
+	KS_Path *ksp= (KS_Path *)ptr->data;
+	
+	if (ksp->rna_path)
+		return strlen(ksp->rna_path);
+	else
+		return 0;
+}
+
+#if 0
+static void rna_ksPath_RnaPath_set(PointerRNA *ptr, const char *value)
+{
+	KS_Path *ksp= (KS_Path *)ptr->data;
+
+	if (ksp->rna_path)
+		MEM_freeN(ksp->ksp_path);
+	
+	if (strlen(value))
+		ksp->rna_path= BLI_strdup(value);
+	else 
+		ksp->rna_path= NULL;
+}
+#endif
+
+#else
+
+
+void rna_def_keyingset_path(BlenderRNA *brna)
+{
+	StructRNA *srna;
+	PropertyRNA *prop;
+	
+	static EnumPropertyItem prop_mode_grouping_items[] = {
+		{KSP_GROUP_NAMED, "NAMED", "Named Group", ""},
+		{KSP_GROUP_NONE, "NONE", "None", ""},
+		{KSP_GROUP_KSNAME, "KEYINGSET", "Keying Set Name", ""},
+		{0, NULL, NULL, NULL}};
+	
+	srna= RNA_def_struct(brna, "KeyingSetPath", NULL);
+	RNA_def_struct_sdna(srna, "KS_Path");
+	RNA_def_struct_ui_text(srna, "Keying Set Path", "Path to a setting for use in a Keying Set.");
+	
+	/* ID */
+	prop= RNA_def_property(srna, "id", PROP_POINTER, PROP_NONE);
+	RNA_def_property_ui_text(prop, "ID-Block", "ID-Block that keyframes for Keying Set should be added to (for Absolute Keying Sets only).");
+	
+	/* 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.");
+	
+	/* Grouping */
+	prop= RNA_def_property(srna, "grouping", PROP_ENUM, PROP_NONE);
+	RNA_def_property_enum_sdna(prop, NULL, "groupmode");
+	RNA_def_property_enum_items(prop, prop_mode_grouping_items);
+	RNA_def_property_ui_text(prop, "Grouping Method", "Method used to define which Group-name to use.");
+	
+	/* Path + Array Index */
+	prop= RNA_def_property(srna, "rna_path", PROP_STRING, PROP_NONE);
+	RNA_def_property_flag(prop, PROP_NOT_EDITABLE);
+	RNA_def_property_string_funcs(prop, "rna_ksPath_RnaPath_get", "rna_ksPath_RnaPath_length", "rna_ksPath_RnaPath_set");
+	RNA_def_property_ui_text(prop, "RNA Path", "RNA Path to property setting.");
+	
+	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.");
+	
+	/* Flags */
+	prop= RNA_def_property(srna, "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.");
+}
+
+void rna_def_keyingset(BlenderRNA *brna)
+{
+	StructRNA *srna;
+	PropertyRNA *prop;
+	
+	srna= RNA_def_struct(brna, "KeyingSet", NULL);
+	RNA_def_struct_ui_text(srna, "Keying Set", "Settings that should be keyframed together.");
+	
+	/* Name */
+	prop= RNA_def_property(srna, "name", PROP_STRING, PROP_NONE);
+	RNA_def_property_ui_text(prop, "Name", "");
+	RNA_def_struct_name_property(srna, prop);
+	
+	/* Paths */
+	prop= RNA_def_property(srna, "paths", PROP_COLLECTION, PROP_NONE);
+	RNA_def_property_collection_sdna(prop, NULL, "paths", NULL);
+	RNA_def_property_struct_type(prop, "KeyingSetPath");
+	RNA_def_property_ui_text(prop, "Paths", "Keying Set Paths to define settings that get keyframed together.");
+	
+	/* Flags */
+	prop= RNA_def_property(srna, "builtin", PROP_BOOLEAN, PROP_NONE);
+	RNA_def_property_flag(prop, PROP_NOT_EDITABLE);
+	RNA_def_property_boolean_sdna(prop, NULL, "flag", KEYINGSET_BUILTIN);
+	RNA_def_property_ui_text(prop, "Built-In", "Keying Set is a built-in to Blender.");
+	
+		/* TODO: for now, this is editable, but do we really want this to happen? */
+	prop= RNA_def_property(srna, "absolute", PROP_BOOLEAN, PROP_NONE);
+	RNA_def_property_boolean_sdna(prop, NULL, "flag", KEYINGSET_ABSOLUTE);
+	RNA_def_property_ui_text(prop, "Absolute", "Keying Set defines specifc paths/settings to be keyframed (i.e. is not reliant on context info)");
+	
+	/* Keyframing Flags */
+	prop= RNA_def_property(srna, "insertkey_needed", PROP_BOOLEAN, PROP_NONE);
+	RNA_def_property_boolean_sdna(prop, NULL, "keyingflag", INSERTKEY_NEEDED);
+	RNA_def_property_ui_text(prop, "Insert Keyframes - Only Needed", "Only insert keyframes where they're needed in the relevant F-Curves.");
+	
+	prop= RNA_def_property(srna, "insertkey_visual", PROP_BOOLEAN, PROP_NONE);
+	RNA_def_property_boolean_sdna(prop, NULL, "keyingflag", INSERTKEY_MATRIX);
+	RNA_def_property_ui_text(prop, "Insert Keyframes - Visual", "Insert keyframes based on 'visual transforms'.");
+	
+	
+}
+
+/* --- */
+
+void rna_def_animdata_common(StructRNA *srna)
+{
+	PropertyRNA *prop;
+	
+	prop= RNA_def_property(srna, "animation_data", PROP_POINTER, PROP_NONE);
+	RNA_def_property_pointer_sdna(prop, NULL, "adt");
+	RNA_def_property_flag(prop, PROP_NOT_EDITABLE);
+	RNA_def_property_ui_text(prop, "Animation Data", "Animation data for this datablock.");	
+}
+
+void rna_def_animdata(BlenderRNA *brna)
+{
+	StructRNA *srna;
+	PropertyRNA *prop;
+	
+	srna= RNA_def_struct(brna, "AnimData", NULL);
+	RNA_def_struct_ui_text(srna, "Animation Data", "Animation data for datablock.");
+	
+	/* NLA */
+	prop= RNA_def_property(srna, "nla_tracks", PROP_COLLECTION, PROP_NONE);
+	RNA_def_property_collection_sdna(prop, NULL, "nla_tracks", NULL);
+	RNA_def_property_struct_type(prop, "UnknownType"); // XXX!
+	RNA_def_property_ui_text(prop, "NLA Tracks", "NLA Tracks (i.e. Animation Layers).");
+	
+	/* Action */
+	prop= RNA_def_property(srna, "action", PROP_POINTER, PROP_NONE);
+	RNA_def_property_ui_text(prop, "Action", "Active Action for this datablock.");	
+	
+	/* Drivers */
+	prop= RNA_def_property(srna, "drivers", PROP_COLLECTION, PROP_NONE);
+	RNA_def_property_collection_sdna(prop, NULL, "drivers", NULL);
+	RNA_def_property_struct_type(prop, "FCurve");
+	RNA_def_property_ui_text(prop, "Drivers", "The Drivers/Expressions for this datablock.");
+	
+	/* Settings */
+}
+
+/* --- */
+
+void RNA_def_animation(BlenderRNA *brna)
+{
+	rna_def_animdata(brna);
+	
+	rna_def_keyingset(brna);
+	rna_def_keyingset_path(brna);
+}
+
+#endif
diff --git a/source/blender/makesrna/intern/rna_internal.h b/source/blender/makesrna/intern/rna_internal.h
index 27ea74d6331..528cac6fda6 100644
--- a/source/blender/makesrna/intern/rna_internal.h
+++ b/source/blender/makesrna/intern/rna_internal.h
@@ -95,6 +95,7 @@ extern BlenderDefRNA DefRNA;
 extern BlenderRNA BLENDER_RNA;
 
 void RNA_def_ID(struct BlenderRNA *brna);
+void RNA_def_action(struct BlenderRNA *brna);
 void RNA_def_animation(struct BlenderRNA *brna);
 void RNA_def_armature(struct BlenderRNA *brna);
 void RNA_def_actuator(struct BlenderRNA *brna);
diff --git a/source/blender/makesrna/intern/rna_scene.c b/source/blender/makesrna/intern/rna_scene.c
index 6b66b283f36..f8acd6e43ae 100644
--- a/source/blender/makesrna/intern/rna_scene.c
+++ b/source/blender/makesrna/intern/rna_scene.c
@@ -237,6 +237,15 @@ void RNA_def_scene(BlenderRNA *brna)
 	prop= RNA_def_property(srna, "radiosity", PROP_POINTER, PROP_NONE);
 	RNA_def_property_pointer_sdna(prop, NULL, "radio");
 	RNA_def_property_ui_text(prop, "Radiosity", "");
+	
+	prop= RNA_def_property(srna, "keyingsets", PROP_COLLECTION, PROP_NONE);
+	RNA_def_property_collection_sdna(prop, NULL, "keyingsets", NULL);
+	RNA_def_property_struct_type(prop, "KeyingSet");
+	RNA_def_property_ui_text(prop, "Keying Sets", "Keying Sets for this Scene.");
+	
+	prop= RNA_def_property(srna, "active_keyingset", PROP_INT, PROP_NONE);
+	RNA_def_property_flag(prop, PROP_NOT_EDITABLE);
+	RNA_def_property_ui_text(prop, "Active Keying Set", "Current Keying Set index.");
 
 	prop= RNA_def_property(srna, "tool_settings", PROP_POINTER, PROP_NONE);
 	RNA_def_property_pointer_sdna(prop, NULL, "toolsettings");