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