MRAggregateFlow.h

Go to the documentation of this file.

#pragma once
 
#include "MRMeshTriPoint.h"
#include "MRVector.h"
#include "MRPolyline.h"
#include <functional>
 
namespace MR
{
 
struct FlowOrigin
{
    MeshTriPoint point;
    float amount = 1;
};
 
struct OutputFlows
{
    Polyline3* pPolyline = nullptr;
    UndirectedEdgeScalars* pFlowPerEdge = nullptr;
    float amountGreaterThan = 0;
};
 
class FlowAggregator
{
public:
    MRMESH_API FlowAggregator( const Mesh & mesh, const VertScalars & heights );
 
    MRMESH_API VertScalars computeFlow( const std::vector<FlowOrigin> & starts, const OutputFlows & out = {} ) const;
    // same with all amounts equal to 1
    MRMESH_API VertScalars computeFlow( const std::vector<MeshTriPoint> & starts, const OutputFlows & out = {} ) const;
    // general version that supplies starts in a functional way
    MRMESH_API VertScalars computeFlow( size_t numStarts,
        const std::function<MeshTriPoint(size_t)> & startById, 
        const std::function<float(size_t)> & amountById,
        const std::function<const FaceBitSet*(size_t)> & regionById, 
        const OutputFlows & out = {} ) const;
 
    struct Flows
    {
        Polyline3 polyline;
        UndirectedEdgeScalars flowPerEdge;
    };
 
    MRMESH_API HashMap<VertId, Flows> computeFlowsPerBasin( const std::vector<FlowOrigin> & starts ) const;
    // same with all amounts equal to 1
    MRMESH_API HashMap<VertId, Flows> computeFlowsPerBasin( const std::vector<MeshTriPoint> & starts ) const;
    // general version that supplies starts in a functional way
    MRMESH_API HashMap<VertId, Flows> computeFlowsPerBasin( size_t numStarts,
        const std::function<MeshTriPoint(size_t)> & startById, 
        const std::function<float(size_t)> & amountById ) const;
 
    [[nodiscard]] MRMESH_API UndirectedEdgeBitSet computeCatchmentDelineation() const;
 
private:
    const Mesh & mesh_;
    const VertScalars & heights_;
    VertMap downFlowVert_; // for each vertex stores what next vertex is on flow path (invalid vertex for local minima)
    VertMap rootVert_;     // for each vertex stores the final vertex is on flow path (self-vertex for local minima)
    Vector<SurfacePath, VertId> downPath_; // till next vertex
    std::vector<VertId> vertsSortedDesc_; // all vertices sorted in descending heights order
};
 
} //namespace MR