0031939: Coding - correction of spelling errors in comments
[occt.git] / src / IntPatch / IntPatch_PolyhedronTool.hxx
1 // Created on: 1993-05-06
2 // Created by: Jacques GOUSSARD
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 _IntPatch_PolyhedronTool_HeaderFile
18 #define _IntPatch_PolyhedronTool_HeaderFile
19
20 #include <Standard.hxx>
21 #include <Standard_DefineAlloc.hxx>
22 #include <Standard_Handle.hxx>
23
24 #include <Bnd_HArray1OfBox.hxx>
25 #include <Standard_Real.hxx>
26 #include <Standard_Integer.hxx>
27 class Standard_OutOfRange;
28 class Bnd_Box;
29 class IntPatch_Polyhedron;
30 class gp_Pnt;
31
32
33 //! Describe  the signature  of  a  polyedral surface with
34 //! only triangular  facets and the necessary information
35 //! to compute the interferences.
36 class IntPatch_PolyhedronTool 
37 {
38 public:
39
40   DEFINE_STANDARD_ALLOC
41
42   
43   //! Give the bounding box of the Polyhedron.
44     static const Bnd_Box& Bounding (const IntPatch_Polyhedron& thePolyh);
45   
46   //! Give the array of boxes. The box <n> corresponding
47   //! to the triangle <n>.
48     static const Handle(Bnd_HArray1OfBox)& ComponentsBounding (const IntPatch_Polyhedron& thePolyh);
49   
50   //! Give the tolerance of the polygon.
51     static Standard_Real DeflectionOverEstimation (const IntPatch_Polyhedron& thePolyh);
52   
53   //! Give the number of triangles in this polyedral surface.
54     static Standard_Integer NbTriangles (const IntPatch_Polyhedron& thePolyh);
55   
56   //! Give the indices  of  the 3 points of  the triangle of
57   //! address Index in the Polyhedron.
58     static void Triangle (const IntPatch_Polyhedron& thePolyh, const Standard_Integer Index, Standard_Integer& P1, Standard_Integer& P2, Standard_Integer& P3);
59   
60   //! Give the point of index i in the polyedral surface.
61     static const gp_Pnt& Point (const IntPatch_Polyhedron& thePolyh, const Standard_Integer Index);
62   
63   //! Gives the  addresse Tricon of   the triangle connexe to
64   //! the triangle of address Triang by the edge Pivot Pedge
65   //! and the third point of this  connexe triangle. When we
66   //! are on  a free edge TriCon==0  but the function return
67   //! the value of  the triangle in the  other side of Pivot
68   //! on the free edge.  Used to turn around a vertex.
69     static Standard_Integer TriConnex (const IntPatch_Polyhedron& thePolyh, const Standard_Integer Triang, const Standard_Integer Pivot, const Standard_Integer Pedge, Standard_Integer& TriCon, Standard_Integer& OtherP);
70
71
72
73
74 protected:
75
76
77
78
79
80 private:
81
82
83
84
85
86 };
87
88
89 #include <IntPatch_PolyhedronTool.lxx>
90
91
92
93
94
95 #endif // _IntPatch_PolyhedronTool_HeaderFile