doxygen: add newline after \file
[blender.git] / source / blender / bmesh / intern / bmesh_private.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  * The Original Code is Copyright (C) 2004 Blender Foundation.
17  * All rights reserved.
18  */
19
20 #ifndef __BMESH_PRIVATE_H__
21 #define __BMESH_PRIVATE_H__
22
23 /** \file
24  * \ingroup bmesh
25  *
26  * Private function prototypes for bmesh public API.
27  * This file is a grab-bag of functions from various
28  * parts of the bmesh internals.
29  */
30
31 /* returns positive nonzero on error */
32
33 #ifdef NDEBUG
34    /* no error checking for release,
35     * it can take most of the CPU time when running some tools */
36 #  define BM_CHECK_ELEMENT(el)  (void)(el)
37 #else
38 int bmesh_elem_check(void *element, const char htype);
39 #  define BM_CHECK_ELEMENT(el) {                                              \
40         if (bmesh_elem_check(el, ((BMHeader *)el)->htype)) {                      \
41             printf("check_element failure, with code %i on line %i in file\n"     \
42             "    \"%s\"\n\n",                                                     \
43             bmesh_elem_check(el, ((BMHeader *)el)->htype),                        \
44             __LINE__, __FILE__);                                                  \
45         } \
46 } ((void)0)
47 #endif
48
49 int bmesh_radial_length(const BMLoop *l);
50 int bmesh_disk_count_at_most(const BMVert *v, const int count_max);
51 int bmesh_disk_count(const BMVert *v);
52
53 /**
54  * Internal BMHeader.api_flag
55  * \note Ensure different parts of the API do not conflict
56  * on using these internal flags!*/
57 enum {
58         _FLAG_JF       = (1 << 0),  /* join faces */
59         _FLAG_MF       = (1 << 1),  /* make face */
60         _FLAG_MV       = (1 << 1),  /* make face, vertex */
61         _FLAG_OVERLAP  = (1 << 2),  /* general overlap flag  */
62         _FLAG_WALK     = (1 << 3),  /* general walk flag (keep clean) */
63         _FLAG_WALK_ALT = (1 << 4),  /* same as _FLAG_WALK, for when a second tag is needed */
64
65         _FLAG_ELEM_CHECK = (1 << 7),  /* reserved for bmesh_elem_check */
66 };
67
68 #define BM_ELEM_API_FLAG_ENABLE(element, f)  { ((element)->head.api_flag |=  (f)); } (void)0
69 #define BM_ELEM_API_FLAG_DISABLE(element, f) { ((element)->head.api_flag &= (uchar)~(f)); } (void)0
70 #define BM_ELEM_API_FLAG_TEST(element, f)      ((element)->head.api_flag &   (f))
71 #define BM_ELEM_API_FLAG_CLEAR(element)      { ((element)->head.api_flag = 0); } (void)0
72
73 void poly_rotate_plane(const float normal[3], float (*verts)[3], unsigned const int nverts);
74
75 /* include the rest of our private declarations */
76 #include "bmesh_structure.h"
77
78 #endif /* __BMESH_PRIVATE_H__ */