SSquareSlot.h

 
 
 
 
#pragma once
 
#include "RshPluginScript/RshPluginScriptDefines.h"
#include "RshPluginScript/SClass/SFeature.h"
 
#ifndef FCT_DOC
namespace rsh::ScriptBinding
{
#endif // !FCT_DOC
 
class SSquareSlot : public SFeature
{
    //======================================================================================================================
    //                                       INTERNAL FUNCTION
    //======================================================================================================================
 
    //======================================================================================================================
    //                                      DOCUMENTED FUNCTION
    //======================================================================================================================
 
public slots: // these functions (slots) will be available in QtScript
 
    // TESTED
    Number GetLength() ;
    // TESTED
     SetLength(Number iLength);
    // TESTED
    Number GetWidth() ;
    // TESTED
     SetWidth(Number iWidth);
    SVector GetXDir() ;
    Number SetXDir( SVector iNewXDir);
    SVector GetYDir() ;
 
    // TESTED
    Number GetPerimeter() ;
 
    // TESTED
    Array Discretize(
        Number deflection, 
        Number meanPointDistance
    ) ;
 
    // TESTED
    Number Distance(
        SPoint iPoint, 
        Boolean CalcIn3D
    ) ;
 
    String toString() ;
};
 
// @brief
// This class allows to wrap static functions to SSquareSlot easily.
// This allow to wrap constructor more easily : the constructor will be declared with the function New(...)
class SSquareSlot
#ifndef FCT_DOC
    : public SObjectStatic
#endif // FCT_DOC
{
    //======================================================================================================================
    //                                       INTERNAL FUNCTION
    //======================================================================================================================
 
    //======================================================================================================================
    //                                      DOCUMENTED FUNCTION
    //======================================================================================================================
public slots:
    // TESTED
    static SSquareSlot New();
 
    // TESTED
    static SSquareSlot New(SSquareSlot Other);
 
    // TESTED
    static SSquareSlot New(
        SPoint Center, 
         SVector Normal, 
         SVector XDir, 
         Number Length, 
         Number Width 
    );
 
    // TESTED
    static SSquareSlot New(
        SPoint FirstPt, 
        SPoint SecondPt, 
        SPoint ThirdPt 
    );
 
    static Array FromClick() { return SComp::GetFromClick<SSquareSlot>(SV_SQUARE_SLOT); }
 
    // TESTED
    static Array FromName( String Name) { return SComp::GetFromName<SSquareSlot>(Name); }
 
    // TESTED
    static Array FromSel() { return SFeature::GetFromSel<SSquareSlot>(); }
 
    // TESTED
    static Array All(
        Number VisCrit
    )
    {
        return SComp::GetAll<SSquareSlot>(VisCrit);
    }
 
    static String toString();
};
Q_DECLARE_METATYPE(SSquareSlot::_SSquareSlotDummy);
Q_DECLARE_METATYPE(SSquareSlot);
 
#ifndef FCT_DOC
} // namespace rsh::ScriptBinding
#endif // !FCT_DOC