f201b8e6e99ba1087490c39ce31308ec372116c3
[blender.git] / source / blender / makesrna / intern / rna_animation_api.c
1 /*
2  * This program is free software; you can redistribute it and/or
3  * modify it under the terms of the GNU General Public License
4  * as published by the Free Software Foundation; either version 2
5  * of the License, or (at your option) any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software Foundation,
14  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
15  *
16  * The Original Code is Copyright (C) 2009 Blender Foundation.
17  * All rights reserved.
18  */
19
20 /** \file
21  * \ingroup RNA
22  */
23
24 #include <stdlib.h>
25 #include <stdio.h>
26
27 #include "RNA_define.h"
28 #include "RNA_enum_types.h"
29
30 #include "DNA_anim_types.h"
31 #include "DNA_object_types.h"
32 #include "DNA_scene_types.h"
33
34 #include "rna_internal.h" /* own include */
35
36 #ifdef RNA_RUNTIME
37
38 #  include "BKE_context.h"
39 #  include "BKE_report.h"
40
41 #  include "ED_keyframing.h"
42
43 static void rna_KeyingSet_context_refresh(KeyingSet *ks, bContext *C, ReportList *reports)
44 {
45   /* TODO: enable access to providing a list of overrides (dsources)? */
46   int success = ANIM_validate_keyingset(C, NULL, ks);
47
48   if (success != 0) {
49     switch (success) {
50       case MODIFYKEY_INVALID_CONTEXT:
51         BKE_report(reports, RPT_ERROR, "Invalid context for keying set");
52         break;
53
54       case MODIFYKEY_MISSING_TYPEINFO:
55         BKE_report(
56             reports, RPT_ERROR, "Incomplete built-in keying set, appears to be missing type info");
57         break;
58     }
59   }
60 }
61
62 #else
63
64 void RNA_api_keyingset(StructRNA *srna)
65 {
66   FunctionRNA *func;
67   /*PropertyRNA *parm; */
68
69   /* validate relative Keying Set (used to ensure paths are ok for context) */
70   func = RNA_def_function(srna, "refresh", "rna_KeyingSet_context_refresh");
71   RNA_def_function_ui_description(
72       func,
73       "Refresh Keying Set to ensure that it is valid for the current context "
74       "(call before each use of one)");
75   RNA_def_function_flag(func, FUNC_USE_CONTEXT | FUNC_USE_REPORTS);
76 }
77
78 #endif