2f9582506de238e10d64bf45a6897200ac183121
[blender.git] / source / blender / makesrna / intern / rna_animviz.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  * Contributor(s): Blender Foundation (2010), Joshua Leung
19  *
20  * ***** END GPL LICENSE BLOCK *****
21  */
22
23 /** \file blender/makesrna/intern/rna_animviz.c
24  *  \ingroup RNA
25  */
26
27 #include <stdlib.h>
28
29 #include "DNA_anim_types.h"
30 #include "DNA_action_types.h"
31 #include "DNA_scene_types.h"
32
33 #include "BLI_utildefines.h"
34
35 #include "MEM_guardedalloc.h"
36
37 #include "RNA_define.h"
38 #include "RNA_enum_types.h"
39
40 #include "rna_internal.h"
41
42 #include "WM_types.h"
43
44 /* Which part of bone(s) get baked */
45 // TODO: icons?
46 EnumPropertyItem motionpath_bake_location_items[] = {
47         {MOTIONPATH_BAKE_HEADS, "HEADS", 0, "Heads", "Calculate bone paths from heads"},
48         {0, "TAILS", 0, "Tails", "Calculate bone paths from tails"},
49         //{MOTIONPATH_BAKE_CENTERS, "CENTROID", 0, "Centers", "Calculate bone paths from center of mass"},
50         {0, NULL, 0, NULL, NULL}
51 };
52
53 #ifdef RNA_RUNTIME
54
55 static PointerRNA rna_AnimViz_onion_skinning_get(PointerRNA *ptr)
56 {
57         return rna_pointer_inherit_refine(ptr, &RNA_AnimVizOnionSkinning, ptr->data);
58 }
59
60 static PointerRNA rna_AnimViz_motion_paths_get(PointerRNA *ptr)
61 {
62         return rna_pointer_inherit_refine(ptr, &RNA_AnimVizMotionPaths, ptr->data);
63 }
64
65 static void rna_AnimViz_ghost_start_frame_set(PointerRNA *ptr, int value)
66 {
67         bAnimVizSettings *data = (bAnimVizSettings *)ptr->data;
68         
69         data->ghost_sf = value;
70         CLAMP(data->ghost_ef, data->ghost_sf, MAXFRAME / 2);
71 }
72
73 static void rna_AnimViz_ghost_end_frame_set(PointerRNA *ptr, int value)
74 {
75         bAnimVizSettings *data = (bAnimVizSettings *)ptr->data;
76         
77         data->ghost_ef = value;
78         CLAMP(data->ghost_sf, 1, data->ghost_ef);
79 }
80
81 static void rna_AnimViz_path_start_frame_set(PointerRNA *ptr, int value)
82 {
83         bAnimVizSettings *data = (bAnimVizSettings *)ptr->data;
84         
85         /* XXX: watchit! Path Start > MAXFRAME/2 could be a problem... */
86         data->path_sf = value;
87         CLAMP(data->path_ef, data->path_sf + 1, MAXFRAME / 2);
88 }
89
90 static void rna_AnimViz_path_end_frame_set(PointerRNA *ptr, int value)
91 {
92         bAnimVizSettings *data = (bAnimVizSettings *)ptr->data;
93         
94         data->path_ef = value;
95         CLAMP(data->path_sf, 1, data->path_ef - 1);
96 }
97
98 #else
99
100 void rna_def_motionpath_common(StructRNA *srna)
101 {
102         PropertyRNA *prop;
103         
104         prop = RNA_def_property(srna, "motion_path", PROP_POINTER, PROP_NONE);
105         RNA_def_property_pointer_sdna(prop, NULL, "mpath");
106         RNA_def_property_ui_text(prop, "Motion Path", "Motion Path for this element");
107 }
108
109 static void rna_def_animviz_motionpath_vert(BlenderRNA *brna)
110 {
111         StructRNA *srna;
112         PropertyRNA *prop;
113         
114         srna = RNA_def_struct(brna, "MotionPathVert", NULL);
115         RNA_def_struct_sdna(srna, "bMotionPathVert");
116         RNA_def_struct_ui_text(srna, "Motion Path Cache Point", "Cached location on path");
117         
118         prop = RNA_def_property(srna, "co", PROP_FLOAT, PROP_XYZ);
119         RNA_def_property_array(prop, 3);
120         RNA_def_property_ui_text(prop, "Coordinates", "");
121         
122         prop = RNA_def_property(srna, "select", PROP_BOOLEAN, PROP_NONE);
123         RNA_def_property_boolean_sdna(prop, NULL, "flag", MOTIONPATH_VERT_SEL);
124         RNA_def_property_ui_text(prop, "Select", "Path point is selected for editing");
125 }
126
127 static void rna_def_animviz_motion_path(BlenderRNA *brna)
128 {
129         StructRNA *srna;
130         PropertyRNA *prop;
131         
132         srna = RNA_def_struct(brna, "MotionPath", NULL);
133         RNA_def_struct_sdna(srna, "bMotionPath");
134         RNA_def_struct_ui_text(srna, "Motion Path", "Cache of the worldspace positions of an element over a frame range");
135         
136         /* Collections */
137         prop = RNA_def_property(srna, "points", PROP_COLLECTION, PROP_NONE);
138         RNA_def_property_collection_sdna(prop, NULL, "points", "length");
139         RNA_def_property_struct_type(prop, "MotionPathVert");
140         RNA_def_property_ui_text(prop, "Motion Path Points", "Cached positions per frame");
141         
142         /* Playback Ranges */
143         prop = RNA_def_property(srna, "frame_start", PROP_INT, PROP_TIME);
144         RNA_def_property_int_sdna(prop, NULL, "start_frame");
145         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
146         RNA_def_property_ui_text(prop, "Start Frame", "Starting frame of the stored range");
147         
148         prop = RNA_def_property(srna, "frame_end", PROP_INT, PROP_TIME);
149         RNA_def_property_int_sdna(prop, NULL, "end_frame");
150         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
151         RNA_def_property_ui_text(prop, "End Frame", "End frame of the stored range");
152         
153         prop = RNA_def_property(srna, "length", PROP_INT, PROP_TIME);
154         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
155         RNA_def_property_ui_text(prop, "Length", "Number of frames cached");
156         
157         /* Settings */
158         prop = RNA_def_property(srna, "use_bone_head", PROP_BOOLEAN, PROP_NONE);
159         RNA_def_property_boolean_sdna(prop, NULL, "flag", MOTIONPATH_FLAG_BHEAD);
160         RNA_def_property_clear_flag(prop, PROP_EDITABLE); /* xxx */
161         RNA_def_property_ui_text(prop, "Use Bone Heads",
162                                  "For PoseBone paths, use the bone head location when calculating this path");
163         
164         prop = RNA_def_property(srna, "is_modified", PROP_BOOLEAN, PROP_NONE);
165         RNA_def_property_boolean_sdna(prop, NULL, "flag", MOTIONPATH_FLAG_EDIT);
166         RNA_def_property_ui_text(prop, "Edit Path", "Path is being edited");
167 }
168
169 /* --- */
170
171 static void rna_def_animviz_ghosts(BlenderRNA *brna)
172 {
173         StructRNA *srna;
174         PropertyRNA *prop;
175         
176         static const EnumPropertyItem prop_type_items[] = {
177                 {GHOST_TYPE_NONE, "NONE", 0, "No Ghosts", "Do not show any ghosts"},
178                 {GHOST_TYPE_ACFRA, "CURRENT_FRAME", 0, "Around Current Frame", "Show ghosts from around the current frame"},
179                 {GHOST_TYPE_RANGE, "RANGE", 0, "In Range", "Show ghosts for the specified frame range"},
180                 {GHOST_TYPE_KEYS, "KEYS", 0, "On Keyframes", "Show ghosts on keyframes"},
181                 {0, NULL, 0, NULL, NULL}
182         };
183         
184         
185         srna = RNA_def_struct(brna, "AnimVizOnionSkinning", NULL);
186         RNA_def_struct_sdna(srna, "bAnimVizSettings");
187         RNA_def_struct_nested(brna, srna, "AnimViz");
188         RNA_def_struct_ui_text(srna, "Onion Skinning Settings", "Onion Skinning settings for animation visualization");
189
190         /* Enums */
191         prop = RNA_def_property(srna, "type", PROP_ENUM, PROP_NONE);
192         RNA_def_property_enum_sdna(prop, NULL, "ghost_type");
193         RNA_def_property_enum_items(prop, prop_type_items);
194         RNA_def_property_ui_text(prop, "Type", "Method used for determining what ghosts get drawn");
195         RNA_def_property_update(prop, NC_SPACE | ND_SPACE_VIEW3D, NULL); /* XXX since this is only for 3d-view drawing */
196         
197         /* Settings */
198         prop = RNA_def_property(srna, "show_only_selected", PROP_BOOLEAN, PROP_NONE);
199         RNA_def_property_boolean_sdna(prop, NULL, "ghost_flag", GHOST_FLAG_ONLYSEL);
200         RNA_def_property_ui_text(prop, "On Selected Bones Only",
201                                  "For Pose-Mode drawing, only draw ghosts for selected bones");
202         RNA_def_property_update(prop, NC_SPACE | ND_SPACE_VIEW3D, NULL); /* XXX since this is only for 3d-view drawing */
203         
204         prop = RNA_def_property(srna, "frame_step", PROP_INT, PROP_NONE);
205         RNA_def_property_int_sdna(prop, NULL, "ghost_step");
206         RNA_def_property_range(prop, 1, 20);
207         RNA_def_property_ui_text(prop, "Frame Step",
208                                  "Number of frames between ghosts shown (not for 'On Keyframes' Onion-skinning method)");
209         RNA_def_property_update(prop, NC_SPACE | ND_SPACE_VIEW3D, NULL); /* XXX since this is only for 3d-view drawing */
210         
211         /* Playback Ranges */
212         prop = RNA_def_property(srna, "frame_start", PROP_INT, PROP_TIME);
213         RNA_def_property_int_sdna(prop, NULL, "ghost_sf");
214         RNA_def_property_int_funcs(prop, NULL, "rna_AnimViz_ghost_start_frame_set", NULL);
215         RNA_def_property_ui_text(prop, "Start Frame",
216                                  "Starting frame of range of Ghosts to display "
217                                  "(not for 'Around Current Frame' Onion-skinning method)");
218         RNA_def_property_update(prop, NC_SPACE | ND_SPACE_VIEW3D, NULL); /* XXX since this is only for 3d-view drawing */
219         
220         prop = RNA_def_property(srna, "frame_end", PROP_INT, PROP_TIME);
221         RNA_def_property_int_sdna(prop, NULL, "ghost_ef");
222         RNA_def_property_int_funcs(prop, NULL, "rna_AnimViz_ghost_end_frame_set", NULL);
223         RNA_def_property_ui_text(prop, "End Frame",
224                                  "End frame of range of Ghosts to display "
225                                  "(not for 'Around Current Frame' Onion-skinning method)");
226         RNA_def_property_update(prop, NC_SPACE | ND_SPACE_VIEW3D, NULL); /* XXX since this is only for 3d-view drawing */
227         
228         /* Around Current Ranges */
229         prop = RNA_def_property(srna, "frame_before", PROP_INT, PROP_TIME);
230         RNA_def_property_int_sdna(prop, NULL, "ghost_bc");
231         RNA_def_property_range(prop, 0, 30);
232         RNA_def_property_ui_text(prop, "Before Current",
233                                  "Number of frames to show before the current frame "
234                                  "(only for 'Around Current Frame' Onion-skinning method)");
235         RNA_def_property_update(prop, NC_SPACE | ND_SPACE_VIEW3D, NULL); /* XXX since this is only for 3d-view drawing */
236         
237         prop = RNA_def_property(srna, "frame_after", PROP_INT, PROP_TIME);
238         RNA_def_property_int_sdna(prop, NULL, "ghost_ac");
239         RNA_def_property_range(prop, 0, 30);
240         RNA_def_property_ui_text(prop, "After Current",
241                                  "Number of frames to show after the current frame "
242                                  "(only for 'Around Current Frame' Onion-skinning method)");
243         RNA_def_property_update(prop, NC_SPACE | ND_SPACE_VIEW3D, NULL); /* XXX since this is only for 3d-view drawing */
244 }
245
246 static void rna_def_animviz_paths(BlenderRNA *brna)
247 {
248         StructRNA *srna;
249         PropertyRNA *prop;
250         
251         static const EnumPropertyItem prop_type_items[] = {
252                 {MOTIONPATH_TYPE_ACFRA, "CURRENT_FRAME", 0, "Around Frame",
253                  "Display Paths of poses within a fixed number of frames around the current frame"},
254                 {MOTIONPATH_TYPE_RANGE, "RANGE", 0, "In Range", "Display Paths of poses within specified range"},
255                 {0, NULL, 0, NULL, NULL}
256         };
257         
258         srna = RNA_def_struct(brna, "AnimVizMotionPaths", NULL);
259         RNA_def_struct_sdna(srna, "bAnimVizSettings");
260         RNA_def_struct_nested(brna, srna, "AnimViz");
261         RNA_def_struct_ui_text(srna, "Motion Path Settings", "Motion Path settings for animation visualization");
262         
263         /* Enums */
264         prop = RNA_def_property(srna, "type", PROP_ENUM, PROP_NONE);
265         RNA_def_property_enum_sdna(prop, NULL, "path_type");
266         RNA_def_property_enum_items(prop, prop_type_items);
267         RNA_def_property_ui_text(prop, "Paths Type", "Type of range to show for Motion Paths");
268         RNA_def_property_update(prop, NC_SPACE | ND_SPACE_VIEW3D, NULL); /* XXX since this is only for 3d-view drawing */
269         
270         prop = RNA_def_property(srna, "bake_location", PROP_ENUM, PROP_NONE);
271         RNA_def_property_enum_bitflag_sdna(prop, NULL, "path_bakeflag");
272         RNA_def_property_enum_items(prop, motionpath_bake_location_items);
273         RNA_def_property_ui_text(prop, "Bake Location", "When calculating Bone Paths, use Head or Tips");
274         RNA_def_property_update(prop, NC_SPACE | ND_SPACE_VIEW3D, NULL); /* XXX since this is only for 3d-view drawing */
275         
276         /* Settings */
277         prop = RNA_def_property(srna, "show_frame_numbers", PROP_BOOLEAN, PROP_NONE);
278         RNA_def_property_boolean_sdna(prop, NULL, "path_viewflag", MOTIONPATH_VIEW_FNUMS);
279         RNA_def_property_ui_text(prop, "Show Frame Numbers", "Show frame numbers on Motion Paths");
280         RNA_def_property_update(prop, NC_SPACE | ND_SPACE_VIEW3D, NULL); /* XXX since this is only for 3d-view drawing */
281         
282         prop = RNA_def_property(srna, "show_keyframe_highlight", PROP_BOOLEAN, PROP_NONE);
283         RNA_def_property_boolean_sdna(prop, NULL, "path_viewflag", MOTIONPATH_VIEW_KFRAS);
284         RNA_def_property_ui_text(prop, "Highlight Keyframes", "Emphasize position of keyframes on Motion Paths");
285         RNA_def_property_update(prop, NC_SPACE | ND_SPACE_VIEW3D, NULL); /* XXX since this is only for 3d-view drawing */
286         
287         prop = RNA_def_property(srna, "show_keyframe_numbers", PROP_BOOLEAN, PROP_NONE);
288         RNA_def_property_boolean_sdna(prop, NULL, "path_viewflag", MOTIONPATH_VIEW_KFNOS);
289         RNA_def_property_ui_text(prop, "Show Keyframe Numbers", "Show frame numbers of Keyframes on Motion Paths");
290         RNA_def_property_update(prop, NC_SPACE | ND_SPACE_VIEW3D, NULL); /* XXX since this is only for 3d-view drawing */
291         
292         prop = RNA_def_property(srna, "show_keyframe_action_all", PROP_BOOLEAN, PROP_NONE);
293         RNA_def_property_boolean_sdna(prop, NULL, "path_viewflag", MOTIONPATH_VIEW_KFACT);
294         RNA_def_property_ui_text(prop, "All Action Keyframes",
295                                  "For bone motion paths, search whole Action for keyframes instead of in group"
296                                  " with matching name only (is slower)");
297         RNA_def_property_update(prop, NC_SPACE | ND_SPACE_VIEW3D, NULL); /* XXX since this is only for 3d-view drawing */
298         
299         prop = RNA_def_property(srna, "frame_step", PROP_INT, PROP_NONE);
300         RNA_def_property_int_sdna(prop, NULL, "path_step");
301         RNA_def_property_range(prop, 1, 100);
302         RNA_def_property_ui_text(prop, "Frame Step",
303                                  "Number of frames between paths shown (not for 'On Keyframes' Onion-skinning method)");
304         RNA_def_property_update(prop, NC_SPACE | ND_SPACE_VIEW3D, NULL); /* XXX since this is only for 3d-view drawing */
305         
306         
307         /* Playback Ranges */
308         prop = RNA_def_property(srna, "frame_start", PROP_INT, PROP_TIME);
309         RNA_def_property_int_sdna(prop, NULL, "path_sf");
310         RNA_def_property_int_funcs(prop, NULL, "rna_AnimViz_path_start_frame_set", NULL);
311         RNA_def_property_ui_text(prop, "Start Frame",
312                                  "Starting frame of range of paths to display/calculate "
313                                  "(not for 'Around Current Frame' Onion-skinning method)");
314         RNA_def_property_update(prop, NC_SPACE | ND_SPACE_VIEW3D, NULL); /* XXX since this is only for 3d-view drawing */
315         
316         prop = RNA_def_property(srna, "frame_end", PROP_INT, PROP_TIME);
317         RNA_def_property_int_sdna(prop, NULL, "path_ef");
318         RNA_def_property_int_funcs(prop, NULL, "rna_AnimViz_path_end_frame_set", NULL);
319         RNA_def_property_ui_text(prop, "End Frame",
320                                  "End frame of range of paths to display/calculate "
321                                  "(not for 'Around Current Frame' Onion-skinning method)");
322         RNA_def_property_update(prop, NC_SPACE | ND_SPACE_VIEW3D, NULL); /* XXX since this is only for 3d-view drawing */
323         
324         /* Around Current Ranges */
325         prop = RNA_def_property(srna, "frame_before", PROP_INT, PROP_TIME);
326         RNA_def_property_int_sdna(prop, NULL, "path_bc");
327         RNA_def_property_range(prop, 1, MAXFRAMEF / 2);
328         RNA_def_property_ui_text(prop, "Before Current",
329                                  "Number of frames to show before the current frame "
330                                  "(only for 'Around Current Frame' Onion-skinning method)");
331         RNA_def_property_update(prop, NC_SPACE | ND_SPACE_VIEW3D, NULL); /* XXX since this is only for 3d-view drawing */
332         
333         prop = RNA_def_property(srna, "frame_after", PROP_INT, PROP_TIME);
334         RNA_def_property_int_sdna(prop, NULL, "path_ac");
335         RNA_def_property_range(prop, 1, MAXFRAMEF / 2);
336         RNA_def_property_ui_text(prop, "After Current",
337                                  "Number of frames to show after the current frame "
338                                  "(only for 'Around Current Frame' Onion-skinning method)");
339         RNA_def_property_update(prop, NC_SPACE | ND_SPACE_VIEW3D, NULL); /* XXX since this is only for 3d-view drawing */
340 }
341
342 /* --- */
343
344 void rna_def_animviz_common(StructRNA *srna)
345 {
346         PropertyRNA *prop;
347         
348         prop = RNA_def_property(srna, "animation_visualization", PROP_POINTER, PROP_NONE);
349         RNA_def_property_flag(prop, PROP_NEVER_NULL);
350         RNA_def_property_pointer_sdna(prop, NULL, "avs");
351         RNA_def_property_ui_text(prop, "Animation Visualization", "Animation data for this data-block");
352 }
353
354 static void rna_def_animviz(BlenderRNA *brna)
355 {
356         StructRNA *srna;
357         PropertyRNA *prop;
358         
359         srna = RNA_def_struct(brna, "AnimViz", NULL);
360         RNA_def_struct_sdna(srna, "bAnimVizSettings");
361         RNA_def_struct_ui_text(srna, "Animation Visualization", "Settings for the visualization of motion");
362         
363         /* onion-skinning settings (nested struct) */
364         prop = RNA_def_property(srna, "onion_skin_frames", PROP_POINTER, PROP_NONE);
365         RNA_def_property_flag(prop, PROP_NEVER_NULL);
366         RNA_def_property_struct_type(prop, "AnimVizOnionSkinning");
367         RNA_def_property_pointer_funcs(prop, "rna_AnimViz_onion_skinning_get", NULL, NULL, NULL);
368         RNA_def_property_ui_text(prop, "Onion Skinning", "Onion Skinning (ghosting) settings for visualization");
369         
370         /* motion path settings (nested struct) */
371         prop = RNA_def_property(srna, "motion_path", PROP_POINTER, PROP_NONE);
372         RNA_def_property_flag(prop, PROP_NEVER_NULL);
373         RNA_def_property_struct_type(prop, "AnimVizMotionPaths");
374         RNA_def_property_pointer_funcs(prop, "rna_AnimViz_motion_paths_get", NULL, NULL, NULL);
375         RNA_def_property_ui_text(prop, "Motion Paths", "Motion Path settings for visualization");
376 }
377
378 /* --- */
379
380 void RNA_def_animviz(BlenderRNA *brna)
381 {
382         rna_def_animviz(brna);
383         rna_def_animviz_ghosts(brna);
384         rna_def_animviz_paths(brna);
385                 
386         rna_def_animviz_motion_path(brna);
387         rna_def_animviz_motionpath_vert(brna);
388 }
389
390 #endif