Bugfix #24837
[blender.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 #include <stdlib.h>
26
27 #include "RNA_define.h"
28
29 #include "rna_internal.h"
30
31 #include "DNA_gpencil_types.h"
32 #include "DNA_scene_types.h"
33
34 #include "MEM_guardedalloc.h"
35
36 #include "WM_types.h"
37
38 #ifdef RNA_RUNTIME
39
40 static int rna_GPencilLayer_active_frame_editable(PointerRNA *ptr)
41 {
42         bGPDlayer *gpl= (bGPDlayer *)ptr->data;
43         
44         /* surely there must be other criteria too... */
45         if (gpl->flag & GP_LAYER_LOCKED)
46                 return 0;
47         else
48                 return 1;
49 }
50
51 static void rna_GPencilLayer_active_set(PointerRNA *ptr, int value)
52 {
53         bGPdata *gpd= ptr->id.data;
54         bGPDlayer *gpl= ptr->data;
55         
56         /* disabled all other layers anyway */
57         if (GS(gpd->id.name) == ID_GD) {
58                 bGPDlayer *gl;
59                 
60                 for (gl= gpd->layers.first; gl; gl= gl->next)
61                         gl->flag &= ~GP_LAYER_ACTIVE;
62         }       
63         
64         /* if enabling value, make it active */
65         if (value)
66                 gpl->flag |= GP_LAYER_ACTIVE;
67 }
68
69 #else
70
71 static void rna_def_gpencil_stroke_point(BlenderRNA *brna)
72 {
73         StructRNA *srna;
74         PropertyRNA *prop;
75         
76         srna= RNA_def_struct(brna, "GPencilStrokePoint", NULL);
77         RNA_def_struct_sdna(srna, "bGPDspoint");
78         RNA_def_struct_ui_text(srna, "Grease Pencil Stroke Point", "Data point for freehand stroke curve");
79         
80         prop= RNA_def_property(srna, "co", PROP_FLOAT, PROP_XYZ);
81         RNA_def_property_float_sdna(prop, NULL, "x");
82         RNA_def_property_array(prop, 3);
83         RNA_def_property_ui_text(prop, "Coordinates", "");
84         RNA_def_property_update(prop, NC_SCREEN|ND_GPENCIL, NULL);
85         
86         prop= RNA_def_property(srna, "pressure", PROP_FLOAT, PROP_NONE);
87         RNA_def_property_float_sdna(prop, NULL, "pressure");
88         RNA_def_property_range(prop, 0.0f, 1.0f);
89         RNA_def_property_ui_text(prop, "Pressure", "Pressure of tablet at point when drawing it");
90         RNA_def_property_update(prop, NC_SCREEN|ND_GPENCIL, NULL);
91 }
92
93 static void rna_def_gpencil_stroke(BlenderRNA *brna)
94 {
95         StructRNA *srna;
96         PropertyRNA *prop;
97         
98         srna= RNA_def_struct(brna, "GPencilStroke", NULL);
99         RNA_def_struct_sdna(srna, "bGPDstroke");
100         RNA_def_struct_ui_text(srna, "Grease Pencil Stroke", "Freehand curve defining part of a sketch");
101         
102         /* Points */
103         prop= RNA_def_property(srna, "points", PROP_COLLECTION, PROP_NONE);
104         RNA_def_property_collection_sdna(prop, NULL, "points", "totpoints");
105         RNA_def_property_struct_type(prop, "GPencilStrokePoint");
106         RNA_def_property_ui_text(prop, "Stroke Points", "Stroke data points");
107         
108         /* Flags - Readonly type-info really... */
109         // TODO...
110 }
111
112 static void rna_def_gpencil_frame(BlenderRNA *brna)
113 {
114         StructRNA *srna;
115         PropertyRNA *prop;
116         
117         srna= RNA_def_struct(brna, "GPencilFrame", NULL);
118         RNA_def_struct_sdna(srna, "bGPDframe");
119         RNA_def_struct_ui_text(srna, "Grease Pencil Frame", "Collection of related sketches on a particular frame");
120         
121         /* Strokes */
122         prop= RNA_def_property(srna, "strokes", PROP_COLLECTION, PROP_NONE);
123         RNA_def_property_collection_sdna(prop, NULL, "strokes", NULL);
124         RNA_def_property_struct_type(prop, "GPencilStroke");
125         RNA_def_property_ui_text(prop, "Strokes", "Freehand curves defining the sketch on this frame");
126         
127         /* Frame Number */
128         prop= RNA_def_property(srna, "frame_number", PROP_INT, PROP_NONE);
129         RNA_def_property_int_sdna(prop, NULL, "framenum");
130         RNA_def_property_range(prop, MINFRAME, MAXFRAME); // XXX note: this cannot occur on the same frame as another sketch
131         RNA_def_property_ui_text(prop, "Frame Number", "The frame on which this sketch appears");
132         
133         /* Flags */
134         prop= RNA_def_property(srna, "is_edited", PROP_BOOLEAN, PROP_NONE);
135         RNA_def_property_boolean_sdna(prop, NULL, "flag", GP_FRAME_PAINT); // XXX should it be editable?
136         RNA_def_property_ui_text(prop, "Paint Lock", "Frame is being edited (painted on)");
137         
138         prop= RNA_def_property(srna, "select", PROP_BOOLEAN, PROP_NONE);
139         RNA_def_property_boolean_sdna(prop, NULL, "flag", GP_FRAME_SELECT);
140         RNA_def_property_ui_text(prop, "Select", "Frame is selected for editing in the DopeSheet");
141 }
142
143 static void rna_def_gpencil_layer(BlenderRNA *brna)
144 {
145         StructRNA *srna;
146         PropertyRNA *prop;
147         
148         srna= RNA_def_struct(brna, "GPencilLayer", NULL);
149         RNA_def_struct_sdna(srna, "bGPDlayer");
150         RNA_def_struct_ui_text(srna, "Grease Pencil Layer", "Collection of related sketches");
151         
152         /* Name */
153         prop= RNA_def_property(srna, "info", PROP_STRING, PROP_NONE);
154         RNA_def_property_ui_text(prop, "Info", "Layer name");
155         RNA_def_struct_name_property(srna, prop);
156         
157         /* Frames */
158         prop= RNA_def_property(srna, "frames", PROP_COLLECTION, PROP_NONE);
159         RNA_def_property_collection_sdna(prop, NULL, "frames", NULL);
160         RNA_def_property_struct_type(prop, "GPencilFrame");
161         RNA_def_property_ui_text(prop, "Frames", "Sketches for this layer on different frames");
162         
163         /* Active Frame */
164         prop= RNA_def_property(srna, "active_frame", PROP_POINTER, PROP_NONE);
165         RNA_def_property_pointer_sdna(prop, NULL, "actframe");
166         RNA_def_property_ui_text(prop, "Active Frame", "Frame currently being displayed for this layer");
167         RNA_def_property_editable_func(prop, "rna_GPencilLayer_active_frame_editable");
168         
169         /* Drawing Color */
170         prop= RNA_def_property(srna, "color", PROP_FLOAT, PROP_COLOR);
171         RNA_def_property_array(prop, 3);
172         RNA_def_property_ui_text(prop, "Color", "Color for all strokes in this layer");
173         RNA_def_property_update(prop, NC_SCREEN|ND_GPENCIL, NULL);
174         
175         prop= RNA_def_property(srna, "alpha", PROP_FLOAT, PROP_NONE);
176         RNA_def_property_float_sdna(prop, NULL, "color[3]");
177         RNA_def_property_range(prop, 0.3, 1.0f);
178         RNA_def_property_ui_text(prop, "Opacity", "Layer Opacity");
179         RNA_def_property_update(prop, NC_SCREEN|ND_GPENCIL, NULL);
180         
181         /* Line Thickness */
182         prop= RNA_def_property(srna, "line_width", PROP_INT, PROP_NONE);
183         RNA_def_property_int_sdna(prop, NULL, "thickness");
184         RNA_def_property_range(prop, 1, 10);
185         RNA_def_property_ui_text(prop, "Thickness", "Thickness of strokes (in pixels)");
186         RNA_def_property_update(prop, NC_SCREEN|ND_GPENCIL, NULL);
187         
188         /* Onion-Skinning */
189         prop= RNA_def_property(srna, "use_onion_skinning", PROP_BOOLEAN, PROP_NONE);
190         RNA_def_property_boolean_sdna(prop, NULL, "flag", GP_LAYER_ONIONSKIN);
191         RNA_def_property_ui_text(prop, "Use Onion Skinning", "Ghost frames on either side of frame");
192         RNA_def_property_update(prop, NC_SCREEN|ND_GPENCIL, NULL);
193         
194         prop= RNA_def_property(srna, "ghost_range_max", PROP_INT, PROP_NONE);
195         RNA_def_property_int_sdna(prop, NULL, "gstep");
196         RNA_def_property_range(prop, 0, 120);
197         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)");
198         RNA_def_property_update(prop, NC_SCREEN|ND_GPENCIL, NULL);
199         
200         /* Flags */
201         prop= RNA_def_property(srna, "hide", PROP_BOOLEAN, PROP_NONE);
202         RNA_def_property_boolean_sdna(prop, NULL, "flag", GP_LAYER_HIDE);
203         RNA_def_property_ui_text(prop, "Hide", "Set layer Visibility");
204         RNA_def_property_update(prop, NC_SCREEN|ND_GPENCIL, NULL);
205         
206         prop= RNA_def_property(srna, "lock", PROP_BOOLEAN, PROP_NONE);
207         RNA_def_property_boolean_sdna(prop, NULL, "flag", GP_LAYER_LOCKED);
208         RNA_def_property_ui_text(prop, "Locked", "Protect layer from further editing and/or frame changes");
209         RNA_def_property_update(prop, NC_SCREEN|ND_GPENCIL, NULL);
210         
211         prop= RNA_def_property(srna, "lock_frame", PROP_BOOLEAN, PROP_NONE);
212         RNA_def_property_boolean_sdna(prop, NULL, "flag", GP_LAYER_FRAMELOCK);
213         RNA_def_property_ui_text(prop, "Frame Locked", "Lock current frame displayed by layer");
214         RNA_def_property_update(prop, NC_SCREEN|ND_GPENCIL, NULL);
215         
216         prop= RNA_def_property(srna, "active", PROP_BOOLEAN, PROP_NONE);
217         RNA_def_property_boolean_sdna(prop, NULL, "flag", GP_LAYER_ACTIVE);
218         RNA_def_property_boolean_funcs(prop, NULL, "rna_GPencilLayer_active_set");
219         RNA_def_property_ui_text(prop, "Active", "Set active layer for editing");
220         RNA_def_property_update(prop, NC_SCREEN|ND_GPENCIL, NULL);
221         
222         prop= RNA_def_property(srna, "select", PROP_BOOLEAN, PROP_NONE);
223         RNA_def_property_boolean_sdna(prop, NULL, "flag", GP_LAYER_SELECT);
224         RNA_def_property_ui_text(prop, "Select", "Layer is selected for editing in the DopeSheet");
225         RNA_def_property_update(prop, NC_SCREEN|ND_GPENCIL, NULL);
226         
227                 // XXX keep this option?
228         prop= RNA_def_property(srna, "show_points", PROP_BOOLEAN, PROP_NONE);
229         RNA_def_property_boolean_sdna(prop, NULL, "flag", GP_LAYER_DRAWDEBUG);
230         RNA_def_property_ui_text(prop, "Show Points", "Draw the points which make up the strokes (for debugging purposes)");
231         RNA_def_property_update(prop, NC_SCREEN|ND_GPENCIL, NULL);
232 }
233
234 static void rna_def_gpencil_data(BlenderRNA *brna)
235 {
236         StructRNA *srna;
237         PropertyRNA *prop;
238         
239         static EnumPropertyItem draw_mode_items[] = {
240                 {GP_DATA_VIEWALIGN, "CURSOR", 0, "Cursor", "Draw stroke at the 3D cursor"},
241                 {0, "VIEW", 0, "View", "Stick stroke to the view "}, /* weired, GP_DATA_VIEWALIGN is inverted */
242                 {GP_DATA_VIEWALIGN|GP_DATA_DEPTH_VIEW, "SURFACE", 0, "Surface", "Stick stroke to surfaces"},
243                 {GP_DATA_VIEWALIGN|GP_DATA_DEPTH_STROKE, "STROKE", 0, "Stroke", "Stick stroke to other strokes"},
244                 {0, NULL, 0, NULL, NULL}};
245
246         srna= RNA_def_struct(brna, "GreasePencil", "ID");
247         RNA_def_struct_sdna(srna, "bGPdata");
248         RNA_def_struct_ui_text(srna, "Grease Pencil", "Freehand annotation sketchbook");
249         RNA_def_struct_ui_icon(srna, ICON_GREASEPENCIL);
250         
251         /* Layers */
252         prop= RNA_def_property(srna, "layers", PROP_COLLECTION, PROP_NONE);
253         RNA_def_property_collection_sdna(prop, NULL, "layers", NULL);
254         RNA_def_property_struct_type(prop, "GPencilLayer");
255         RNA_def_property_ui_text(prop, "Layers", "");
256         
257         /* Flags */
258         prop= RNA_def_property(srna, "draw_mode", PROP_ENUM, PROP_NONE);
259         RNA_def_property_enum_bitflag_sdna(prop, NULL, "flag");
260         RNA_def_property_enum_items(prop, draw_mode_items);
261         RNA_def_property_ui_text(prop, "Draw Mode", "");
262
263         prop= RNA_def_property(srna, "use_stroke_endpoints", PROP_BOOLEAN, PROP_NONE);
264         RNA_def_property_boolean_sdna(prop, NULL, "flag", GP_DATA_DEPTH_STROKE_ENDPOINTS);
265         RNA_def_property_ui_text(prop, "Only Endpoints", "Only use the first and last parts of the stroke for snapping");
266
267
268 }
269
270 /* --- */
271
272 void RNA_def_gpencil(BlenderRNA *brna)
273 {
274         rna_def_gpencil_data(brna);
275         
276         rna_def_gpencil_layer(brna);
277         rna_def_gpencil_frame(brna);
278         rna_def_gpencil_stroke(brna);
279         rna_def_gpencil_stroke_point(brna);
280 }
281
282 #endif