SSetMultiline.h

 
 
 
 
#pragma once
 
#include "RshPluginScript/RshPluginScriptDefines.h"
#include "RshGeometry/Math/Algebra/Matrix.h"
#include "RshPluginScript/SClass/SComp.h"
#include "RshPluginScript/SClass/SMultiLine.h"
 
#ifndef FCT_DOC
namespace rsh::ScriptBinding
{
#endif // !FCT_DOC
 
class SSetMultiline : public SComp
{
    //======================================================================================================================
    //                                       INTERNAL FUNCTION
    //======================================================================================================================
 
    //======================================================================================================================
    //                                      DOCUMENTED FUNCTION
    //======================================================================================================================
public:
    enum SetMultilineRepresentationTypeEnum
    {
        // representations which are always available
        SETMULTILINE_SEGMENTS, // only segments are displayed
        SETMULTILINE_VERTICES, // segments and vertices are displayed
        SETMULTILINE_INSPECTION, // Colors ares based on an inspection value on each point.
        // only available if the polyline contains inspection information
 
    };
 
    enum ExternalContourOptionEnum
    {
        EXTERNAL_2D_CALCULATION, // Calculate a 2D contour
        EXTERNAL_3D_CALCULATION, // Calculate a 3D contour
    };
 
public slots: // these functions (slots) will be available in QtScript
 
    // TESTED
    Array Explode() ;
 
    Array Save(
        String FilePath, 
        SMatrix CoordinateSystemMatrix = {}
    );
 
     SetLineWidth(Number width 
    );
 
     SetSetMultilineRepresentation(SetMultilineRepresentationTypeEnum Representation 
    );
 
    // TESTED
    Array ExternalContour(
        ExternalContourOptionEnum CalculationOption 
    ) ;
 
    String toString() ;
 
     ShowName(Boolean iShowName 
    );
};
 
// @brief
// This class allows to wrap static functions to SSetMultiline easily.
// This allow to wrap constructor more easily : the constructor will be declared with the function New(...)
class SSetMultiline
#ifndef FCT_DOC
    : public SObjectStatic
#endif // FCT_DOC
{
    //======================================================================================================================
    //                                       INTERNAL FUNCTION
    //======================================================================================================================
 
    //======================================================================================================================
    //                                      DOCUMENTED FUNCTION
    //======================================================================================================================
public slots:
    // TESTED
    static SSetMultiline New();
 
    // TESTED
    static SSetMultiline New( Array<SMultiline>
                                                TheMultiTable 
    );
 
    static Array FromClick() { return SComp::GetFromClick<SSetMultiline>(SV_SET_MULTI); }
 
    // TESTED
    static Array FromName( String Name) { return SComp::GetFromName<SSetMultiline>(Name); }
 
    // TESTED
    static Array FromSel();
 
    // TESTED
    static Array All(
        Number VisCrit
    )
    {
        return SComp::GetAll<SSetMultiline>(VisCrit);
    }
 
    static String toString();
};
Q_DECLARE_METATYPE(SSetMultiline::_SSetMultilineDummy);
Q_DECLARE_METATYPE(SSetMultiline);
 
#ifndef FCT_DOC
} // namespace rsh::ScriptBinding
#endif // !FCT_DOC