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