0031939: Coding - correction of spelling errors in comments [part 4]
[occt.git] / src / HLRBRep / HLRBRep_ThePolyhedronOfInterCSurf.hxx
1 // Created on: 1992-10-14
2 // Created by: Christophe MARION
3 // Copyright (c) 1992-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 _HLRBRep_ThePolyhedronOfInterCSurf_HeaderFile
18 #define _HLRBRep_ThePolyhedronOfInterCSurf_HeaderFile
19
20 #include <Standard.hxx>
21 #include <Standard_DefineAlloc.hxx>
22 #include <Standard_Handle.hxx>
23
24 #include <Standard_Integer.hxx>
25 #include <Bnd_Box.hxx>
26 #include <Bnd_HArray1OfBox.hxx>
27 #include <Standard_Real.hxx>
28 #include <Standard_Address.hxx>
29 #include <Standard_Boolean.hxx>
30 #include <TColStd_Array1OfReal.hxx>
31 class Standard_OutOfRange;
32 class HLRBRep_SurfaceTool;
33 class gp_Pnt;
34 class Bnd_Box;
35 class gp_XYZ;
36
37 class HLRBRep_ThePolyhedronOfInterCSurf 
38 {
39 public:
40
41   DEFINE_STANDARD_ALLOC
42
43   Standard_EXPORT HLRBRep_ThePolyhedronOfInterCSurf(const Standard_Address& Surface, const Standard_Integer nbdU, const Standard_Integer nbdV, const Standard_Real U1, const Standard_Real V1, const Standard_Real U2, const Standard_Real V2);
44   
45   Standard_EXPORT HLRBRep_ThePolyhedronOfInterCSurf(const Standard_Address& Surface, const TColStd_Array1OfReal& Upars, const TColStd_Array1OfReal& Vpars);
46   
47   Standard_EXPORT void Destroy();
48 ~HLRBRep_ThePolyhedronOfInterCSurf()
49 {
50   Destroy();
51 }
52   
53   Standard_EXPORT void DeflectionOverEstimation (const Standard_Real flec);
54   
55   Standard_EXPORT Standard_Real DeflectionOnTriangle (const Standard_Address& Surface, const Standard_Integer Index) const;
56   
57   Standard_EXPORT void UMinSingularity (const Standard_Boolean Sing);
58   
59   Standard_EXPORT void UMaxSingularity (const Standard_Boolean Sing);
60   
61   Standard_EXPORT void VMinSingularity (const Standard_Boolean Sing);
62   
63   Standard_EXPORT void VMaxSingularity (const Standard_Boolean Sing);
64   
65   //! get the size of the discretization.
66   Standard_EXPORT void Size (Standard_Integer& nbdu, Standard_Integer& nbdv) const;
67   
68   //! Give the number of triangles in this double array of
69   Standard_EXPORT Standard_Integer NbTriangles() const;
70   
71   //! Give the 3 points of the triangle of address Index in
72   //! the double array of triangles.
73   Standard_EXPORT void Triangle (const Standard_Integer Index, Standard_Integer& P1, Standard_Integer& P2, Standard_Integer& P3) const;
74   
75   //! Give the address Tricon of the triangle connexe to the
76   //! triangle of address Triang by the edge Pivot Pedge and
77   //! the third point of this connexe triangle. When we are
78   //! on a free edge TriCon==0 but the function return the
79   //! value of the triangle in the other side of Pivot on
80   //! the free edge. Used to turn around a vertex.
81   Standard_EXPORT Standard_Integer TriConnex (const Standard_Integer Triang, const Standard_Integer Pivot, const Standard_Integer Pedge, Standard_Integer& TriCon, Standard_Integer& OtherP) const;
82   
83   //! Give the number of point in the double array of
84   //! triangles ((nbdu+1)*(nbdv+1)).
85   Standard_EXPORT Standard_Integer NbPoints() const;
86   
87   //! Set the value of a field of the double array of
88   //! points.
89   Standard_EXPORT void Point (const gp_Pnt& thePnt, const Standard_Integer lig, const Standard_Integer col, const Standard_Real U, const Standard_Real V);
90   
91   //! Give the point of index i in the MaTriangle.
92   Standard_EXPORT const gp_Pnt& Point (const Standard_Integer Index, Standard_Real& U, Standard_Real& V) const;
93   
94   //! Give the point of index i in the MaTriangle.
95   Standard_EXPORT const gp_Pnt& Point (const Standard_Integer Index) const;
96   
97   //! Give the point of index i in the MaTriangle.
98   Standard_EXPORT void Point (const Standard_Integer Index, gp_Pnt& P) const;
99   
100   //! Give the bounding box of the MaTriangle.
101   Standard_EXPORT const Bnd_Box& Bounding() const;
102   
103   //! Compute the array of boxes. The box <n> corresponding
104   //! to the triangle <n>.
105   Standard_EXPORT void FillBounding();
106   
107   //! Give the array of boxes. The box <n> corresponding
108   //! to the triangle <n>.
109   Standard_EXPORT const Handle(Bnd_HArray1OfBox)& ComponentsBounding() const;
110   
111   Standard_EXPORT Standard_Real DeflectionOverEstimation() const;
112   
113   Standard_EXPORT Standard_Boolean HasUMinSingularity() const;
114   
115   Standard_EXPORT Standard_Boolean HasUMaxSingularity() const;
116   
117   Standard_EXPORT Standard_Boolean HasVMinSingularity() const;
118   
119   Standard_EXPORT Standard_Boolean HasVMaxSingularity() const;
120   
121   //! Give the plane equation of the triangle of address Triang.
122   Standard_EXPORT void PlaneEquation (const Standard_Integer Triang, gp_XYZ& NormalVector, Standard_Real& PolarDistance) const;
123   
124   //! Give the plane equation of the triangle of address Triang.
125   Standard_EXPORT Standard_Boolean Contain (const Standard_Integer Triang, const gp_Pnt& ThePnt) const;
126   
127   Standard_EXPORT void Parameters (const Standard_Integer Index, Standard_Real& U, Standard_Real& V) const;
128   
129   //! This method returns true if the edge based on points with
130   //! indices Index1 and Index2 represents a boundary edge. It is
131   //! necessary to take into account the boundary deflection for
132   //! this edge.
133   Standard_EXPORT Standard_Boolean IsOnBound (const Standard_Integer Index1, const Standard_Integer Index2) const;
134   
135   //! This method returns a border deflection.
136     Standard_Real GetBorderDeflection() const;
137   
138   Standard_EXPORT void Dump() const;
139
140 protected:
141
142   
143   Standard_EXPORT void Init (const Standard_Address& Surface, const Standard_Real U1, const Standard_Real V1, const Standard_Real U2, const Standard_Real V2);
144   
145   Standard_EXPORT void Init (const Standard_Address& Surface, const TColStd_Array1OfReal& Upars, const TColStd_Array1OfReal& Vpars);
146
147 private:
148
149   //! This method computes and returns a deflection of isoline
150   //! of given parameter on Surface.
151   Standard_EXPORT Standard_Real ComputeBorderDeflection (const Standard_Address& Surface, const Standard_Real Parameter, const Standard_Real PMin, const Standard_Real PMax, const Standard_Boolean isUIso) const;
152
153 private:
154
155   Standard_Integer nbdeltaU;
156   Standard_Integer nbdeltaV;
157   Bnd_Box TheBnd;
158   Handle(Bnd_HArray1OfBox) TheComponentsBnd;
159   Standard_Real TheDeflection;
160   Standard_Address C_MyPnts;
161   Standard_Address C_MyU;
162   Standard_Address C_MyV;
163   Standard_Boolean UMinSingular;
164   Standard_Boolean UMaxSingular;
165   Standard_Boolean VMinSingular;
166   Standard_Boolean VMaxSingular;
167   Standard_Real TheBorderDeflection;
168   Standard_Address C_MyIsOnBounds;
169
170 };
171
172 #define ThePSurface Standard_Address
173 #define ThePSurface_hxx <Standard_Address.hxx>
174 #define ThePSurfaceTool HLRBRep_SurfaceTool
175 #define ThePSurfaceTool_hxx <HLRBRep_SurfaceTool.hxx>
176 #define IntCurveSurface_Polyhedron HLRBRep_ThePolyhedronOfInterCSurf
177 #define IntCurveSurface_Polyhedron_hxx <HLRBRep_ThePolyhedronOfInterCSurf.hxx>
178
179 #include <IntCurveSurface_Polyhedron.lxx>
180
181 #undef ThePSurface
182 #undef ThePSurface_hxx
183 #undef ThePSurfaceTool
184 #undef ThePSurfaceTool_hxx
185 #undef IntCurveSurface_Polyhedron
186 #undef IntCurveSurface_Polyhedron_hxx
187
188 #endif // _HLRBRep_ThePolyhedronOfInterCSurf_HeaderFile