0024002: Overall code and build procedure refactoring -- automatic
[occt.git] / src / BRepBndLib / BRepBndLib.hxx
CommitLineData
42cf5bc1 1// Created on: 1993-07-22
2// Created by: Isabelle GRIGNON
3// Copyright (c) 1993-1999 Matra Datavision
4// Copyright (c) 1999-2014 OPEN CASCADE SAS
5//
6// This file is part of Open CASCADE Technology software library.
7//
8// This library is free software; you can redistribute it and/or modify it under
9// the terms of the GNU Lesser General Public License version 2.1 as published
10// by the Free Software Foundation, with special exception defined in the file
11// OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
12// distribution for complete text of the license and disclaimer of any warranty.
13//
14// Alternatively, this file may be used under the terms of Open CASCADE
15// commercial license or contractual agreement.
16
17#ifndef _BRepBndLib_HeaderFile
18#define _BRepBndLib_HeaderFile
19
20#include <Standard.hxx>
21#include <Standard_DefineAlloc.hxx>
22#include <Standard_Handle.hxx>
23
24#include <Standard_Boolean.hxx>
25class TopoDS_Shape;
26class Bnd_Box;
27
28
29//! This package provides the bounding boxes for curves
30//! and surfaces from BRepAdaptor.
31//! Functions to add a topological shape to a bounding box
32class BRepBndLib
33{
34public:
35
36 DEFINE_STANDARD_ALLOC
37
38
39 //! Adds the shape S to the bounding box B.
40 //! More precisely are successively added to B:
41 //! - each face of S; the triangulation of the face is used if it exists,
42 //! - then each edge of S which does not belong to a face,
43 //! the polygon of the edge is used if it exists
44 //! - and last each vertex of S which does not belong to an edge.
45 //! After each elementary operation, the bounding box B is
46 //! enlarged by the tolerance value of the relative sub-shape.
47 //! When working with the triangulation of a face this value of
48 //! enlargement is the sum of the triangulation deflection and
49 //! the face tolerance. When working with the
50 //! polygon of an edge this value of enlargement is
51 //! the sum of the polygon deflection and the edge tolerance.
52 //! Warning
53 //! - This algorithm is time consuming if triangulation has not
54 //! been inserted inside the data structure of the shape S.
55 //! - The resulting bounding box may be somewhat larger than the object.
56 Standard_EXPORT static void Add (const TopoDS_Shape& S, Bnd_Box& B, const Standard_Boolean useTriangulation = Standard_True);
57
58 //! Adds the shape S to the bounding box B.
59 //! This is a quick algorithm but only works if the shape S is
60 //! composed of polygonal planar faces, as is the case if S is
61 //! an approached polyhedral representation of an exact
62 //! shape. Pay particular attention to this because this
63 //! condition is not checked and, if it not respected, an error
64 //! may occur in the algorithm for which the bounding box is built.
65 //! Note that the resulting bounding box is not enlarged by the
66 //! tolerance value of the sub-shapes as is the case with the
67 //! Add function. So the added part of the resulting bounding
68 //! box is closer to the shape S.
69 Standard_EXPORT static void AddClose (const TopoDS_Shape& S, Bnd_Box& B);
70
71
72
73
74protected:
75
76
77
78
79
80private:
81
82
83
84
85
86};
87
88
89
90
91
92
93
94#endif // _BRepBndLib_HeaderFile