SMultiLine.h

 
 
 
 
#pragma once
 
#include "RshPluginScript/RshPluginScriptDefines.h"
#include "RshGeometry/Old/RshScanner.h"
#include "RshPluginScript/SClass/SComp.h"
 
#ifndef FCT_DOC
namespace rsh::ScriptBinding
{
#endif // !FCT_DOC
 
class SMultiline : public SComp
{
    //======================================================================================================================
    //                                       INTERNAL FUNCTION
    //======================================================================================================================
 
    //======================================================================================================================
    //                                      DOCUMENTED FUNCTION
    //======================================================================================================================
public:
    enum MultilineRepresentationTypeEnum
    {
        // representations which are always available
        MULTILINE_SEGMENTS, // only segments are displayed
        MULTILINE_VERTICES, // segments and vertices are displayed
        MULTILINE_INSPECTION, // Colors ares based on an inspection value on each point.
        // only available if the polyline contains inspection information
 
    };
 
 
    enum OffsetSideEnum
    {
        OTHER_SIDE, // The side where point is not.
        SAME_SIDE// The side where point is.
    };
 
    enum SmoothEnum
    {
        SMOOTH_TYPE1, // order 1 filter. Very smooth filter. The small radii are becoming greater.
        SMOOTH_TYPE2, // order 2 filter. More complex filter based on first derivative that allows to limit
        // as much as possible increasing the radii.
        SMOOTH_BSPLINE// B-spline smoothing.
    };
 
    enum RepairAutoIntersectionPolicyEnum
    {
        SUPPRESS_SMALL_LOOPS_FIRST, // The suppression is done by suppressing from the smallest to the longest auto-intersection loops.
        SUPPRESS_LONG_LOOPS_FIRST, // The suppression is done by suppressing from the longest to the smallest auto-intersection loops.
        SUPPRESS_IN_VERTEX_ORDER// The suppression is done in the order we find them by browsing from the 1st to the last vertex.
    };
 
public slots: // these functions (slots) will be available in QtScript
 
 
    String toString() ;
 
    // TESTED
    Array InsertFirst(
        SPoint iPointToCopy, 
        Number AbsoluteAccuracy
    );
 
    // TESTED
    Array InsertLast(
        SPoint iPointToCopy, 
        Number AbsoluteAccuracy
    );
 
    // TESTED
    Number GetNumber() ;
 
    // TESTED
    Boolean IsClosed() ;
 
    // TESTED
    Boolean IsPlanar() ;
 
    // TESTED
    SPoint GetPoint(unsigned Index);
 
    // TESTED
    Array GetPointAtDistance(
        Number DistanceToOrigin, 
        Boolean InterpolateOnSegments
    );
 
    // TESTED
    Number GetLength() ;
 
    // TESTED
    SPoint GetCentroidLinear();
 
    // TESTED
    Array GetNormal() ;
 
    // TESTED
    Array IntersectionWithPlane(SPlane iPlane 
    );
 
    // TESTED
    Array IntersectionWithOtherPlanarMulti(SMultiline iMulti 
    );
 
    // TESTED
    Array IntersectionWithMesh(SPoly iPoly 
    );
 
    // TESTED
      Clear() ;
 
    // TESTED
     Close();
 
    // TESTED
    Array CloseWithCurvedJunction(
        Number nPoints, 
        Boolean makePlanarJunction
    );
 
    // TESTED
    Array Smooth(
        Number Para1, 
        Number SmoothIntens, 
        SmoothEnum SmoothingType, 
        Number MaxiDeviation 
    );
 
    // TESTED
    Array Offset(
         SVector Direction, 
        Number DistOffset, 
        OffsetSideEnum GoodSide, 
        SPoint iSidePt 
    ) ;
 
    // TESTED
    Array Compare(
        SMultiline iMeasuredMulti, 
        Number DistMax, 
         SVector
            ProjectionDir = {}, 
        Number MappingObject, 
        Boolean IgnoreEdge, 
        Boolean PtToPt, 
        Boolean InPlane
    );
 
    // TESTED
     AddArrows(
        Number NbArrow, 
        Number Position 
    );
 
    // TESTED
     AddArrows(
        Boolean Reverse
    );
 
    // TESTED
     Reverse();
 
    // TESTED
    Array Reduce(
        unsigned NbPoint, 
        Number MaxDeviation, 
        Boolean OptimizePosition
    );
 
