diff --git a/MeshGeoToolsLib/AppendLinesAlongPolyline.h b/MeshGeoToolsLib/AppendLinesAlongPolyline.h index 3f1bae0931a2588c66c9568106d91806cbbb07f1..522d05914e004549375cd72fcd1255d95d1f79cc 100644 --- a/MeshGeoToolsLib/AppendLinesAlongPolyline.h +++ b/MeshGeoToolsLib/AppendLinesAlongPolyline.h @@ -19,7 +19,22 @@ class Mesh; namespace MeshGeoToolsLib { + +/** + * Add line elements to a copy of a given mesh + * + * The function creates line elements from nodes located along user-provided polylines. + * New elements will have a distinct material ID for each polyline. + * + * \remark The function allows creation of duplicated line elements. + * \remark Line elements may not be placed along edges of existing elements. + * + * @param mesh original mesh + * @param ply_vec polyline vector whose nodes are used to create line elements + * @return a new mesh which is copied from a given mesh and additionally includes line elements + */ MeshLib::Mesh* appendLinesAlongPolylines(const MeshLib::Mesh &mesh, const GeoLib::PolylineVec &ply_vec); + } #endif