4dc86d028f87b20524e81275f8c1f07ed9c4c022
[blender.git] / source / blender / makesdna / DNA_gpencil_types.h
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  * The Original Code is Copyright (C) 2008, Blender Foundation.
19  * This is a new part of Blender
20  *
21  * Contributor(s): Joshua Leung
22  *
23  * ***** END GPL LICENSE BLOCK *****
24  */
25
26 /** \file DNA_gpencil_types.h
27  *  \ingroup DNA
28  */
29
30 #ifndef __DNA_GPENCIL_TYPES_H__
31 #define __DNA_GPENCIL_TYPES_H__
32
33 #include "DNA_listBase.h"
34 #include "DNA_ID.h"
35
36 /* Grease-Pencil Annotations - 'Stroke Point'
37  *      -> Coordinates may either be 2d or 3d depending on settings at the time
38  *      -> Coordinates of point on stroke, in proportions of window size
39  *         This assumes that the bottom-left corner is (0,0)
40  */
41 typedef struct bGPDspoint {
42         float x, y, z;                  /* co-ordinates of point (usually 2d, but can be 3d as well) */
43         float pressure;                 /* pressure of input device (from 0 to 1) at this point */
44         float time;                             /* seconds since start of stroke */
45 } bGPDspoint;
46
47 /* Grease-Pencil Annotations - 'Stroke'
48  *      -> A stroke represents a (simplified version) of the curve
49  *         drawn by the user in one 'mousedown'->'mouseup' operation
50  */
51 typedef struct bGPDstroke {
52         struct bGPDstroke *next, *prev;
53         
54         bGPDspoint *points;             /* array of data-points for stroke */
55         int totpoints;                  /* number of data-points in array */
56         
57         short thickness;                /* thickness of stroke (currently not used) */
58         short flag;                             /* various settings about this stroke */
59         
60         float pad;
61         double inittime;                /* Init time of stroke */
62         float pad2;
63 } bGPDstroke;
64
65 /* bGPDstroke->flag */
66         /* stroke is in 3d-space */
67 #define GP_STROKE_3DSPACE               (1<<0)
68         /* stroke is in 2d-space */
69 #define GP_STROKE_2DSPACE               (1<<1)
70         /* stroke is in 2d-space (but with special 'image' scaling) */
71 #define GP_STROKE_2DIMAGE               (1<<2)
72         /* only for use with stroke-buffer (while drawing eraser) */
73 #define GP_STROKE_ERASER                (1<<15)
74
75
76 /* Grease-Pencil Annotations - 'Frame'
77  *      -> Acts as storage for the 'image' formed by strokes
78  */
79 typedef struct bGPDframe {
80         struct bGPDframe *next, *prev;
81         
82         ListBase strokes;       /* list of the simplified 'strokes' that make up the frame's data */
83         
84         int framenum;           /* frame number of this frame */
85         int flag;                       /* temp settings */
86 } bGPDframe;
87
88 /* bGPDframe->flag */   
89         /* frame is being painted on */
90 #define GP_FRAME_PAINT          (1<<0)
91         /* for editing in Action Editor */
92 #define GP_FRAME_SELECT         (1<<1)
93
94
95 /* Grease-Pencil Annotations - 'Layer' */
96 typedef struct bGPDlayer {
97         struct bGPDlayer *next, *prev;
98         
99         ListBase frames;                /* list of annotations to display for frames (bGPDframe list) */
100         bGPDframe *actframe;    /* active frame (should be the frame that is currently being displayed) */
101         
102         int flag;                               /* settings for layer */
103         short thickness;                /* current thickness to apply to strokes */
104         short gstep;                    /* max number of frames between active and ghost to show (0=only those on either side) */
105         
106         float color[4];                 /* color that should be used to draw all the strokes in this layer */
107         
108         char info[128];                 /* optional reference info about this layer (i.e. "director's comments, 12/3")
109                                                          * this is used for the name of the layer  too and kept unique. */
110 } bGPDlayer;
111
112 /* bGPDlayer->flag */
113         /* don't display layer */
114 #define GP_LAYER_HIDE           (1<<0)
115         /* protected from further editing */
116 #define GP_LAYER_LOCKED         (1<<1)  
117         /* layer is 'active' layer being edited */
118 #define GP_LAYER_ACTIVE         (1<<2)
119         /* draw points of stroke for debugging purposes */
120 #define GP_LAYER_DRAWDEBUG      (1<<3)
121         /* do onionskinning */
122 #define GP_LAYER_ONIONSKIN      (1<<4)
123         /* for editing in Action Editor */
124 #define GP_LAYER_SELECT         (1<<5)
125         /* current frame for layer can't be changed */
126 #define GP_LAYER_FRAMELOCK      (1<<6)
127         /* don't render xray (which is default) */
128 #define GP_LAYER_NO_XRAY        (1<<7)
129
130
131 /* Grease-Pencil Annotations - 'DataBlock' */
132 typedef struct bGPdata {
133         ID id;                                  /* Grease Pencil data is */
134         
135         /* saved Grease-Pencil data */
136         ListBase layers;                /* bGPDlayers */
137         int flag;                               /* settings for this datablock */
138         
139         /* not-saved stroke buffer data (only used during paint-session) 
140          *      - buffer must be initialized before use, but freed after 
141          *        whole paint operation is over
142          */
143         short sbuffer_size;                     /* number of elements currently in cache */
144         short sbuffer_sflag;            /* flags for stroke that cache represents */
145         void *sbuffer;                          /* stroke buffer (can hold GP_STROKE_BUFFER_MAX) */
146 } bGPdata;
147
148 /* bGPdata->flag */
149 // XXX many of these flags should be deprecated for more general ideas in 2.5
150         /* don't allow painting to occur at all */
151         // XXX is deprecated - not well understood
152 #define GP_DATA_LMBPLOCK        (1<<0)
153         /* show debugging info in viewport (i.e. status print) */
154 #define GP_DATA_DISPINFO        (1<<1)
155         /* in Action Editor, show as expanded channel */
156 #define GP_DATA_EXPAND          (1<<2)
157         /* is the block overriding all clicks? */
158         // XXX is deprecated - nasty old concept
159 #define GP_DATA_EDITPAINT       (1<<3)
160         /* new strokes are added in viewport space */
161 #define GP_DATA_VIEWALIGN       (1<<4)
162         /* Project into the screens Z values */
163 #define GP_DATA_DEPTH_VIEW      (1<<5)
164 #define GP_DATA_DEPTH_STROKE (1<<6)
165
166 #define GP_DATA_DEPTH_STROKE_ENDPOINTS (1<<7)
167
168 #endif /*  __DNA_GPENCIL_TYPES_H__ */