Merging changes from trunk r58091-58323.
[blender.git] / source / blender / editors / sculpt_paint / sculpt_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) 2006 by Nicholas Bishop
19  * All rights reserved.
20  *
21  * The Original Code is: all of this file.
22  *
23  * Contributor(s): none yet.
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  */
27
28 /** \file blender/editors/sculpt_paint/sculpt_intern.h
29  *  \ingroup edsculpt
30  */
31  
32
33 #ifndef __SCULPT_INTERN_H__
34 #define __SCULPT_INTERN_H__
35
36 #include "DNA_listBase.h"
37 #include "DNA_vec_types.h"
38 #include "DNA_key_types.h"
39
40 #include "BLI_bitmap.h"
41 #include "BKE_pbvh.h"
42
43 struct bContext;
44 struct Brush;
45 struct KeyBlock;
46 struct Mesh;
47 struct MultiresModifierData;
48 struct Object;
49 struct Scene;
50 struct Sculpt;
51 struct SculptStroke;
52 struct SculptUndoNode;
53
54 /* Interface */
55 struct MultiresModifierData *sculpt_multires_active(struct Scene *scene, struct Object *ob);
56
57 int sculpt_mode_poll(struct bContext *C);
58 int sculpt_mode_poll_view3d(struct bContext *C);
59 /* checks for a brush, not just sculpt mode */
60 int sculpt_poll(struct bContext *C);
61 int sculpt_poll_view3d(struct bContext *C);
62 void sculpt_update_mesh_elements(struct Scene *scene, struct Sculpt *sd, struct Object *ob,
63                                  int need_pmap, int need_mask);
64
65 /* Stroke */
66 int sculpt_stroke_get_location(bContext *C, float out[3], const float mouse[2]);
67
68 /* Dynamic topology */
69 void sculpt_pbvh_clear(Object *ob);
70 void sculpt_update_after_dynamic_topology_toggle(bContext *C);
71 void sculpt_dynamic_topology_enable(struct bContext *C);
72 void sculpt_dynamic_topology_disable(struct bContext *C,
73                                      struct SculptUndoNode *unode);
74
75 /* Undo */
76
77 typedef enum {
78         SCULPT_UNDO_COORDS,
79         SCULPT_UNDO_HIDDEN,
80         SCULPT_UNDO_MASK,
81         SCULPT_UNDO_DYNTOPO_BEGIN,
82         SCULPT_UNDO_DYNTOPO_END,
83         SCULPT_UNDO_DYNTOPO_SYMMETRIZE,
84 } SculptUndoType;
85
86 typedef struct SculptUndoNode {
87         struct SculptUndoNode *next, *prev;
88
89         SculptUndoType type;
90
91         char idname[MAX_ID_NAME];   /* name instead of pointer*/
92         void *node;                 /* only during push, not valid afterwards! */
93
94         float (*co)[3];
95         float (*orig_co)[3];
96         short (*no)[3];
97         float *mask;
98         int totvert;
99
100         /* non-multires */
101         int maxvert;                /* to verify if totvert it still the same */
102         int *index;                 /* to restore into right location */
103         BLI_bitmap vert_hidden;
104
105         /* multires */
106         int maxgrid;                /* same for grid */
107         int gridsize;               /* same for grid */
108         int totgrid;                /* to restore into right location */
109         int *grids;                 /* to restore into right location */
110         BLI_bitmap *grid_hidden;
111
112         /* bmesh */
113         struct BMLogEntry *bm_entry;
114         int applied;
115         CustomData bm_enter_vdata;
116         CustomData bm_enter_edata;
117         CustomData bm_enter_ldata;
118         CustomData bm_enter_pdata;
119         int bm_enter_totvert;
120         int bm_enter_totedge;
121         int bm_enter_totloop;
122         int bm_enter_totpoly;
123
124         /* shape keys */
125         char shapeName[sizeof(((KeyBlock *)0))->name];
126 } SculptUndoNode;
127
128 SculptUndoNode *sculpt_undo_push_node(Object *ob, PBVHNode *node, SculptUndoType type);
129 SculptUndoNode *sculpt_undo_get_node(PBVHNode *node);
130 void sculpt_undo_push_begin(const char *name);
131 void sculpt_undo_push_end(void);
132
133 void sculpt_vertcos_to_key(Object *ob, KeyBlock *kb, float (*vertCos)[3]);
134
135 #endif