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