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