triangle.h
上传用户:yflamps
上传日期:2010-04-01
资源大小:155k
文件大小:21k
源码类别:

3D图形编程

开发平台:

C/C++

  1. /*****************************************************************************/
  2. /*                                                                           */
  3. /*  (triangle.h)                                                             */
  4. /*                                                                           */
  5. /*  Include file for programs that call Triangle.                            */
  6. /*                                                                           */
  7. /*  Accompanies Triangle Version 1.6                                         */
  8. /*  July 28, 2005                                                            */
  9. /*                                                                           */
  10. /*  Copyright 1996, 2005                                                     */
  11. /*  Jonathan Richard Shewchuk                                                */
  12. /*  2360 Woolsey #H                                                          */
  13. /*  Berkeley, California  94705-1927                                         */
  14. /*  jrs@cs.berkeley.edu                                                      */
  15. /*                                                                           */
  16. /*****************************************************************************/
  17. /*****************************************************************************/
  18. /*                                                                           */
  19. /*  How to call Triangle from another program                                */
  20. /*                                                                           */
  21. /*                                                                           */
  22. /*  If you haven't read Triangle's instructions (run "triangle -h" to read   */
  23. /*  them), you won't understand what follows.                                */
  24. /*                                                                           */
  25. /*  Triangle must be compiled into an object file (triangle.o) with the      */
  26. /*  TRILIBRARY symbol defined (generally by using the -DTRILIBRARY compiler  */
  27. /*  switch).  The makefile included with Triangle will do this for you if    */
  28. /*  you run "make trilibrary".  The resulting object file can be called via  */
  29. /*  the procedure triangulate().                                             */
  30. /*                                                                           */
  31. /*  If the size of the object file is important to you, you may wish to      */
  32. /*  generate a reduced version of triangle.o.  The REDUCED symbol gets rid   */
  33. /*  of all features that are primarily of research interest.  Specifically,  */
  34. /*  the -DREDUCED switch eliminates Triangle's -i, -F, -s, and -C switches.  */
  35. /*  The CDT_ONLY symbol gets rid of all meshing algorithms above and beyond  */
  36. /*  constrained Delaunay triangulation.  Specifically, the -DCDT_ONLY switch */
  37. /*  eliminates Triangle's -r, -q, -a, -u, -D, -Y, -S, and -s switches.       */
  38. /*                                                                           */
  39. /*  IMPORTANT:  These definitions (TRILIBRARY, REDUCED, CDT_ONLY) must be    */
  40. /*  made in the makefile or in triangle.c itself.  Putting these definitions */
  41. /*  in this file (triangle.h) will not create the desired effect.            */
  42. /*                                                                           */
  43. /*                                                                           */
  44. /*  The calling convention for triangulate() follows.                        */
  45. /*                                                                           */
  46. /*      void triangulate(triswitches, in, out, vorout)                       */
  47. /*      char *triswitches;                                                   */
  48. /*      struct triangulateio *in;                                            */
  49. /*      struct triangulateio *out;                                           */
  50. /*      struct triangulateio *vorout;                                        */
  51. /*                                                                           */
  52. /*  `triswitches' is a string containing the command line switches you wish  */
  53. /*  to invoke.  No initial dash is required.  Some suggestions:              */
  54. /*                                                                           */
  55. /*  - You'll probably find it convenient to use the `z' switch so that       */
  56. /*    points (and other items) are numbered from zero.  This simplifies      */
  57. /*    indexing, because the first item of any type always starts at index    */
  58. /*    [0] of the corresponding array, whether that item's number is zero or  */
  59. /*    one.                                                                   */
  60. /*  - You'll probably want to use the `Q' (quiet) switch in your final code, */
  61. /*    but you can take advantage of Triangle's printed output (including the */
  62. /*    `V' switch) while debugging.                                           */
  63. /*  - If you are not using the `q', `a', `u', `D', `j', or `s' switches,     */
  64. /*    then the output points will be identical to the input points, except   */
  65. /*    possibly for the boundary markers.  If you don't need the boundary     */
  66. /*    markers, you should use the `N' (no nodes output) switch to save       */
  67. /*    memory.  (If you do need boundary markers, but need to save memory, a  */
  68. /*    good nasty trick is to set out->pointlist equal to in->pointlist       */
  69. /*    before calling triangulate(), so that Triangle overwrites the input    */
  70. /*    points with identical copies.)                                         */
  71. /*  - The `I' (no iteration numbers) and `g' (.off file output) switches     */
  72. /*    have no effect when Triangle is compiled with TRILIBRARY defined.      */
  73. /*                                                                           */
  74. /*  `in', `out', and `vorout' are descriptions of the input, the output,     */
  75. /*  and the Voronoi output.  If the `v' (Voronoi output) switch is not used, */
  76. /*  `vorout' may be NULL.  `in' and `out' may never be NULL.                 */
  77. /*                                                                           */
  78. /*  Certain fields of the input and output structures must be initialized,   */
  79. /*  as described below.                                                      */
  80. /*                                                                           */
  81. /*****************************************************************************/
  82. /*****************************************************************************/
  83. /*                                                                           */
  84. /*  The `triangulateio' structure.                                           */
  85. /*                                                                           */
  86. /*  Used to pass data into and out of the triangulate() procedure.           */
  87. /*                                                                           */
  88. /*                                                                           */
  89. /*  Arrays are used to store points, triangles, markers, and so forth.  In   */
  90. /*  all cases, the first item in any array is stored starting at index [0].  */
  91. /*  However, that item is item number `1' unless the `z' switch is used, in  */
  92. /*  which case it is item number `0'.  Hence, you may find it easier to      */
  93. /*  index points (and triangles in the neighbor list) if you use the `z'     */
  94. /*  switch.  Unless, of course, you're calling Triangle from a Fortran       */
  95. /*  program.                                                                 */
  96. /*                                                                           */
  97. /*  Description of fields (except the `numberof' fields, which are obvious): */
  98. /*                                                                           */
  99. /*  `pointlist':  An array of point coordinates.  The first point's x        */
  100. /*    coordinate is at index [0] and its y coordinate at index [1], followed */
  101. /*    by the coordinates of the remaining points.  Each point occupies two   */
  102. /*    REALs.                                                                 */
  103. /*  `pointattributelist':  An array of point attributes.  Each point's       */
  104. /*    attributes occupy `numberofpointattributes' REALs.                     */
  105. /*  `pointmarkerlist':  An array of point markers; one int per point.        */
  106. /*                                                                           */
  107. /*  `trianglelist':  An array of triangle corners.  The first triangle's     */
  108. /*    first corner is at index [0], followed by its other two corners in     */
  109. /*    counterclockwise order, followed by any other nodes if the triangle    */
  110. /*    represents a nonlinear element.  Each triangle occupies                */
  111. /*    `numberofcorners' ints.                                                */
  112. /*  `triangleattributelist':  An array of triangle attributes.  Each         */
  113. /*    triangle's attributes occupy `numberoftriangleattributes' REALs.       */
  114. /*  `trianglearealist':  An array of triangle area constraints; one REAL per */
  115. /*    triangle.  Input only.                                                 */
  116. /*  `neighborlist':  An array of triangle neighbors; three ints per          */
  117. /*    triangle.  Output only.                                                */
  118. /*                                                                           */
  119. /*  `segmentlist':  An array of segment endpoints.  The first segment's      */
  120. /*    endpoints are at indices [0] and [1], followed by the remaining        */
  121. /*    segments.  Two ints per segment.                                       */
  122. /*  `segmentmarkerlist':  An array of segment markers; one int per segment.  */
  123. /*                                                                           */
  124. /*  `holelist':  An array of holes.  The first hole's x and y coordinates    */
  125. /*    are at indices [0] and [1], followed by the remaining holes.  Two      */
  126. /*    REALs per hole.  Input only, although the pointer is copied to the     */
  127. /*    output structure for your convenience.                                 */
  128. /*                                                                           */
  129. /*  `regionlist':  An array of regional attributes and area constraints.     */
  130. /*    The first constraint's x and y coordinates are at indices [0] and [1], */
  131. /*    followed by the regional attribute at index [2], followed by the       */
  132. /*    maximum area at index [3], followed by the remaining area constraints. */
  133. /*    Four REALs per area constraint.  Note that each regional attribute is  */
  134. /*    used only if you select the `A' switch, and each area constraint is    */
  135. /*    used only if you select the `a' switch (with no number following), but */
  136. /*    omitting one of these switches does not change the memory layout.      */
  137. /*    Input only, although the pointer is copied to the output structure for */
  138. /*    your convenience.                                                      */
  139. /*                                                                           */
  140. /*  `edgelist':  An array of edge endpoints.  The first edge's endpoints are */
  141. /*    at indices [0] and [1], followed by the remaining edges.  Two ints per */
  142. /*    edge.  Output only.                                                    */
  143. /*  `edgemarkerlist':  An array of edge markers; one int per edge.  Output   */
  144. /*    only.                                                                  */
  145. /*  `normlist':  An array of normal vectors, used for infinite rays in       */
  146. /*    Voronoi diagrams.  The first normal vector's x and y magnitudes are    */
  147. /*    at indices [0] and [1], followed by the remaining vectors.  For each   */
  148. /*    finite edge in a Voronoi diagram, the normal vector written is the     */
  149. /*    zero vector.  Two REALs per edge.  Output only.                        */
  150. /*                                                                           */
  151. /*                                                                           */
  152. /*  Any input fields that Triangle will examine must be initialized.         */
  153. /*  Furthermore, for each output array that Triangle will write to, you      */
  154. /*  must either provide space by setting the appropriate pointer to point    */
  155. /*  to the space you want the data written to, or you must initialize the    */
  156. /*  pointer to NULL, which tells Triangle to allocate space for the results. */
  157. /*  The latter option is preferable, because Triangle always knows exactly   */
  158. /*  how much space to allocate.  The former option is provided mainly for    */
  159. /*  people who need to call Triangle from Fortran code, though it also makes */
  160. /*  possible some nasty space-saving tricks, like writing the output to the  */
  161. /*  same arrays as the input.                                                */
  162. /*                                                                           */
  163. /*  Triangle will not free() any input or output arrays, including those it  */
  164. /*  allocates itself; that's up to you.  You should free arrays allocated by */
  165. /*  Triangle by calling the trifree() procedure defined below.  (By default, */
  166. /*  trifree() just calls the standard free() library procedure, but          */
  167. /*  applications that call triangulate() may replace trimalloc() and         */
  168. /*  trifree() in triangle.c to use specialized memory allocators.)           */
  169. /*                                                                           */
  170. /*  Here's a guide to help you decide which fields you must initialize       */
  171. /*  before you call triangulate().                                           */
  172. /*                                                                           */
  173. /*  `in':                                                                    */
  174. /*                                                                           */
  175. /*    - `pointlist' must always point to a list of points; `numberofpoints'  */
  176. /*      and `numberofpointattributes' must be properly set.                  */
  177. /*      `pointmarkerlist' must either be set to NULL (in which case all      */
  178. /*      markers default to zero), or must point to a list of markers.  If    */
  179. /*      `numberofpointattributes' is not zero, `pointattributelist' must     */
  180. /*      point to a list of point attributes.                                 */
  181. /*    - If the `r' switch is used, `trianglelist' must point to a list of    */
  182. /*      triangles, and `numberoftriangles', `numberofcorners', and           */
  183. /*      `numberoftriangleattributes' must be properly set.  If               */
  184. /*      `numberoftriangleattributes' is not zero, `triangleattributelist'    */
  185. /*      must point to a list of triangle attributes.  If the `a' switch is   */
  186. /*      used (with no number following), `trianglearealist' must point to a  */
  187. /*      list of triangle area constraints.  `neighborlist' may be ignored.   */
  188. /*    - If the `p' switch is used, `segmentlist' must point to a list of     */
  189. /*      segments, `numberofsegments' must be properly set, and               */
  190. /*      `segmentmarkerlist' must either be set to NULL (in which case all    */
  191. /*      markers default to zero), or must point to a list of markers.        */
  192. /*    - If the `p' switch is used without the `r' switch, then               */
  193. /*      `numberofholes' and `numberofregions' must be properly set.  If      */
  194. /*      `numberofholes' is not zero, `holelist' must point to a list of      */
  195. /*      holes.  If `numberofregions' is not zero, `regionlist' must point to */
  196. /*      a list of region constraints.                                        */
  197. /*    - If the `p' switch is used, `holelist', `numberofholes',              */
  198. /*      `regionlist', and `numberofregions' is copied to `out'.  (You can    */
  199. /*      nonetheless get away with not initializing them if the `r' switch is */
  200. /*      used.)                                                               */
  201. /*    - `edgelist', `edgemarkerlist', `normlist', and `numberofedges' may be */
  202. /*      ignored.                                                             */
  203. /*                                                                           */
  204. /*  `out':                                                                   */
  205. /*                                                                           */
  206. /*    - `pointlist' must be initialized (NULL or pointing to memory) unless  */
  207. /*      the `N' switch is used.  `pointmarkerlist' must be initialized       */
  208. /*      unless the `N' or `B' switch is used.  If `N' is not used and        */
  209. /*      `in->numberofpointattributes' is not zero, `pointattributelist' must */
  210. /*      be initialized.                                                      */
  211. /*    - `trianglelist' must be initialized unless the `E' switch is used.    */
  212. /*      `neighborlist' must be initialized if the `n' switch is used.  If    */
  213. /*      the `E' switch is not used and (`in->numberofelementattributes' is   */
  214. /*      not zero or the `A' switch is used), `elementattributelist' must be  */
  215. /*      initialized.  `trianglearealist' may be ignored.                     */
  216. /*    - `segmentlist' must be initialized if the `p' or `c' switch is used,  */
  217. /*      and the `P' switch is not used.  `segmentmarkerlist' must also be    */
  218. /*      initialized under these circumstances unless the `B' switch is used. */
  219. /*    - `edgelist' must be initialized if the `e' switch is used.            */
  220. /*      `edgemarkerlist' must be initialized if the `e' switch is used and   */
  221. /*      the `B' switch is not.                                               */
  222. /*    - `holelist', `regionlist', `normlist', and all scalars may be ignored.*/
  223. /*                                                                           */
  224. /*  `vorout' (only needed if `v' switch is used):                            */
  225. /*                                                                           */
  226. /*    - `pointlist' must be initialized.  If `in->numberofpointattributes'   */
  227. /*      is not zero, `pointattributelist' must be initialized.               */
  228. /*      `pointmarkerlist' may be ignored.                                    */
  229. /*    - `edgelist' and `normlist' must both be initialized.                  */
  230. /*      `edgemarkerlist' may be ignored.                                     */
  231. /*    - Everything else may be ignored.                                      */
  232. /*                                                                           */
  233. /*  After a call to triangulate(), the valid fields of `out' and `vorout'    */
  234. /*  will depend, in an obvious way, on the choice of switches used.  Note    */
  235. /*  that when the `p' switch is used, the pointers `holelist' and            */
  236. /*  `regionlist' are copied from `in' to `out', but no new space is          */
  237. /*  allocated; be careful that you don't free() the same array twice.  On    */
  238. /*  the other hand, Triangle will never copy the `pointlist' pointer (or any */
  239. /*  others); new space is allocated for `out->pointlist', or if the `N'      */
  240. /*  switch is used, `out->pointlist' remains uninitialized.                  */
  241. /*                                                                           */
  242. /*  All of the meaningful `numberof' fields will be properly set; for        */
  243. /*  instance, `numberofedges' will represent the number of edges in the      */
  244. /*  triangulation whether or not the edges were written.  If segments are    */
  245. /*  not used, `numberofsegments' will indicate the number of boundary edges. */
  246. /*                                                                           */
  247. /*****************************************************************************/
  248. struct triangulateio {
  249.   REAL *pointlist;                                               /* In / out */
  250.   REAL *pointattributelist;                                      /* In / out */
  251.   int *pointmarkerlist;                                          /* In / out */
  252.   int numberofpoints;                                            /* In / out */
  253.   int numberofpointattributes;                                   /* In / out */
  254.   int *trianglelist;                                             /* In / out */
  255.   REAL *triangleattributelist;                                   /* In / out */
  256.   REAL *trianglearealist;                                         /* In only */
  257.   int *neighborlist;                                             /* Out only */
  258.   int numberoftriangles;                                         /* In / out */
  259.   int numberofcorners;                                           /* In / out */
  260.   int numberoftriangleattributes;                                /* In / out */
  261.   int *segmentlist;                                              /* In / out */
  262.   int *segmentmarkerlist;                                        /* In / out */
  263.   int numberofsegments;                                          /* In / out */
  264.   REAL *holelist;                        /* In / pointer to array copied out */
  265.   int numberofholes;                                      /* In / copied out */
  266.   REAL *regionlist;                      /* In / pointer to array copied out */
  267.   int numberofregions;                                    /* In / copied out */
  268.   int *edgelist;                                                 /* Out only */
  269.   int *edgemarkerlist;            /* Not used with Voronoi diagram; out only */
  270.   REAL *normlist;                /* Used only with Voronoi diagram; out only */
  271.   int numberofedges;                                             /* Out only */
  272. };
  273. #ifdef ANSI_DECLARATORS
  274. void triangulate(char *, struct triangulateio *, struct triangulateio *,
  275.                  struct triangulateio *);
  276. void trifree(VOID *memptr);
  277. #else /* not ANSI_DECLARATORS */
  278. void triangulate();
  279. void trifree();
  280. #endif /* not ANSI_DECLARATORS */