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