b6b07c6001fc4a632be75e413b420f8235df6275
[blender.git] / source / blender / editors / gpencil / gpencil_intern.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) 2009 Blender Foundation.
19  * All rights reserved.
20  *
21  * 
22  * Contributor(s): Blender Foundation
23  *
24  * ***** END GPL LICENSE BLOCK *****
25  */
26
27 /** \file blender/editors/gpencil/gpencil_intern.h
28  *  \ingroup edgpencil
29  */
30
31 #ifndef __GPENCIL_INTERN_H__
32 #define __GPENCIL_INTERN_H__
33
34
35 #include "DNA_vec_types.h"
36
37
38 /* internal exports only */
39 struct bGPdata;
40 struct bGPDstroke;
41 struct bGPDspoint;
42
43 struct ARegion;
44 struct View2D;
45 struct wmOperatorType;
46
47
48 /* ***************************************************** */
49 /* Internal API */
50
51 /* Stroke Coordinates API ------------------------------ */
52 /* gpencil_utils.c */
53
54 typedef struct GP_SpaceConversion {
55         struct bGPdata *gpd;
56         struct bGPDlayer *gpl;
57         
58         struct ScrArea *sa;
59         struct ARegion *ar;
60         struct View2D *v2d;
61         
62         rctf *subrect;       /* for using the camera rect within the 3d view */
63         rctf subrect_data;
64         
65         float mat[4][4];     /* transform matrix on the strokes (introduced in [b770964]) */
66 } GP_SpaceConversion;
67
68
69 /** 
70  * Check whether a given stroke segment is inside a circular brush 
71  *
72  * \param mval     The current screen-space coordinates (midpoint) of the brush
73  * \param mvalo    The previous screen-space coordinates (midpoint) of the brush (NOT CURRENTLY USED)
74  * \param rad      The radius of the brush
75  *
76  * \param x0, y0   The screen-space x and y coordinates of the start of the stroke segment
77  * \param x1, y1   The screen-space x and y coordinates of the end of the stroke segment
78  */
79 bool gp_stroke_inside_circle(const int mval[2], const int UNUSED(mvalo[2]),
80                              int rad, int x0, int y0, int x1, int y1);
81
82
83 /**
84  * Init settings for stroke point space conversions 
85  *
86  * \param[out] r_gsc  The space conversion settings struct, populated with necessary params
87  */
88 void gp_point_conversion_init(struct bContext *C, GP_SpaceConversion *r_gsc);
89
90 /**
91  * Convert a Grease Pencil coordinate (i.e. can be 2D or 3D) to screenspace (2D)
92  *
93  * \param[out] r_x  The screen-space x-coordinate of the point
94  * \param[out] r_y  The screen-space y-coordinate of the point
95  */
96 void gp_point_to_xy(GP_SpaceConversion *settings, struct bGPDstroke *gps, struct bGPDspoint *pt,
97                     int *r_x, int *r_y);
98
99 /* ***************************************************** */
100 /* Operator Defines */
101
102 /* drawing ---------- */
103
104 void GPENCIL_OT_draw(struct wmOperatorType *ot);
105
106 /* Paint Modes for operator*/
107 typedef enum eGPencil_PaintModes {
108         GP_PAINTMODE_DRAW = 0,
109         GP_PAINTMODE_ERASER,
110         GP_PAINTMODE_DRAW_STRAIGHT,
111         GP_PAINTMODE_DRAW_POLY
112 } eGPencil_PaintModes;
113
114 /* stroke editing ----- */
115
116 void GPENCIL_OT_select(struct wmOperatorType *ot);
117 void GPENCIL_OT_select_all(struct wmOperatorType *ot);
118 void GPENCIL_OT_select_circle(struct wmOperatorType *ot);
119 void GPENCIL_OT_select_border(struct wmOperatorType *ot);
120
121 void GPENCIL_OT_select_linked(struct wmOperatorType *ot);
122 void GPENCIL_OT_select_more(struct wmOperatorType *ot);
123 void GPENCIL_OT_select_less(struct wmOperatorType *ot);
124
125 void GPENCIL_OT_duplicate(struct wmOperatorType *ot);
126 void GPENCIL_OT_delete(struct wmOperatorType *ot);
127
128 /* buttons editing --- */
129
130 void GPENCIL_OT_data_add(struct wmOperatorType *ot);
131 void GPENCIL_OT_data_unlink(struct wmOperatorType *ot);
132
133 void GPENCIL_OT_layer_add(struct wmOperatorType *ot);
134 void GPENCIL_OT_layer_remove(struct wmOperatorType *ot);
135 void GPENCIL_OT_layer_move(struct wmOperatorType *ot);
136
137 void GPENCIL_OT_active_frame_delete(struct wmOperatorType *ot);
138
139 void GPENCIL_OT_convert(struct wmOperatorType *ot);
140
141 /* undo stack ---------- */
142
143 void gpencil_undo_init(struct bGPdata *gpd);
144 void gpencil_undo_push(struct bGPdata *gpd);
145 void gpencil_undo_finish(void);
146
147 /******************************************************* */
148 /* FILTERED ACTION DATA - TYPES  ---> XXX DEPRECEATED OLD ANIM SYSTEM CODE! */
149
150 /* XXX - TODO: replace this with the modern bAnimListElem... */
151 /* This struct defines a structure used for quick access */
152 typedef struct bActListElem {
153         struct bActListElem *next, *prev;
154         
155         void *data;   /* source data this elem represents */
156         int   type;   /* one of the ACTTYPE_* values */
157         int   flag;   /* copy of elem's flags for quick access */
158         int   index;  /* copy of adrcode where applicable */
159         
160         void  *key_data;  /* motion data - ipo or ipo-curve */
161         short  datatype;  /* type of motion data to expect */
162         
163         struct bActionGroup *grp;   /* action group that owns the channel */
164         
165         void  *owner;      /* will either be an action channel or fake ipo-channel (for keys) */
166         short  ownertype;  /* type of owner */
167 } bActListElem;
168
169 /******************************************************* */
170 /* FILTER ACTION DATA - METHODS/TYPES */
171
172 /* filtering flags  - under what circumstances should a channel be added */
173 typedef enum ACTFILTER_FLAGS {
174         ACTFILTER_VISIBLE       = (1 << 0),   /* should channels be visible */
175         ACTFILTER_SEL           = (1 << 1),   /* should channels be selected */
176         ACTFILTER_FOREDIT       = (1 << 2),   /* does editable status matter */
177         ACTFILTER_CHANNELS      = (1 << 3),   /* do we only care that it is a channel */
178         ACTFILTER_IPOKEYS       = (1 << 4),   /* only channels referencing ipo's */
179         ACTFILTER_ONLYICU       = (1 << 5),   /* only reference ipo-curves */
180         ACTFILTER_FORDRAWING    = (1 << 6),   /* make list for interface drawing */
181         ACTFILTER_ACTGROUPED    = (1 << 7)    /* belongs to the active group */
182 } ACTFILTER_FLAGS;
183
184 /* Action Editor - Main Data types */
185 typedef enum ACTCONT_TYPES {
186         ACTCONT_NONE = 0,
187         ACTCONT_ACTION,
188         ACTCONT_SHAPEKEY,
189         ACTCONT_GPENCIL
190 } ACTCONT_TYPES;
191
192
193
194
195 #endif /* __GPENCIL_INTERN_H__ */
196