Salome HOME
updated copyright message
[plugins/blsurfplugin.git] / src / BLSURFPlugin / BLSURFPlugin_Attractor.hxx
1 // Copyright (C) 2007-2023  CEA, EDF
2 //
3 // This library is free software; you can redistribute it and/or
4 // modify it under the terms of the GNU Lesser General Public
5 // License as published by the Free Software Foundation; either
6 // version 2.1 of the License, or (at your option) any later version.
7 //
8 // This library is distributed in the hope that it will be useful,
9 // but WITHOUT ANY WARRANTY; without even the implied warranty of
10 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
11 // Lesser General Public License for more details.
12 //
13 // You should have received a copy of the GNU Lesser General Public
14 // License along with this library; if not, write to the Free Software
15 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
16 //
17 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
18 //
19
20 // ---
21 // File    : BLSURFPlugin_Attractor.hxx
22 // Authors : Renaud Nédélec (OCC)
23 // ---
24 // 
25 // The idea of the algorithm used to calculate the distance on a 
26 // non-euclidian parametric surface has been found in the ref. below:
27 //
28 // Ref:"Accurate Anisotropic Fast Marching for Diffusion-Based Geodesic Tractography"
29 // S. Jbabdi, P. Bellec, R. Toro, Daunizeau, M. Pélégrini-Issac, and H. Benali1
30 //
31
32 #ifndef _BLSURFPlugin_Attractor_HXX_
33 #define _BLSURFPlugin_Attractor_HXX_
34
35 #include <vector>
36 #include <map>
37 #include <set>
38 #include <stdexcept>
39 #include <string>
40 #include <limits>
41 #include <utilities.h>
42
43 // OPENCASCADE includes
44 #include <BRep_Tool.hxx>
45 #include <TopExp.hxx>
46 #include <TopExp_Explorer.hxx>
47 #include <TopoDS.hxx>
48 #include <NCollection_Map.hxx>
49
50 #include <Geom_Surface.hxx>
51 #include <Geom2d_Curve.hxx>
52 #include <Geom_Curve.hxx>
53 #include <TopoDS_Vertex.hxx>
54 #include <TopoDS_Edge.hxx>
55 #include <TopoDS_Wire.hxx>
56 #include <TopoDS_Face.hxx>
57
58 #include <gp_Pnt2d.hxx>
59 #include <TopTools_IndexedMapOfShape.hxx>
60 #include <TopoDS_Shape.hxx>
61 #include <BRep_Builder.hxx>
62 #include <BRepTools.hxx>
63
64 #include <TopTools_DataMapOfShapeInteger.hxx>
65 #include <GProp_GProps.hxx>
66 #include <BRepGProp.hxx>
67
68 #ifndef WIN32
69 #include <fenv.h>
70 #endif
71
72 #include <Standard_ErrorHandler.hxx>
73 #include <GeomAPI_ProjectPointOnCurve.hxx>
74 #include <GeomAPI_ProjectPointOnSurf.hxx>
75 #include <gp_XY.hxx>
76 #include <gp_XYZ.hxx>
77 #include <TopTools_MapOfShape.hxx>
78
79 #define TYPE_EXP 0
80 #define TYPE_LIN 1
81
82 class BLSURFPlugin_Attractor {
83   
84   public:
85     
86     BLSURFPlugin_Attractor ();
87     BLSURFPlugin_Attractor (const TopoDS_Face& Face, const TopoDS_Shape& Attractor, const std::string& attEntry); 
88     
89     bool init();                                                // Calculates the discrete points correponding to attractor 
90                                                                 // and intialises the map of distances
91     void avoidOutOfBounds(int& i, int&j);
92     void edgeInit(Handle(Geom_Surface) aSurf, const TopoDS_Edge& anEdge);
93     
94     double              GetSize (double u, double v);
95     TopoDS_Face         GetFace()           const { return _face; }
96     TopoDS_Shape        GetAttractorShape() const { return _attractorShape; }
97     std::string         GetAttractorEntry() const { return _attEntry; }
98     std::vector<double> GetParameters()     const 
99     { 
100       double tab_params[] = {_startSize, _endSize, _actionRadius, _constantRadius}; 
101       std::vector<double> params (tab_params, tab_params + sizeof(tab_params) / sizeof(double) );
102       return params;
103     }
104     
105     void SetParameters(double Start_Size, double End_Size, double Action_Radius, double Constant_Radius);
106     void SetType(int type){ _type = type; }
107     
108     void BuildMap();                                            // Builds the map of distances between source point and any point P(u,v)
109     bool IsMapBuilt() const { return _isMapBuilt; }             // Controls if the map has been built
110     bool Empty()      const { return _isEmpty; }
111   
112     typedef std::vector<double> TDiscreteParam;
113     typedef std::vector< std::vector<double> > TDistMap;
114     typedef std::vector< std::vector<bool> > TPointSet;
115     typedef std::set< std::vector<double> > TTrialSet;
116     typedef std::vector<double> Trial_Pnt;
117     typedef std::vector<int> IJ_Pnt;
118           
119   private:
120     
121     TopoDS_Face       _face;
122     TopoDS_Shape      _attractorShape;
123     std::string       _attEntry;
124     TDiscreteParam    _vectU;
125     TDiscreteParam    _vectV;
126     TDistMap          _DMap;
127     TPointSet         _known;
128     TTrialSet         _trial;
129     int               _type;                                    // Type of function used to calculate the size from the distance (unused for now)
130     int               _gridU;                                   // Number of grid points in U direction
131     int               _gridV;                                   // Number of grid points in V direction
132     double            _u1, _u2, _v1, _v2;                       // Bounds of the parametric space of the face 
133     double            _startSize, _endSize;                     // User parameters
134     double            _actionRadius, _constantRadius;           //
135     
136     bool              _isMapBuilt;
137     bool              _isEmpty;
138
139   // data of a specific case: a point attractor on a plane
140   Handle(Geom_Surface) _plane;
141   gp_Pnt               _attractorPnt;
142     
143   double            (BLSURFPlugin_Attractor::*_distance)(double u, double v);            // Retrieve the value of the distance map at point (u,v) of the parametric space of _face
144   double            _distanceFromMap(double u, double v);
145   double            _distanceFromPoint(double u, double v);
146 };    
147
148 #endif