    // TESTED
    Array RightAngle(Number Threshold 
    );
 
    Array Save(
        String FilePath, 
        SMatrix CoordinateSystemMatrix = {}
    );
 
    // TESTED
     SetLineWidth(Number width 
    );
 
    Array GetColorGradient() { return SComp::GetColorGradient(); }
 
    Array LoadColorGradient(String FilePath 
    )
    {
        return SComp::LoadColorGradient(FilePath);
    }
 
    Array SaveColorGradient(String FilePath 
    )
    {
        return SComp::SaveColorGradient(FilePath);
    }
 
    Array ClosestPoint(SPoint iPoint 
    );
 
    Array Proj3D(SPoint iPoint 
    ) ;
 
    Array ProjDir(
        SPoint iThePnt, 
         SVector ProjDir, 
        Number Aperture 
    ) ;
 
    Number GetArea( SVector ProjDir 
    ) ;
 
    Array MultilineArea( SVector iProjDir) ;
 
    // TESTED
    Array GetDeviation(Number iIndex 
    ) ;
 
    // TESTED
    Array GetDeviations() ;
 
    // TESTED
     SetMultilineRepresentation(MultilineRepresentationTypeEnum Representation 
    );
 
    Array GetAutoIntersections(
        Number iLenghtTol 
    );
 
    Array RepairAutoIntersections(
        Number iLengthTol, 
        Number iLoopMaxLength =
            -1, 
        RepairAutoIntersectionPolicyEnum iPolicy
    );
 
    Array SuppressSmallLines(
        Number iLengthTol 
    );
 
    // TESTED
     ShowName(Boolean iShowName 
    );
};
 
// @brief
// this class allow to wrap static function to SMultiline easily
// this allow to wrap constructor more easily the constructor will be declared with the function New(...)
class SMultiline
#ifndef FCT_DOC
    : public SObjectStatic
#endif // FCT_DOC
{
    //======================================================================================================================
    //                                       INTERNAL FUNCTION
    //======================================================================================================================
    //======================================================================================================================
    //                                      DOCUMENTED FUNCTION
    //======================================================================================================================
public slots:
    // TESTED
    static SMultiline New();
 
    // TESTED
    static SMultiline New(SMultiline iOther);
 
    static Array FromClick() { return SComp::GetFromClick<SMultiline>(SV_MULTI); }
 
    // TESTED
    static Array FromName( String Name) { return SComp::GetFromName<SMultiline>(Name); }
 
    // TESTED
    static Array FromSel();
 
    // TESTED
    static Array All(
        Number VisCrit
    )
    {
        return SComp::GetAll<SMultiline>(VisCrit);
    }
 
    // TESTED
    Array FromFile(String FileName 
    );
 
    // TESTED
    static Array Chain(
         Array<SMultiline> TableLine, 
        Number MaxiSegmentLength, 
        Number Accuracy, 
        Boolean Close
    );
 
    static Array Cut(SMultiline TheSelEdge, SPoint iPoint);
 
    static Array CurvedJunction(
        SMultiline iFirstMultiline, 
        SMultiline iSecondMultiline, 
        Number nPoints, 
        Boolean makePlanarJunction, 
        Boolean chainWithInput
    );
 
    // TESTED
    static Array MedianLine(
         Array<SMultiline> TableMulti, 
        Number NbPt
    );
 
    static String toString();
 
    static Array MultilinesIntersections(
         Array<SMultiline>
            TableMulti, 
        Number DesiredAccuracy 
    );
};
Q_DECLARE_METATYPE(SMultiline::_SMultilineDummy);
Q_DECLARE_METATYPE(SMultiline);
 
#ifndef FCT_DOC
} // namespace rsh::ScriptBinding
#endif // !FCT_DOC
 
#ifndef FCT_DOC
namespace rsh::Script::ScriptConvert
{
template<>
struct TblConvert<SMultiline>
{
    static  char GetClassName() { return "SMultiline"; }
 
    typedef rsh::ScriptBinding::SMultiline ScriptClass;
    typedef SMultiline DCompClass;
 
    static SMultiline GetGCompClass(SMultiline _iCompClass)
    {
        return _iCompClass.GetGMultiLine();
    }
 
    static SMultiline ForDCompConstructor(SMultiline _iEnt) { return _iEnt; }
};
#endif
}