BRL-CAD
bg.h
Go to the documentation of this file.
1 /* B G . H
2  * BRL-CAD
3  *
4  * Copyright (c) 2015-2024 United States Government as represented by
5  * the U.S. Army Research Laboratory.
6  *
7  * This library is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU Lesser General Public License
9  * version 2.1 as published by the Free Software Foundation.
10  *
11  * This library is distributed in the hope that it will be useful, but
12  * WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14  * Lesser General Public License for more details.
15  *
16  * You should have received a copy of the GNU Lesser General Public
17  * License along with this file; see the file named COPYING for more
18  * information.
19  */
20 
21 /** @addtogroup libbg
22  *
23  * @brief
24  * BRL-CAD geometry library. This library is intended for generic
25  * geometry algorithms, such as point-in-polygon, does a line
26  * intersect a sphere, ear clipping triangulation of a polygon, etc.
27  *
28  * Algorithms in this library should not require solid raytracing
29  * of the BRL-CAD CSG boolean hierarchy - routines using those high
30  * level constructs should be in libanalyze, which uses librt to
31  * do the necessary raytracing. libbg is lower level, and should
32  * depend only on the numerics library (libbn) and the libbu utility
33  * (libbu)
34  *
35  * Strictly numerical algorithms, which do not involve 3D geometry
36  * concepts, belong in libbn. An example of something that would belong
37  * in libbn would be sparse matrix solving.
38  *
39  * The functionality provided by this library is specified in the bg.h
40  * header or appropriate included files from the ./bg subdirectory.
41  */
42 /** @{ */
43 /** @brief Header file for the BRL-CAD Geometry Library, LIBBG.*/
44 /** @file bg.h */
45 /** @} */
46 
47 #ifndef BG_H
48 #define BG_H
49 
50 #include "common.h"
51 
52 #include "bg/defines.h"
53 #include "bg/chull.h"
54 #include "bg/clip.h"
55 #include "bg/lseg.h"
56 #include "bg/obr.h"
57 #include "bg/plane.h"
58 #include "bg/polygon.h"
59 #include "bg/sat.h"
60 #include "bg/tri_pt.h"
61 #include "bg/tri_ray.h"
62 #include "bg/tri_tri.h"
63 #include "bg/trimesh.h"
64 
65 #endif /* BG_H */
66 
67 /*
68  * Local Variables:
69  * tab-width: 8
70  * mode: C
71  * indent-tabs-mode: t
72  * c-file-style: "stroustrup"
73  * End:
74  * ex: shiftwidth=4 tabstop=8
75  */
Header file for the BRL-CAD common definitions.