Add BMLog for efficiently storing changes to vertices and faces
[blender.git] / source / blender / bmesh / intern / bmesh_log.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  * ***** END GPL LICENSE BLOCK *****
19  */
20
21 #ifndef __BMESH_LOG_H__
22 #define __BMESH_LOG_H__
23
24 /* The BMLog is an interface for storing undo/redo steps as a BMesh is
25  * modified. It only stores changes to the BMesh, not full copies.
26  *
27  * Currently it supports the following types of changes:
28  * 
29  * - Adding and removing vertices
30  * - Adding and removing faces
31  * - Moving vertices
32  * - Setting vertex paint-mask values
33  * - Setting vertex hflags
34  */
35
36 struct BMFace;
37 struct BMVert;
38 struct BMesh;
39 struct RangeTreeUInt;
40
41 typedef struct BMLog BMLog;
42 typedef struct BMLogEntry BMLogEntry;
43
44 /* Allocate and initialize a new BMLog */
45 BMLog *BM_log_create(BMesh *bm);
46
47 /* Allocate and initialize a new BMLog using existing BMLogEntries */
48 BMLog *BM_log_from_existing_entries_create(BMesh *bm, BMLogEntry *entry);
49
50 /* Free all the data in a BMLog including the log itself */
51 void BM_log_free(BMLog *log);
52
53 /* Get the number of log entries */
54 int BM_log_length(const BMLog *log);
55
56 /* Apply a consistent ordering to BMesh vertices and faces */
57 void BM_log_mesh_elems_reorder(BMesh *bm, BMLog *log);
58
59 /* Start a new log entry and update the log entry list */
60 BMLogEntry *BM_log_entry_add(BMLog *log);
61
62 /* Remove an entry from the log */
63 void BM_log_entry_drop(BMLogEntry *entry);
64
65 /* Undo one BMLogEntry */
66 void BM_log_undo(BMesh *bm, BMLog *log);
67
68 /* Redo one BMLogEntry */
69 void BM_log_redo(BMesh *bm, BMLog *log);
70
71 /* Log a vertex before it is modified */
72 void BM_log_vert_before_modified(BMesh *bm, BMLog *log, struct BMVert *v);
73
74 /* Log a new vertex as added to the BMesh */
75 void BM_log_vert_added(BMesh *bm, BMLog *log, struct BMVert *v);
76
77 /* Log a new face as added to the BMesh */
78 void BM_log_face_added(BMLog *log, struct BMFace *f);
79
80 /* Log a vertex as removed from the BMesh */
81 void BM_log_vert_removed(BMesh *bm, BMLog *log, struct BMVert *v);
82
83 /* Log a face as removed from the BMesh */
84 void BM_log_face_removed(BMLog *log, struct BMFace *f);
85
86 /* Log all vertices/faces in the BMesh as added */
87 void BM_log_all_added(BMesh *bm, BMLog *log);
88
89 /* Log all vertices/faces in the BMesh as removed */
90 void BM_log_before_all_removed(BMesh *bm, BMLog *log);
91
92 /* Get the logged coordinates of a vertex */
93 const float *BM_log_original_vert_co(BMLog *log, BMVert *v);
94
95 /* Get the logged mask of a vertex */
96 float BM_log_original_mask(BMLog *log, BMVert *v);
97
98 /* For internal use only (unit testing) */
99 BMLogEntry *BM_log_current_entry(BMLog *log);
100 struct RangeTreeUInt *BM_log_unused_ids(BMLog *log);
101
102 #endif