doxygen: add newline after \file
[blender.git] / source / blender / bmesh / intern / bmesh_log.h
1 /*
2  * This program is free software; you can redistribute it and/or
3  * modify it under the terms of the GNU General Public License
4  * as published by the Free Software Foundation; either version 2
5  * of the License, or (at your option) any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software Foundation,
14  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
15  */
16
17 #ifndef __BMESH_LOG_H__
18 #define __BMESH_LOG_H__
19
20 /** \file
21  * \ingroup bmesh
22  */
23
24 struct BMFace;
25 struct BMVert;
26 struct BMesh;
27 struct RangeTreeUInt;
28
29 typedef struct BMLog BMLog;
30 typedef struct BMLogEntry BMLogEntry;
31
32 /* Allocate and initialize a new BMLog */
33 BMLog *BM_log_create(BMesh *bm);
34
35 /* Allocate and initialize a new BMLog using existing BMLogEntries */
36 BMLog *BM_log_from_existing_entries_create(BMesh *bm, BMLogEntry *entry);
37
38 /* Free all the data in a BMLog including the log itself */
39 void BM_log_free(BMLog *log);
40
41 /* Get the number of log entries */
42 int BM_log_length(const BMLog *log);
43
44 /* Apply a consistent ordering to BMesh vertices and faces */
45 void BM_log_mesh_elems_reorder(BMesh *bm, BMLog *log);
46
47 /* Start a new log entry and update the log entry list */
48 BMLogEntry *BM_log_entry_add(BMLog *log);
49
50 /* Mark all used ids as unused for this node */
51 void BM_log_cleanup_entry(BMLogEntry *entry);
52
53 /* Remove an entry from the log */
54 void BM_log_entry_drop(BMLogEntry *entry);
55
56 /* Undo one BMLogEntry */
57 void BM_log_undo(BMesh *bm, BMLog *log);
58
59 /* Redo one BMLogEntry */
60 void BM_log_redo(BMesh *bm, BMLog *log);
61
62 /* Log a vertex before it is modified */
63 void BM_log_vert_before_modified(BMLog *log, struct BMVert *v, const int cd_vert_mask_offset);
64
65 /* Log a new vertex as added to the BMesh */
66 void BM_log_vert_added(BMLog *log, struct BMVert *v, const int cd_vert_mask_offset);
67
68 /* Log a face before it is modified */
69 void BM_log_face_modified(BMLog *log, struct BMFace *f);
70
71 /* Log a new face as added to the BMesh */
72 void BM_log_face_added(BMLog *log, struct BMFace *f);
73
74 /* Log a vertex as removed from the BMesh */
75 void BM_log_vert_removed(BMLog *log, struct BMVert *v, const int cd_vert_mask_offset);
76
77 /* Log a face as removed from the BMesh */
78 void BM_log_face_removed(BMLog *log, struct BMFace *f);
79
80 /* Log all vertices/faces in the BMesh as added */
81 void BM_log_all_added(BMesh *bm, BMLog *log);
82
83 /* Log all vertices/faces in the BMesh as removed */
84 void BM_log_before_all_removed(BMesh *bm, BMLog *log);
85
86 /* Get the logged coordinates of a vertex */
87 const float *BM_log_original_vert_co(BMLog *log, BMVert *v);
88
89 /* Get the logged normal of a vertex */
90 const short *BM_log_original_vert_no(BMLog *log, BMVert *v);
91
92 /* Get the logged mask of a vertex */
93 float BM_log_original_mask(BMLog *log, BMVert *v);
94
95 /* Get the logged data of a vertex (avoid multiple lookups) */
96 void BM_log_original_vert_data(
97         BMLog *log, BMVert *v,
98         const float **r_co, const short **r_no);
99
100 /* For internal use only (unit testing) */
101 BMLogEntry *BM_log_current_entry(BMLog *log);
102 struct RangeTreeUInt *BM_log_unused_ids(BMLog *log);
103
104 #endif