Skip to content
Snippets Groups Projects
Commit 41e139cf authored by Dmitri Naumov's avatar Dmitri Naumov
Browse files

[MGTL] Fix and extend search algorithms docu.

parent 23400031
No related branches found
No related tags found
No related merge requests found
...@@ -40,9 +40,11 @@ public: ...@@ -40,9 +40,11 @@ public:
/** /**
* Constructor * Constructor
* @param mesh mesh object * @param mesh mesh object
* @param sampled_len length type to be sampled * @param length_type length type to be sampled
*/ */
HeuristicSearchLength(MeshLib::Mesh const& mesh, LengthType length_type = LengthType::Edge); HeuristicSearchLength(MeshLib::Mesh const& mesh,
LengthType length_type = LengthType::Edge);
private: private:
MeshLib::Mesh const& _mesh; MeshLib::Mesh const& _mesh;
}; };
......
...@@ -56,6 +56,9 @@ public: ...@@ -56,6 +56,9 @@ public:
* internally used search length from the given MeshLib::Mesh. * internally used search length from the given MeshLib::Mesh.
* @param mesh Run search algorithm on this mesh. It is assumed * @param mesh Run search algorithm on this mesh. It is assumed
* that the mesh does not change its geometry. * that the mesh does not change its geometry.
* @param search_length_algorithm Algorithm to determine the search length.
* @param search_all_nodes switch between searching all mesh nodes and
* searching the base nodes.
*/ */
explicit MeshNodeSearcher(MeshLib::Mesh const& mesh, explicit MeshNodeSearcher(MeshLib::Mesh const& mesh,
MeshGeoToolsLib::SearchLength const& search_length_algorithm MeshGeoToolsLib::SearchLength const& search_length_algorithm
......
...@@ -40,12 +40,15 @@ public: ...@@ -40,12 +40,15 @@ public:
* Constructor of object, that search mesh nodes along a * Constructor of object, that search mesh nodes along a
* GeoLib::Polyline polyline within a given search radius. So the polyline * GeoLib::Polyline polyline within a given search radius. So the polyline
* is something like a tube. * is something like a tube.
* @param mesh_nodes Nodes the search will be performed on. * @param mesh Mesh the search will be performed on.
* @param ply Along the GeoLib::Polyline ply the mesh nodes are searched. * @param ply Along the GeoLib::Polyline ply the mesh nodes are searched.
* @param epsilon_radius Search / tube radius * @param epsilon_radius Search / tube radius
* @param search_all_nodes switch between searching all mesh nodes and
* searching the base nodes.
*/ */
MeshNodesAlongPolyline(MeshLib::Mesh const& mesh, MeshNodesAlongPolyline(MeshLib::Mesh const& mesh,
GeoLib::Polyline const& ply, double epsilon_radius, bool search_all_nodes = true); GeoLib::Polyline const& ply, double epsilon_radius,
bool search_all_nodes = true);
/// return the mesh object /// return the mesh object
MeshLib::Mesh const& getMesh() const; MeshLib::Mesh const& getMesh() const;
......
...@@ -36,7 +36,7 @@ public: ...@@ -36,7 +36,7 @@ public:
/** /**
* Constructor of object, that search mesh nodes along a * Constructor of object, that search mesh nodes along a
* GeoLib::Surface object within a given search radius. * GeoLib::Surface object within a given search radius.
* @param mesh_nodes Nodes the search will be performed on. * @param mesh Mesh the search will be performed on.
* @param sfc Along the GeoLib::Surface sfc the mesh nodes are searched. * @param sfc Along the GeoLib::Surface sfc the mesh nodes are searched.
* @param epsilon Euclidean distance tolerance value. Is the distance * @param epsilon Euclidean distance tolerance value. Is the distance
* between a mesh node and the surface smaller than that value it is a mesh * between a mesh node and the surface smaller than that value it is a mesh
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment