5204e0dd718d5e5a4246bc358fadbe9958f8ad45
[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                 unsigned int         u;
70         } tmp;
71         float co[3]; /* vertex location */
72         float xy[2]; /* 2D copy of vertex location (using dominant axis) */
73         unsigned int keyindex; /* original index #, for restoring  key information */
74         short poly_nr;
75         unsigned char f, h;
76 } ScanFillVert;
77
78 typedef struct ScanFillEdge {
79         struct ScanFillEdge *next, *prev;
80         struct ScanFillVert *v1, *v2;
81         short poly_nr;
82         unsigned char f;
83         union {
84                 unsigned char c;
85         } tmp;
86 } ScanFillEdge;
87
88 typedef struct ScanFillFace {
89         struct ScanFillFace *next, *prev;
90         struct ScanFillVert *v1, *v2, *v3;
91 } ScanFillFace;
92
93 /* scanfill.c: used in displist only... */
94 struct ScanFillVert *BLI_scanfill_vert_add(ScanFillContext *sf_ctx, const float vec[3]);
95 struct ScanFillEdge *BLI_scanfill_edge_add(ScanFillContext *sf_ctx, struct ScanFillVert *v1, struct ScanFillVert *v2);
96
97 enum {
98         BLI_SCANFILL_CALC_QUADTRI_FASTPATH = (1 << 0),
99
100         /* note: using BLI_SCANFILL_CALC_REMOVE_DOUBLES
101          * Assumes ordered edges, otherwise we risk an eternal loop
102          * removing double verts. - campbell */
103         BLI_SCANFILL_CALC_REMOVE_DOUBLES   = (1 << 1),
104
105         /* note: This flag removes checks for overlapping polygons.
106          * when this flag is set, we'll never get back more faces then (totvert - 2)*/
107         BLI_SCANFILL_CALC_HOLES            = (1 << 2)
108 };
109
110 int BLI_scanfill_begin(ScanFillContext *sf_ctx);
111 int BLI_scanfill_calc(ScanFillContext *sf_ctx, const int flag);
112 int BLI_scanfill_calc_ex(ScanFillContext *sf_ctx, const int flag,
113                          const float nor_proj[3]);
114 void BLI_scanfill_end(ScanFillContext *sf_ctx);
115
116 /* These callbacks are needed to make the lib finction properly */
117
118 /**
119  * Set a function taking a (char *) as argument to flag errors. If the
120  * callback is not set, the error is discarded.
121  * \param f The function to use as callback
122  * \attention used in creator.c
123  */
124 void BLI_setErrorCallBack(void (*f)(const char *));
125
126 /**
127  * Set a function to be able to interrupt the execution of processing
128  * in this module. If the function returns true, the execution will
129  * terminate gracefully. If the callback is not set, interruption is
130  * not possible.
131  * \param f The function to use as callback
132  * \attention used in creator.c
133  */
134 void BLI_setInterruptCallBack(int (*f)(void));
135
136 #ifdef __cplusplus
137 }
138 #endif
139
140 #endif
141