MRSurfacePath.h

Go to the documentation of this file.

#pragma once
 
#include "MRExpected.h"
#include "MRMeshTriPoint.h"
#include "MREnums.h"
#include <vector>
#include <string>
 
namespace MR
{
 
 
enum class PathError
{
    StartEndNotConnected, 
    InternalError         
};
 
inline std::string toString(PathError error)
{
    switch (error)
    {
        case PathError::StartEndNotConnected:   return "No path can be found from start to end, because they are not from the same connected component";
        case PathError::InternalError:          return "Report to developers for further investigations";
        default:                                return "Unknown error. Please, report to developers for further investigations";
    }
}
 
MRMESH_API Expected<SurfacePath, PathError> computeSurfacePath( const MeshPart & mp, 
    const MeshTriPoint & start, const MeshTriPoint & end, 
    int maxGeodesicIters = 5, 
    const VertBitSet* vertRegion = nullptr, VertScalars * outSurfaceDistances = nullptr );
 
MRMESH_API Expected<SurfacePath, PathError> computeGeodesicPath( const Mesh & mesh,
    const MeshTriPoint & start, const MeshTriPoint & end, GeodesicPathApprox atype = GeodesicPathApprox::FastMarching,
    int maxGeodesicIters = 100 ); 
 
MRMESH_API Expected<SurfacePath, PathError> computeGeodesicPathApprox( const Mesh & mesh,
    const MeshTriPoint & start, const MeshTriPoint & end, GeodesicPathApprox atype );
 
MRMESH_API Expected<SurfacePath, PathError> computeFastMarchingPath( const MeshPart & mp, 
    const MeshTriPoint & start, const MeshTriPoint & end, const VertBitSet* vertRegion = nullptr,
    VertScalars * outSurfaceDistances = nullptr );
 
struct ComputeSteepestDescentPathSettings
{
    MeshTriPoint end;
    VertId * outVertexReached = nullptr;
    EdgePoint * outBdReached = nullptr;
};
 
[[nodiscard]] MRMESH_API SurfacePath computeSteepestDescentPath( const MeshPart & mp, const VertScalars & field,
    const MeshTriPoint & start, const ComputeSteepestDescentPathSettings & settings = {} );
 
MRMESH_API void computeSteepestDescentPath( const MeshPart & mp, const VertScalars & field,
    const MeshTriPoint & start, SurfacePath * outPath, const ComputeSteepestDescentPathSettings & settings = {} );
 
[[nodiscard]] MRMESH_API MeshEdgePoint findSteepestDescentPoint( const MeshPart & mp, const VertScalars & field, VertId v );
 
[[nodiscard]] MRMESH_API MeshEdgePoint findSteepestDescentPoint( const MeshPart & mp, const VertScalars & field, const MeshEdgePoint & ep );
 
[[nodiscard]] MRMESH_API MeshEdgePoint findSteepestDescentPoint( const MeshPart & mp, const VertScalars & field, const MeshTriPoint & tp );
 
enum class ExtremeEdgeType
{
    Ridge, // where the field not-increases both in left and right triangles
    Gorge  // where the field not-decreases both in left and right triangles
};
 
[[nodiscard]] MRMESH_API UndirectedEdgeBitSet findExtremeEdges( const Mesh & mesh, const VertScalars & field, ExtremeEdgeType type );
 
MRMESH_API HashMap<VertId, VertId> computeClosestSurfacePathTargets( const Mesh & mesh,
    const VertBitSet & starts, const VertBitSet & ends, const VertBitSet * vertRegion = nullptr,
    VertScalars * outSurfaceDistances = nullptr );
 
MRMESH_API SurfacePaths getSurfacePathsViaVertices( const Mesh & mesh, const VertBitSet & vs );
 
MRMESH_API float surfacePathLength( const Mesh& mesh, const SurfacePath& surfacePath );
 
MRMESH_API Contour3f surfacePathToContour3f( const Mesh & mesh, const SurfacePath & line );
MRMESH_API Contours3f surfacePathsToContours3f( const Mesh & mesh, const SurfacePaths & lines );
 
 
} // namespace MR