0029590: Coding - avoid usage of Standard_EXPORT attribute for inline methods
[occt.git] / src / BRepExtrema / BRepExtrema_ExtCF.hxx
1 // Copyright (c) 1999-2014 OPEN CASCADE SAS
2 //
3 // This file is part of Open CASCADE Technology software library.
4 //
5 // This library is free software; you can redistribute it and/or modify it under
6 // the terms of the GNU Lesser General Public License version 2.1 as published
7 // by the Free Software Foundation, with special exception defined in the file
8 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
9 // distribution for complete text of the license and disclaimer of any warranty.
10 //
11 // Alternatively, this file may be used under the terms of Open CASCADE
12 // commercial license or contractual agreement.
13
14 #ifndef _BRepExtrema_ExtCF_HeaderFile
15 #define _BRepExtrema_ExtCF_HeaderFile
16
17 #include <Extrema_ExtCS.hxx>
18 #include <TColStd_SequenceOfReal.hxx>
19 #include <Extrema_SequenceOfPOnSurf.hxx>
20 #include <Extrema_SequenceOfPOnCurv.hxx>
21 #include <BRepAdaptor_HSurface.hxx>
22 #include <Extrema_POnCurv.hxx>
23 #include <Extrema_POnSurf.hxx>
24 #include <Standard_DefineAlloc.hxx>
25
26 class BRepAdaptor_HSurface;
27 class TopoDS_Edge;
28 class TopoDS_Face;
29 class gp_Pnt;
30
31
32 class BRepExtrema_ExtCF
33 {
34  public:
35
36   DEFINE_STANDARD_ALLOC
37
38   BRepExtrema_ExtCF()
39   {
40   }
41   //! It calculates all the distances. <br>
42   Standard_EXPORT BRepExtrema_ExtCF(const TopoDS_Edge& E,const TopoDS_Face& F);
43
44   Standard_EXPORT void Initialize(const TopoDS_Edge& E, const TopoDS_Face& F);
45   //! An exception is raised if the fields have not been initialized. <br>
46   //! Be careful: this method uses the Face only for classify not for the fields. <br>
47   Standard_EXPORT void Perform(const TopoDS_Edge& E,const TopoDS_Face& F);
48   //! True if the distances are found. <br>
49   Standard_Boolean IsDone() const
50   {
51     return myExtCS.IsDone();
52   }
53   //! Returns the number of extremum distances. <br>
54   Standard_Integer NbExt() const
55   {
56     return mySqDist.Length();
57   }
58   //! Returns the value of the <N>th extremum square distance. <br>
59   Standard_Real SquareDistance(const Standard_Integer N) const
60   {
61     return mySqDist.Value(N);
62   }
63   //! Returns True if the curve is on a parallel surface. <br>
64   Standard_Boolean IsParallel() const
65   {
66     return myExtCS.IsParallel();
67   }
68   //! Returns the parameters on the Edge of the <N>th extremum distance. <br>
69   Standard_Real ParameterOnEdge(const Standard_Integer N) const
70   {
71     return myPointsOnC.Value(N).Parameter();
72   }
73   //! Returns the parameters on the Face of the <N>th extremum distance. <br>
74   void ParameterOnFace(const Standard_Integer N,Standard_Real& U,Standard_Real& V) const
75   {
76     myPointsOnS.Value(N).Parameter(U, V);
77   }
78   //! Returns the Point of the <N>th extremum distance. <br>
79   gp_Pnt PointOnEdge(const Standard_Integer N) const
80   {
81     return myPointsOnC.Value(N).Value();
82   }
83   //! Returns the Point of the <N>th extremum distance. <br>
84   gp_Pnt PointOnFace(const Standard_Integer N) const
85   {
86     return myPointsOnS.Value(N).Value();
87   }
88
89  private:
90
91   Extrema_ExtCS myExtCS;
92   TColStd_SequenceOfReal mySqDist;
93   Extrema_SequenceOfPOnSurf myPointsOnS;
94   Extrema_SequenceOfPOnCurv myPointsOnC;
95   Handle(BRepAdaptor_HSurface) myHS;
96 };
97
98 #endif