code cleanup: header cleanup and remove some duplicate defines.
[blender.git] / source / blender / blenlib / BLI_scanfill.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) 2001-2002 by NaN Holding BV.
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 #ifndef __BLI_SCANFILL_H__
29 #define __BLI_SCANFILL_H__
30
31 /** \file BLI_scanfill.h
32  *  \ingroup bli
33  *  \since March 2001
34  *  \author nzc
35  *  \brief Filling meshes.
36  */
37
38 struct ScanFillVert;
39
40 #ifdef __cplusplus
41 extern "C" {
42 #endif
43
44 typedef struct ScanFillContext {
45         ListBase fillvertbase;
46         ListBase filledgebase;
47         ListBase fillfacebase;
48
49         /* simple optimization for allocating thousands of small memory blocks
50          * only to be used within loops, and not by one function at a time
51          * free in the end, with argument '-1'
52          */
53 #define MEM_ELEM_BLOCKSIZE 16384
54         struct mem_elements *melem__cur;
55         int melem__offs;                   /* the current free address */
56         ListBase melem__lb;
57
58         /* private */
59         struct ScanFillVertLink *_scdata;
60 } ScanFillContext;
61
62 /* note; changing this also might affect the undo copy in editmesh.c */
63 typedef struct ScanFillVert {
64         struct ScanFillVert *next, *prev;
65         union {
66                 struct ScanFillVert *v;
67                 void                *p;
68                 intptr_t l;
69         } tmp;
70         float co[3]; /* vertex location */
71         float xy[2]; /* 2D copy of vertex location (using dominant axis) */
72         int keyindex; /* original index #, for restoring  key information */
73         short poly_nr;
74         unsigned char f, h;
75 } ScanFillVert;
76
77 typedef struct ScanFillEdge {
78         struct ScanFillEdge *next, *prev;
79         struct ScanFillVert *v1, *v2;
80         short poly_nr;
81         unsigned char f;
82 } ScanFillEdge;
83
84 typedef struct ScanFillFace {
85         struct ScanFillFace *next, *prev;
86         struct ScanFillVert *v1, *v2, *v3;
87 } ScanFillFace;
88
89 /* scanfill.c: used in displist only... */
90 struct ScanFillVert *BLI_scanfill_vert_add(ScanFillContext *sf_ctx, const float vec[3]);
91 struct ScanFillEdge *BLI_scanfill_edge_add(ScanFillContext *sf_ctx, struct ScanFillVert *v1, struct ScanFillVert *v2);
92
93 int BLI_scanfill_begin(ScanFillContext *sf_ctx);
94 int BLI_scanfill_calc(ScanFillContext *sf_ctx, const short do_quad_tri_speedup);
95 int BLI_scanfill_calc_ex(ScanFillContext *sf_ctx, const short do_quad_tri_speedup,
96                          const float nor_proj[3]);
97 void BLI_scanfill_end(ScanFillContext *sf_ctx);
98
99 /* These callbacks are needed to make the lib finction properly */
100
101 /**
102  * Set a function taking a char* as argument to flag errors. If the
103  * callback is not set, the error is discarded.
104  * \param f The function to use as callback
105  * \attention used in creator.c
106  */
107 void BLI_setErrorCallBack(void (*f)(const char *));
108
109 /**
110  * Set a function to be able to interrupt the execution of processing
111  * in this module. If the function returns true, the execution will
112  * terminate gracefully. If the callback is not set, interruption is
113  * not possible.
114  * \param f The function to use as callback
115  * \attention used in creator.c
116  */
117 void BLI_setInterruptCallBack(int (*f)(void));
118
119 #ifdef __cplusplus
120 }
121 #endif
122
123 #endif
124