Bugfix [#25960] Action/NLA Editor issues with animdata context
[blender-staging.git] / source / blender / makesrna / intern / rna_gpencil.c
1 /*
2  * $Id$
3  *
4  * ***** BEGIN GPL LICENSE BLOCK *****
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version 2
9  * of the License, or (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software Foundation,
18  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
19  *
20  * Contributor(s): Blender Foundation (2009), Joshua Leung
21  *
22  * ***** END GPL LICENSE BLOCK *****
23  */
24
25 /** \file blender/makesrna/intern/rna_gpencil.c
26  *  \ingroup RNA
27  */
28
29
30 #include <stdlib.h>
31
32 #include "RNA_define.h"
33
34 #include "rna_internal.h"
35
36 #include "DNA_gpencil_types.h"
37 #include "DNA_scene_types.h"
38
39 #include "MEM_guardedalloc.h"
40
41 #include "WM_types.h"
42
43 #ifdef RNA_RUNTIME
44
45 static int rna_GPencilLayer_active_frame_editable(PointerRNA *ptr)
46 {
47         bGPDlayer *gpl= (bGPDlayer *)ptr->data;
48
49         /* surely there must be other criteria too... */
50         if (gpl->flag & GP_LAYER_LOCKED)
51                 return 0;
52         else
53                 return 1;
54 }
55
56 static PointerRNA rna_GPencil_active_layer_get(PointerRNA *ptr)
57 {
58         bGPdata *gpd= ptr->id.data;
59
60         if (GS(gpd->id.name) == ID_GD) { /* why would this ever be not GD */
61                 bGPDlayer *gl;
62
63                 for (gl= gpd->layers.first; gl; gl= gl->next) {
64                         if(gl->flag & GP_LAYER_ACTIVE) {
65                                 break;
66                         }
67                 }
68
69                 if(gl) {
70                         return rna_pointer_inherit_refine(ptr, &RNA_GPencilLayer, gl);
71                 }
72         }
73
74         return rna_pointer_inherit_refine(ptr, NULL, NULL);
75 }
76
77 static void rna_GPencil_active_layer_set(PointerRNA *ptr, PointerRNA value)
78 {
79         bGPdata *gpd= ptr->id.data;
80
81         if (GS(gpd->id.name) == ID_GD) { /* why would this ever be not GD */
82                 bGPDlayer *gl;
83
84                 for (gl= gpd->layers.first; gl; gl= gl->next) {
85                         if(gl == value.data) {
86                                 gl->flag |= GP_LAYER_ACTIVE;
87                         }
88                         else {
89                                 gl->flag &= ~GP_LAYER_ACTIVE;
90                         }
91                 }
92         }
93 }
94
95 #else
96
97 static void rna_def_gpencil_stroke_point(BlenderRNA *brna)
98 {
99         StructRNA *srna;
100         PropertyRNA *prop;
101         
102         srna= RNA_def_struct(brna, "GPencilStrokePoint", NULL);
103         RNA_def_struct_sdna(srna, "bGPDspoint");
104         RNA_def_struct_ui_text(srna, "Grease Pencil Stroke Point", "Data point for freehand stroke curve");
105         
106         prop= RNA_def_property(srna, "co", PROP_FLOAT, PROP_XYZ);
107         RNA_def_property_float_sdna(prop, NULL, "x");
108         RNA_def_property_array(prop, 3);
109         RNA_def_property_ui_text(prop, "Coordinates", "");
110         RNA_def_property_update(prop, NC_SCREEN|ND_GPENCIL, NULL);
111         
112         prop= RNA_def_property(srna, "pressure", PROP_FLOAT, PROP_NONE);
113         RNA_def_property_float_sdna(prop, NULL, "pressure");
114         RNA_def_property_range(prop, 0.0f, 1.0f);
115         RNA_def_property_ui_text(prop, "Pressure", "Pressure of tablet at point when drawing it");
116         RNA_def_property_update(prop, NC_SCREEN|ND_GPENCIL, NULL);
117 }
118
119 static void rna_def_gpencil_stroke(BlenderRNA *brna)
120 {
121         StructRNA *srna;
122         PropertyRNA *prop;
123         
124         srna= RNA_def_struct(brna, "GPencilStroke", NULL);
125         RNA_def_struct_sdna(srna, "bGPDstroke");
126         RNA_def_struct_ui_text(srna, "Grease Pencil Stroke", "Freehand curve defining part of a sketch");
127         
128         /* Points */
129         prop= RNA_def_property(srna, "points", PROP_COLLECTION, PROP_NONE);
130         RNA_def_property_collection_sdna(prop, NULL, "points", "totpoints");
131         RNA_def_property_struct_type(prop, "GPencilStrokePoint");
132         RNA_def_property_ui_text(prop, "Stroke Points", "Stroke data points");
133         
134         /* Flags - Readonly type-info really... */
135         // TODO...
136 }
137
138 static void rna_def_gpencil_frame(BlenderRNA *brna)
139 {
140         StructRNA *srna;
141         PropertyRNA *prop;
142         
143         srna= RNA_def_struct(brna, "GPencilFrame", NULL);
144         RNA_def_struct_sdna(srna, "bGPDframe");
145         RNA_def_struct_ui_text(srna, "Grease Pencil Frame", "Collection of related sketches on a particular frame");
146         
147         /* Strokes */
148         prop= RNA_def_property(srna, "strokes", PROP_COLLECTION, PROP_NONE);
149         RNA_def_property_collection_sdna(prop, NULL, "strokes", NULL);
150         RNA_def_property_struct_type(prop, "GPencilStroke");
151         RNA_def_property_ui_text(prop, "Strokes", "Freehand curves defining the sketch on this frame");
152         
153         /* Frame Number */
154         prop= RNA_def_property(srna, "frame_number", PROP_INT, PROP_NONE);
155         RNA_def_property_int_sdna(prop, NULL, "framenum");
156         RNA_def_property_range(prop, MINFRAME, MAXFRAME); // XXX note: this cannot occur on the same frame as another sketch
157         RNA_def_property_ui_text(prop, "Frame Number", "The frame on which this sketch appears");
158         
159         /* Flags */
160         prop= RNA_def_property(srna, "is_edited", PROP_BOOLEAN, PROP_NONE);
161         RNA_def_property_boolean_sdna(prop, NULL, "flag", GP_FRAME_PAINT); // XXX should it be editable?
162         RNA_def_property_ui_text(prop, "Paint Lock", "Frame is being edited (painted on)");
163         
164         prop= RNA_def_property(srna, "select", PROP_BOOLEAN, PROP_NONE);
165         RNA_def_property_boolean_sdna(prop, NULL, "flag", GP_FRAME_SELECT);
166         RNA_def_property_ui_text(prop, "Select", "Frame is selected for editing in the DopeSheet");
167 }
168
169 static void rna_def_gpencil_layer(BlenderRNA *brna)
170 {
171         StructRNA *srna;
172         PropertyRNA *prop;
173         
174         srna= RNA_def_struct(brna, "GPencilLayer", NULL);
175         RNA_def_struct_sdna(srna, "bGPDlayer");
176         RNA_def_struct_ui_text(srna, "Grease Pencil Layer", "Collection of related sketches");
177         
178         /* Name */
179         prop= RNA_def_property(srna, "info", PROP_STRING, PROP_NONE);
180         RNA_def_property_ui_text(prop, "Info", "Layer name");
181         RNA_def_struct_name_property(srna, prop);
182         
183         /* Frames */
184         prop= RNA_def_property(srna, "frames", PROP_COLLECTION, PROP_NONE);
185         RNA_def_property_collection_sdna(prop, NULL, "frames", NULL);
186         RNA_def_property_struct_type(prop, "GPencilFrame");
187         RNA_def_property_ui_text(prop, "Frames", "Sketches for this layer on different frames");
188         
189         /* Active Frame */
190         prop= RNA_def_property(srna, "active_frame", PROP_POINTER, PROP_NONE);
191         RNA_def_property_pointer_sdna(prop, NULL, "actframe");
192         RNA_def_property_ui_text(prop, "Active Frame", "Frame currently being displayed for this layer");
193         RNA_def_property_editable_func(prop, "rna_GPencilLayer_active_frame_editable");
194         
195         /* Drawing Color */
196         prop= RNA_def_property(srna, "color", PROP_FLOAT, PROP_COLOR);
197         RNA_def_property_array(prop, 3);
198         RNA_def_property_range(prop, 0.0f, 1.0f);
199         RNA_def_property_ui_text(prop, "Color", "Color for all strokes in this layer");
200         RNA_def_property_update(prop, NC_SCREEN|ND_GPENCIL, NULL);
201         
202         prop= RNA_def_property(srna, "alpha", PROP_FLOAT, PROP_NONE);
203         RNA_def_property_float_sdna(prop, NULL, "color[3]");
204         RNA_def_property_range(prop, 0.3, 1.0f);
205         RNA_def_property_ui_text(prop, "Opacity", "Layer Opacity");
206         RNA_def_property_update(prop, NC_SCREEN|ND_GPENCIL, NULL);
207         
208         /* Line Thickness */
209         prop= RNA_def_property(srna, "line_width", PROP_INT, PROP_NONE);
210         RNA_def_property_int_sdna(prop, NULL, "thickness");
211         RNA_def_property_range(prop, 1, 10);
212         RNA_def_property_ui_text(prop, "Thickness", "Thickness of strokes (in pixels)");
213         RNA_def_property_update(prop, NC_SCREEN|ND_GPENCIL, NULL);
214         
215         /* Onion-Skinning */
216         prop= RNA_def_property(srna, "use_onion_skinning", PROP_BOOLEAN, PROP_NONE);
217         RNA_def_property_boolean_sdna(prop, NULL, "flag", GP_LAYER_ONIONSKIN);
218         RNA_def_property_ui_text(prop, "Use Onion Skinning", "Ghost frames on either side of frame");
219         RNA_def_property_update(prop, NC_SCREEN|ND_GPENCIL, NULL);
220         
221         prop= RNA_def_property(srna, "ghost_range_max", PROP_INT, PROP_NONE);
222         RNA_def_property_int_sdna(prop, NULL, "gstep");
223         RNA_def_property_range(prop, 0, 120);
224         RNA_def_property_ui_text(prop, "Max Ghost Range", "Maximum number of frames on either side of the active frame to show (0 = show the 'first' available sketch on either side)");
225         RNA_def_property_update(prop, NC_SCREEN|ND_GPENCIL, NULL);
226         
227         /* Flags */
228         prop= RNA_def_property(srna, "hide", PROP_BOOLEAN, PROP_NONE);
229         RNA_def_property_boolean_sdna(prop, NULL, "flag", GP_LAYER_HIDE);
230         RNA_def_property_ui_text(prop, "Hide", "Set layer Visibility");
231         RNA_def_property_update(prop, NC_SCREEN|ND_GPENCIL, NULL);
232         
233         prop= RNA_def_property(srna, "lock", PROP_BOOLEAN, PROP_NONE);
234         RNA_def_property_boolean_sdna(prop, NULL, "flag", GP_LAYER_LOCKED);
235         RNA_def_property_ui_text(prop, "Locked", "Protect layer from further editing and/or frame changes");
236         RNA_def_property_update(prop, NC_SCREEN|ND_GPENCIL, NULL);
237         
238         prop= RNA_def_property(srna, "lock_frame", PROP_BOOLEAN, PROP_NONE);
239         RNA_def_property_boolean_sdna(prop, NULL, "flag", GP_LAYER_FRAMELOCK);
240         RNA_def_property_ui_text(prop, "Frame Locked", "Lock current frame displayed by layer");
241         RNA_def_property_update(prop, NC_SCREEN|ND_GPENCIL, NULL);
242
243         /* expose as layers.active */
244         /*
245         prop= RNA_def_property(srna, "active", PROP_BOOLEAN, PROP_NONE);
246         RNA_def_property_boolean_sdna(prop, NULL, "flag", GP_LAYER_ACTIVE);
247         RNA_def_property_boolean_funcs(prop, NULL, "rna_GPencilLayer_active_set");
248         RNA_def_property_ui_text(prop, "Active", "Set active layer for editing");
249         RNA_def_property_update(prop, NC_SCREEN|ND_GPENCIL, NULL);
250         */
251
252         prop= RNA_def_property(srna, "select", PROP_BOOLEAN, PROP_NONE);
253         RNA_def_property_boolean_sdna(prop, NULL, "flag", GP_LAYER_SELECT);
254         RNA_def_property_ui_text(prop, "Select", "Layer is selected for editing in the DopeSheet");
255         RNA_def_property_update(prop, NC_SCREEN|ND_GPENCIL, NULL);
256         
257                 // XXX keep this option?
258         prop= RNA_def_property(srna, "show_points", PROP_BOOLEAN, PROP_NONE);
259         RNA_def_property_boolean_sdna(prop, NULL, "flag", GP_LAYER_DRAWDEBUG);
260         RNA_def_property_ui_text(prop, "Show Points", "Draw the points which make up the strokes (for debugging purposes)");
261         RNA_def_property_update(prop, NC_SCREEN|ND_GPENCIL, NULL);
262
263         /* X-Ray */
264         prop= RNA_def_property(srna, "show_x_ray", PROP_BOOLEAN, PROP_NONE);
265         RNA_def_property_boolean_negative_sdna(prop, NULL, "flag", GP_LAYER_NO_XRAY);
266         RNA_def_property_ui_text(prop, "X Ray", "");
267         RNA_def_property_update(prop, NC_SCREEN|ND_GPENCIL, NULL);
268 }
269
270 static void rna_def_gpencil_layers(BlenderRNA *brna, PropertyRNA *cprop)
271 {
272         StructRNA *srna;
273         PropertyRNA *prop;
274
275 //      FunctionRNA *func;
276 //      PropertyRNA *parm;
277
278         RNA_def_property_srna(cprop, "GreasePencilLayers");
279         srna= RNA_def_struct(brna, "GreasePencilLayers", NULL);
280         RNA_def_struct_sdna(srna, "bGPdata");
281         RNA_def_struct_ui_text(srna, "Grease Pencil Layers", "Collection of grease pencil layers");
282
283 #if 0
284         func= RNA_def_function(srna, "new", "rna_GPencil_layer_new");
285         RNA_def_function_ui_description(func, "Add a new spline to the curve.");
286         parm= RNA_def_enum(func, "type", curve_type_items, CU_POLY, "", "type for the new spline.");
287         RNA_def_property_flag(parm, PROP_REQUIRED);
288         parm= RNA_def_pointer(func, "spline", "Spline", "", "The newly created spline.");
289         RNA_def_function_return(func, parm);
290
291         func= RNA_def_function(srna, "remove", "rna_GPencil_layer_remove");
292         RNA_def_function_ui_description(func, "Remove a spline from a curve.");
293         RNA_def_function_flag(func, FUNC_USE_REPORTS);
294         parm= RNA_def_pointer(func, "spline", "Spline", "", "The spline to remove.");
295         RNA_def_property_flag(parm, PROP_REQUIRED|PROP_NEVER_NULL);
296 #endif
297
298         prop= RNA_def_property(srna, "active", PROP_POINTER, PROP_NONE);
299         RNA_def_property_struct_type(prop, "GreasePencil");
300         RNA_def_property_pointer_funcs(prop, "rna_GPencil_active_layer_get", "rna_GPencil_active_layer_set", NULL, NULL);
301         RNA_def_property_flag(prop, PROP_EDITABLE);
302         RNA_def_property_ui_text(prop, "Active Layer", "Active grease pencil layer");
303 }
304
305 static void rna_def_gpencil_data(BlenderRNA *brna)
306 {
307         StructRNA *srna;
308         PropertyRNA *prop;
309         
310         static EnumPropertyItem draw_mode_items[] = {
311                 {GP_DATA_VIEWALIGN, "CURSOR", 0, "Cursor", "Draw stroke at the 3D cursor"},
312                 {0, "VIEW", 0, "View", "Stick stroke to the view "}, /* weired, GP_DATA_VIEWALIGN is inverted */
313                 {GP_DATA_VIEWALIGN|GP_DATA_DEPTH_VIEW, "SURFACE", 0, "Surface", "Stick stroke to surfaces"},
314                 {GP_DATA_VIEWALIGN|GP_DATA_DEPTH_STROKE, "STROKE", 0, "Stroke", "Stick stroke to other strokes"},
315                 {0, NULL, 0, NULL, NULL}};
316
317         srna= RNA_def_struct(brna, "GreasePencil", "ID");
318         RNA_def_struct_sdna(srna, "bGPdata");
319         RNA_def_struct_ui_text(srna, "Grease Pencil", "Freehand annotation sketchbook");
320         RNA_def_struct_ui_icon(srna, ICON_GREASEPENCIL);
321         
322         /* Layers */
323         prop= RNA_def_property(srna, "layers", PROP_COLLECTION, PROP_NONE);
324         RNA_def_property_collection_sdna(prop, NULL, "layers", NULL);
325         RNA_def_property_struct_type(prop, "GPencilLayer");
326         RNA_def_property_ui_text(prop, "Layers", "");
327         rna_def_gpencil_layers(brna, prop);
328         
329         /* Flags */
330         prop= RNA_def_property(srna, "draw_mode", PROP_ENUM, PROP_NONE);
331         RNA_def_property_enum_bitflag_sdna(prop, NULL, "flag");
332         RNA_def_property_enum_items(prop, draw_mode_items);
333         RNA_def_property_ui_text(prop, "Draw Mode", "");
334
335         prop= RNA_def_property(srna, "use_stroke_endpoints", PROP_BOOLEAN, PROP_NONE);
336         RNA_def_property_boolean_sdna(prop, NULL, "flag", GP_DATA_DEPTH_STROKE_ENDPOINTS);
337         RNA_def_property_ui_text(prop, "Only Endpoints", "Only use the first and last parts of the stroke for snapping");
338
339
340 }
341
342 /* --- */
343
344 void RNA_def_gpencil(BlenderRNA *brna)
345 {
346         rna_def_gpencil_data(brna);
347
348         rna_def_gpencil_layer(brna);
349         rna_def_gpencil_frame(brna);
350         rna_def_gpencil_stroke(brna);
351         rna_def_gpencil_stroke_point(brna);
352 }
353
354 #endif