Merge branch 'master' into blender2.8
[blender.git] / source / blender / makesrna / intern / rna_fcurve_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_fcurve_api.c
28  *  \ingroup RNA
29  */
30
31
32 #include <stdlib.h>
33 #include <stdio.h>
34 #include <string.h>
35 #include <time.h>
36
37 #include "BLI_utildefines.h"
38
39 #include "RNA_define.h"
40
41 #include "DNA_anim_types.h"
42 #include "DNA_scene_types.h"
43
44 #include "rna_internal.h"  /* own include */
45
46 #ifdef RNA_RUNTIME
47
48 #include <stddef.h>
49
50 #include "BKE_animsys.h"
51 #include "BKE_fcurve.h"
52
53 #include "BLI_math.h"
54
55 static void rna_FCurve_convert_to_samples(FCurve *fcu, ReportList *reports, int start, int end)
56 {
57         /* XXX fcurve_store_samples uses end frame included, which is not consistent with usual behavior in Blender,
58          * nor python slices, etc. Let have public py API be consistent here at least. */
59         end--;
60         if (start > end) {
61                 BKE_reportf(reports, RPT_ERROR, "Invalid frame range (%d - %d)", start, end + 1);
62         }
63         else if (fcu->fpt) {
64                 BKE_report(reports, RPT_WARNING, "FCurve has already sample points");
65         }
66         else if (!fcu->bezt) {
67                 BKE_report(reports, RPT_WARNING, "FCurve has no keyframes");
68         }
69         else {
70                 fcurve_store_samples(fcu, NULL, start, end, fcurve_samplingcb_evalcurve);
71                 WM_main_add_notifier(NC_ANIMATION | ND_ANIMCHAN | NA_EDITED, NULL);
72         }
73 }
74
75 static void rna_FCurve_convert_to_keyframes(FCurve *fcu, ReportList *reports, int start, int end)
76 {
77         if (start >= end) {
78                 BKE_reportf(reports, RPT_ERROR, "Invalid frame range (%d - %d)", start, end);
79         }
80         else if (fcu->bezt) {
81                 BKE_report(reports, RPT_WARNING, "FCurve has already keyframes");
82         }
83         else if (!fcu->fpt) {
84                 BKE_report(reports, RPT_WARNING, "FCurve has no sample points");
85         }
86         else {
87                 BezTriple *bezt;
88                 FPoint *fpt = fcu->fpt;
89                 int tot_kf = end - start;
90                 int tot_sp = fcu->totvert;
91
92                 bezt = fcu->bezt = MEM_callocN(sizeof(*fcu->bezt) * (size_t)tot_kf, __func__);
93                 fcu->totvert = tot_kf;
94
95                 /* Get first sample point to 'copy' as keyframe. */
96                 for (; tot_sp && (fpt->vec[0] < (float)start); fpt++, tot_sp--);
97
98                 /* Add heading dummy flat points if needed. */
99                 for (; tot_kf && (fpt->vec[0] > (float)start); start++, bezt++, tot_kf--) {
100                         /* Linear interpolation, of course. */
101                         bezt->f1 = bezt->f2 = bezt->f3 = SELECT;
102                         bezt->ipo = BEZT_IPO_LIN;
103                         bezt->h1 = bezt->h2 = HD_AUTO_ANIM;
104                         bezt->vec[1][0] = (float)start;
105                         bezt->vec[1][1] = fpt->vec[1];
106                 }
107
108                 /* Copy actual sample points. */
109                 for (; tot_kf && tot_sp; start++, bezt++, tot_kf--, fpt++, tot_sp--) {
110                         /* Linear interpolation, of course. */
111                         bezt->f1 = bezt->f2 = bezt->f3 = SELECT;
112                         bezt->ipo = BEZT_IPO_LIN;
113                         bezt->h1 = bezt->h2 = HD_AUTO_ANIM;
114                         copy_v2_v2(bezt->vec[1], fpt->vec);
115                 }
116
117                 /* Add leading dummy flat points if needed. */
118                 for (fpt--; tot_kf; start++, bezt++, tot_kf--) {
119                         /* Linear interpolation, of course. */
120                         bezt->f1 = bezt->f2 = bezt->f3 = SELECT;
121                         bezt->ipo = BEZT_IPO_LIN;
122                         bezt->h1 = bezt->h2 = HD_AUTO_ANIM;
123                         bezt->vec[1][0] = (float)start;
124                         bezt->vec[1][1] = fpt->vec[1];
125                 }
126
127                 MEM_SAFE_FREE(fcu->fpt);
128
129                 /* Not strictly needed since we use linear interpolation, but better be consistent here. */
130                 calchandles_fcurve(fcu);
131                 WM_main_add_notifier(NC_ANIMATION | ND_ANIMCHAN | NA_EDITED, NULL);
132         }
133 }
134
135 #else
136
137 void RNA_api_fcurves(StructRNA *srna)
138 {
139         FunctionRNA *func;
140         PropertyRNA *parm;
141
142         func = RNA_def_function(srna, "convert_to_samples", "rna_FCurve_convert_to_samples");
143         RNA_def_function_ui_description(func,
144                                         "Convert current FCurve from keyframes to sample points, if necessary");
145         RNA_def_function_flag(func, FUNC_USE_REPORTS);
146         parm = RNA_def_int(func, "start", 0, MINAFRAME, MAXFRAME, "Start Frame", "", MINAFRAME, MAXFRAME);
147         RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
148         parm = RNA_def_int(func, "end", 0, MINAFRAME, MAXFRAME, "End Frame", "", MINAFRAME, MAXFRAME);
149         RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
150
151         func = RNA_def_function(srna, "convert_to_keyframes", "rna_FCurve_convert_to_keyframes");
152         RNA_def_function_ui_description(func,
153                                         "Convert current FCurve from sample points to keyframes (linear interpolation), "
154                                         "if necessary");
155         RNA_def_function_flag(func, FUNC_USE_REPORTS);
156         parm = RNA_def_int(func, "start", 0, MINAFRAME, MAXFRAME, "Start Frame", "", MINAFRAME, MAXFRAME);
157         RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
158         parm = RNA_def_int(func, "end", 0, MINAFRAME, MAXFRAME, "End Frame", "", MINAFRAME, MAXFRAME);
159         RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
160 }
161
162 void RNA_api_drivers(StructRNA *UNUSED(srna))
163 {
164 /*      FunctionRNA *func; */
165 /*      PropertyRNA *parm; */
166 }
167
168 #endif