3fb047ebbe7e3a3b77b35dadfd81475de608557a
[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 struct AnimData;
37
38
39 /* Grease-Pencil Annotations - 'Stroke Point'
40  *      -> Coordinates may either be 2d or 3d depending on settings at the time
41  *      -> Coordinates of point on stroke, in proportions of window size
42  *         This assumes that the bottom-left corner is (0,0)
43  */
44 typedef struct bGPDspoint {
45         float x, y, z;                  /* co-ordinates of point (usually 2d, but can be 3d as well) */
46         float pressure;                 /* pressure of input device (from 0 to 1) at this point */
47         float time;                             /* seconds since start of stroke */
48         int flag;                               /* additional options (NOTE: can shrink this field down later if needed) */
49 } bGPDspoint;
50
51 /* bGPDspoint->flag */
52 typedef enum eGPDspoint_Flag {
53         /* stroke point is selected (for editing) */
54         GP_SPOINT_SELECT        = (1 << 0)
55 } eGPSPoint_Flag;
56
57 /* Grease-Pencil Annotations - 'Stroke'
58  *      -> A stroke represents a (simplified version) of the curve
59  *         drawn by the user in one 'mousedown'->'mouseup' operation
60  */
61 typedef struct bGPDstroke {
62         struct bGPDstroke *next, *prev;
63         bGPDspoint *points;             /* array of data-points for stroke */
64         void *pad;                              /* keep 4 pointers at the beginning, padding for 'inittime' is tricky 64/32bit */
65         int totpoints;                  /* number of data-points in array */
66         
67         short thickness;                /* thickness of stroke (currently not used) */
68         short flag;                             /* various settings about this stroke */
69
70         double inittime;                /* Init time of stroke */
71 } bGPDstroke;
72
73 /* bGPDstroke->flag */
74 typedef enum eGPDstroke_Flag {
75         /* stroke is in 3d-space */
76         GP_STROKE_3DSPACE               = (1 << 0),
77         /* stroke is in 2d-space */
78         GP_STROKE_2DSPACE               = (1 << 1),
79         /* stroke is in 2d-space (but with special 'image' scaling) */
80         GP_STROKE_2DIMAGE               = (1 << 2),
81         /* stroke is selected */
82         GP_STROKE_SELECT                = (1 << 3),
83         /* only for use with stroke-buffer (while drawing eraser) */
84         GP_STROKE_ERASER                = (1 << 15)
85 } eGPDstroke_Flag;
86
87 /* Grease-Pencil Annotations - 'Frame'
88  *      -> Acts as storage for the 'image' formed by strokes
89  */
90 typedef struct bGPDframe {
91         struct bGPDframe *next, *prev;
92         
93         ListBase strokes;       /* list of the simplified 'strokes' that make up the frame's data */
94         
95         int framenum;           /* frame number of this frame */
96         
97         short flag;                     /* temp settings */
98         short key_type;         /* keyframe type (eBezTriple_KeyframeType) */
99 } bGPDframe;
100
101 /* bGPDframe->flag */
102 typedef enum eGPDframe_Flag {
103         /* frame is being painted on */
104         GP_FRAME_PAINT          = (1 << 0),
105         /* for editing in Action Editor */
106         GP_FRAME_SELECT         = (1 << 1)
107 } eGPDframe_Flag;
108
109 /* Grease-Pencil Annotations - 'Layer' */
110 typedef struct bGPDlayer {
111         struct bGPDlayer *next, *prev;
112         
113         ListBase frames;                /* list of annotations to display for frames (bGPDframe list) */
114         bGPDframe *actframe;    /* active frame (should be the frame that is currently being displayed) */
115         
116         short flag;                             /* settings for layer */
117         short thickness;                /* current thickness to apply to strokes */
118         
119         short gstep;                    /* Ghosts Before: max number of ghost frames to show between active frame and the one before it (0 = only the ghost itself) */
120         short gstep_next;               /* Ghosts After:  max number of ghost frames to show after active frame and the following it    (0 = only the ghost itself) */
121         
122         float gcolor_prev[3];   /* optional color for ghosts before the active frame */
123         float gcolor_next[3];   /* optional color for ghosts after the active frame */
124         
125         float color[4];                 /* color that should be used to draw all the strokes in this layer */
126         float fill[4];                  /* color that should be used for drawing "fills" for strokes */
127         
128         char info[128];                 /* optional reference info about this layer (i.e. "director's comments, 12/3")
129                                                          * this is used for the name of the layer  too and kept unique. */
130 } bGPDlayer;
131
132 /* bGPDlayer->flag */
133 typedef enum eGPDlayer_Flag {
134         /* don't display layer */
135         GP_LAYER_HIDE                   = (1 << 0),
136         /* protected from further editing */
137         GP_LAYER_LOCKED                 = (1 << 1),
138         /* layer is 'active' layer being edited */
139         GP_LAYER_ACTIVE                 = (1 << 2),
140         /* draw points of stroke for debugging purposes */
141         GP_LAYER_DRAWDEBUG              = (1 << 3),
142         /* do onion skinning */
143         GP_LAYER_ONIONSKIN              = (1 << 4),
144         /* for editing in Action Editor */
145         GP_LAYER_SELECT                 = (1 << 5),
146         /* current frame for layer can't be changed */
147         GP_LAYER_FRAMELOCK              = (1 << 6),
148         /* don't render xray (which is default) */
149         GP_LAYER_NO_XRAY                = (1 << 7),
150         /* use custom color for ghosts before current frame */
151         GP_LAYER_GHOST_PREVCOL  = (1 << 8),
152         /* use custom color for ghosts after current frame */
153         GP_LAYER_GHOST_NEXTCOL  = (1 << 9),
154         /* "volumetric" strokes (i.e. GLU Quadric discs in 3D) */
155         GP_LAYER_VOLUMETRIC             = (1 << 10),
156 } eGPDlayer_Flag;
157
158 /* Grease-Pencil Annotations - 'DataBlock' */
159 typedef struct bGPdata {
160         ID id;                                  /* Grease Pencil data is a datablock */
161         struct AnimData *adt;   /* animation data - for animating draw settings */
162         
163         /* saved Grease-Pencil data */
164         ListBase layers;                /* bGPDlayers */
165         int flag;                               /* settings for this datablock */
166         
167         /* not-saved stroke buffer data (only used during paint-session) 
168          *      - buffer must be initialized before use, but freed after 
169          *        whole paint operation is over
170          */
171         short sbuffer_size;                     /* number of elements currently in cache */
172         short sbuffer_sflag;            /* flags for stroke that cache represents */
173         void *sbuffer;                          /* stroke buffer (can hold GP_STROKE_BUFFER_MAX) */
174 } bGPdata;
175
176 /* bGPdata->flag */
177 /* NOTE: A few flags have been deprecated since early 2.5,
178  *       since they have been made redundant by interaction
179  *       changes made during the porting process.
180  */
181 typedef enum eGPdata_Flag {
182         /* don't allow painting to occur at all */
183         /* GP_DATA_LMBPLOCK  = (1 << 0), */
184         
185         /* show debugging info in viewport (i.e. status print) */
186         GP_DATA_DISPINFO        = (1 << 1),
187         /* in Action Editor, show as expanded channel */
188         GP_DATA_EXPAND          = (1 << 2),
189         
190         /* is the block overriding all clicks? */
191         /* GP_DATA_EDITPAINT = (1 << 3), */
192         
193         /* new strokes are added in viewport space */
194         GP_DATA_VIEWALIGN       = (1 << 4),
195         
196         /* Project into the screen's Z values */
197         GP_DATA_DEPTH_VIEW      = (1 << 5),
198         GP_DATA_DEPTH_STROKE = (1 << 6),
199
200         GP_DATA_DEPTH_STROKE_ENDPOINTS = (1 << 7),
201         
202         /* Stroke Editing Mode - Toggle to enable alternative keymap for easier editing of stroke points */
203         GP_DATA_STROKE_EDITMODE = (1 << 8)
204 } eGPdata_Flag;
205
206 #endif /*  __DNA_GPENCIL_TYPES_H__ */