SLabel.h

 
 
 
 
#pragma once
 
#include "RshPluginScript/RshPluginScriptDefines.h"
#include "RshPluginScript/SClass/SComp.h"
#include <QtCore/QVariant>
 
#ifndef FCT_DOC
namespace rsh::ScriptBinding
{
#endif // !FCT_DOC
 
class SLabel : public SComp
{
    //======================================================================================================================
    //                                       INTERNAL FUNCTION
    //======================================================================================================================
 
    //======================================================================================================================
    //                                      DOCUMENTED FUNCTION
    //======================================================================================================================
public:
    enum SLabelCol
    {
 
        Reference,
        Measure,
        Deviation,
        TolMin,
        TolMax,
        Note,
        Flushing,
        EmptyCol,
        Nominal,
        BBoxMin,
        BBoxMax,
        Size,
        Centroid,
        LowestPoint,
        UppestPoint,
        Count,
 
        UndefinedCol,
 
        LastColType
    };
 
    enum SLabelLine
    {
 
        XX,
        YY,
        ZZ,
        NormalX,
        NormalY,
        NormalZ,
        Radius,
        Diameter,
        Angle,
        Circularity,
        Cylindricity,
        Planeity,
        Distance,
        AngleX,
        AngleY,
        AngleZ,
        AngleCompX,
        AngleCompY,
        AngleCompZ,
        AngleSuppX,
        AngleSuppY,
        AngleSuppZ,
        AngleC,
        AngleS,
        Dev3D,
        Curv,
        EmptyLine,
        Length,
        Width,
        Linearity,
        Sphericity,
        DistanceXY,
        DistanceYZ,
        DistanceXZ,
        DistanceX,
        DistanceY,
        DistanceZ,
        Volume,
        Intensity,
        VolumeOver,
        VolumeUnder,
        Perpendicularity,
        Parallelism,
        Level,
        Surface,
        NbPoints,
        NbTriangles,
        NbPieces,
        NbFreeCont,
 
        UndefinedLine,
 
        Flatness, 
        LastLineType
    };
 
 
public slots: // these functions (slots) will be available in QtScript
 
     AttachToPoint(SPoint iAttachedPoint);
 
     SetComment( String Comment);
 
     ShowComment(Boolean iShowComment);
 
    Array SetCell(
        Number IdxLin, 
        Number IdxCol, 
        Number Value 
    );
 
    Array GetCell(
        Number IdxLin, 
        Number IdxCol 
    ) ;
 
    Array SetLine(
        Number IdxLin, 
        Array<Number> ValueTbl 
    );
 
    Array GetLine(Number IdxLin 
    ) ;
 
    Array SetCol(
        Number IdxCol, 
        Array<Number> ValueTbl 
    );
 
    Array GetCol(Number IdxCol 
    ) ;
 
    Array GetColByType(SLabelCol ColType 
    ) ;
 
    Array SetColType(Array<
#ifndef FCT_DOC
                            QVariant
#else
                            SLabelCol
#endif
                            > ColType 
    );
 
    Array GetLineByType(SLabelLine LineType 
    ) ;
 
    Array SetLineType(Array<
#ifndef FCT_DOC
                             QVariant
#else
                             SLabelLine
#endif
                             > LineType 
    );
 
     SetTolerance(
        Number LowTol, 
        Number UpperTol 
    );
 
     AddSComp( Array<SComp> tblSComp 
    );
 
    String GetComment() ;
 
    Array SetVisibleRow(
        Number RowIndex, 
        Boolean IsVisible 
    );
 
    Array SetVisibleColumn(
        Number ColumnRowIndex, 
        Boolean IsVisible 
    );
 
    String toString() ;
 
};
 
// @brief
// this class allow to wrap static function to SLabel easily
// this allow to wrap constructor more easily the constructor will be declared with the function New(...)
class SLabel
#ifndef FCT_DOC
    : public SObjectStatic
#endif // FCT_DOC
{
    //======================================================================================================================
    //                                       INTERNAL FUNCTION
    //======================================================================================================================
 
    //======================================================================================================================
    //                                      DOCUMENTED FUNCTION
    //======================================================================================================================
 
public:
    enum SLabelType
    {
 
        LONG, 
        MEDIUM, 
        SMALL,
        MINIMUM, 
        LastLabelType 
    };
 
    enum SLabelBackgroundType
    {
 
        NO_BACKGROUND, 
        SCENE_BACKGROUND_COLOR, 
        SPECIAL_COLOR, 
        TOLERANCE_COLOR, 
        LastBackgroundType 
    };
 
 
public slots:
    // TESTED
    static SLabel New(
        Number NbLin, 
        Number NbCol 
    );
 
    // TESTED
    static SLabel New(SLabel iOther);
 
    static Array FromClick() { return SComp::GetFromClick<SLabel>(SV_LABEL); }
 
    static Array FromName( String Name) { return SComp::GetFromName<SLabel>(Name); }
 
    // TESTED
    static Array FromSel();
 
    // TESTED
    static Array All(
        Number VisCrit
    )
    {
        return SComp::GetAll<SLabel>(VisCrit);
    }
 
    static  SetSizeType(SLabelType LabelType);
 
    static  SetBackgroundType(SLabelBackgroundType BackgroundType 
                                  // SLabel.NO_BACKGROUND, // No label background
                                  // SLabel.SPECIAL_COLOR, // Use defined color (take a look to SetBackgroundColor())
    );
 
    static  SetBackgroundColor(
        Number Red, 
        Number Green, 
        Number Blue, 
        Number Transparency 
    );
 
    static  SetLineColor(
        Number Red, 
        Number Green, 
        Number Blue 
    );
 
    static  SetDecimalNumber(Number NbDecimal 
    );
 
    static  UseEngineeringNotation(Boolean Use 
    );
 
    static String toString();
};
Q_DECLARE_METATYPE(SLabel::_SLabelDummy);
Q_DECLARE_METATYPE(SLabel);
 
#ifndef FCT_DOC
} // namespace rsh::ScriptBinding
#endif // !FCT_DOC