2.5: UV Edit
[blender.git] / source / blender / makesrna / intern / rna_animation_api.c
1 /**
2  * $Id:
3  *
4  * ***** BEGIN GPL LICENSE BLOCK *****
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version 2
9  * of the License, or (at your option) any later version. 
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software Foundation,
18  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
19  *
20  * The Original Code is Copyright (C) 2009 Blender Foundation.
21  * All rights reserved.
22  *
23  * 
24  * Contributor(s): Joshua Leung
25  *
26  * ***** END GPL LICENSE BLOCK *****
27  */
28
29 #include <stdlib.h>
30 #include <stdio.h>
31
32 #include "RNA_define.h"
33 #include "RNA_enum_types.h"
34 #include "RNA_types.h"
35
36 #include "DNA_anim_types.h"
37 #include "DNA_object_types.h"
38 #include "DNA_scene_types.h"
39
40 #ifdef RNA_RUNTIME
41
42 #include "BKE_animsys.h"
43
44 static void rna_KeyingSet_add_destination(KeyingSet *keyingset, ReportList *reports, 
45                 ID *id, char rna_path[], int array_index, int entire_array,
46                 int grouping_method, char group_name[])
47 {
48         short flag = 0;
49         
50         /* validate flags */
51         if (entire_array)
52                 flag |= KSP_FLAG_WHOLE_ARRAY;
53         
54         /* if data is valid, call the API function for this */
55         if (keyingset) {
56                 BKE_keyingset_add_destination(keyingset, id, group_name, rna_path, array_index, flag, grouping_method);
57         }
58         else {
59                 BKE_report(reports, RPT_ERROR, "Keying Set Destination could not be added.");
60         }
61 }
62
63 #else
64
65 void RNA_api_keyingset(StructRNA *srna)
66 {
67         FunctionRNA *func;
68         PropertyRNA *parm;
69         
70         /* Add Destination */
71         func= RNA_def_function(srna, "add_destination", "rna_KeyingSet_add_destination");
72         RNA_def_function_ui_description(func, "Add a new destination for the Keying Set.");
73         RNA_def_function_flag(func, FUNC_USE_REPORTS);
74                 /* ID-block for target */
75         parm= RNA_def_pointer(func, "target_id", "ID", "Target ID", "ID-Datablock for the destination."); 
76                 RNA_def_property_flag(parm, PROP_REQUIRED);
77                 /* rna-path */
78         parm= RNA_def_string(func, "rna_path", "", 256, "RNA-Path", "RNA-Path to destination property."); // xxx hopefully this is long enough
79                 RNA_def_property_flag(parm, PROP_REQUIRED);
80         parm=RNA_def_int(func, "array_index", 0, 0, INT_MAX, "Array Index", "If applicable, the index ", 0, INT_MAX);
81                 /* flags */
82         parm=RNA_def_boolean(func, "entire_array", 1, "Entire Array", "When an 'array/vector' type is chosen (Location, Rotation, Color, etc.), entire array is to be used.");
83                 /* grouping */
84         parm=RNA_def_enum(func, "grouping_method", keyingset_path_grouping_items, KSP_GROUP_KSNAME, "Grouping Method", "Method used to define which Group-name to use.");
85         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).");
86 }
87
88 #endif
89