MROffsetContours.h

Go to the documentation of this file.

#pragma once
#include "MRMeshFwd.h"
#include "MRConstants.h"
#include "MRExpected.h"
#include <functional>
#include <string>
 
namespace MR
{
 
struct OffsetContourIndex
{
    // -1 means unknown index
    int contourId{ -1 };
    // -1 means unknown index
    int vertId{ -1 };
    bool valid() const { return contourId >= 0 && vertId >= 0; }
};
 
struct OffsetContoursOrigins
{
    // Should be always valid
    // index of lower corresponding origin point on input contour
    OffsetContourIndex lOrg;
    // index of lower corresponding destination point on input contour
    OffsetContourIndex lDest;
    // index of upper corresponding origin point on input contour
    OffsetContourIndex uOrg;
    // index of upper corresponding destination point on input contour
    OffsetContourIndex uDest;
 
    // ratio of intersection point on lOrg->lDest segment
    // 0.0 -> lOrg
    // 1.0 -> lDest
    float lRatio{ 0.0f };
    // ratio of intersection point on uOrg->uDest segment
    // 0.0 -> uOrg
    // 1.0 -> uDest
    float uRatio{ 0.0f };
 
    bool valid() const { return lOrg.valid(); }
    bool isIntersection() const { return lDest.valid(); }
};
using OffsetContoursVertMap = std::vector<OffsetContoursOrigins>;
using OffsetContoursVertMaps = std::vector<OffsetContoursVertMap>;
 
struct OffsetContoursParams
{
    enum class Type
    {
        Offset, 
        Shell 
    } type{ Type::Offset };
 
    enum class EndType
    {
        Round, 
        Cut 
    } endType{ EndType::Round };
 
    enum class CornerType
    {
        Round, 
        Sharp 
    } cornerType{ CornerType::Round };
 
    float minAnglePrecision = PI_F / 9.0f; // 20 deg
    float maxSharpAngle = PI_F * 2.0f / 3.0f; // 120 deg
 
    OffsetContoursVertMaps* indicesMap = nullptr;
};
 
[[nodiscard]] MRMESH_API Expected<Contours2f> offsetContours( const Contours2f& contours, float offset,
    const OffsetContoursParams& params = {} );
 
 
using ContoursVariableOffset = std::function<float( int, int )>;
[[nodiscard]] MRMESH_API Expected<Contours2f> offsetContours( const Contours2f& contours, 
    ContoursVariableOffset offset, const OffsetContoursParams& params = {} );
 
struct OffsetContoursRestoreZParams
{
    using OriginZCallback = std::function<float( const Contours2f& offsetCont, const OffsetContourIndex& offsetIndex, const OffsetContoursOrigins& origingContourMapoing)>;
    OriginZCallback zCallback;
    int relaxIterations = 1;
};
 
[[nodiscard]] MRMESH_API Expected<Contours3f> offsetContours( const Contours3f& contours, float offset,
    const OffsetContoursParams& params = {}, const OffsetContoursRestoreZParams& zParmas = {} );
 
[[nodiscard]] MRMESH_API Expected<Contours3f> offsetContours( const Contours3f& contours,
    ContoursVariableOffset offset, const OffsetContoursParams& params = {}, const OffsetContoursRestoreZParams& zParmas = {} );
 
}