SCircle.h

 
 
 
 
#pragma once
 
#include "RshPluginScript/RshPluginScriptDefines.h"
#include "RshPluginScript/SClass/SFeature.h"
 
#ifndef FCT_DOC
namespace rsh::ScriptBinding
{
#endif // !FCT_DOC
 
class SCircle : public SFeature
{
    //======================================================================================================================
    //                                       INTERNAL FUNCTION
    //======================================================================================================================
 
    //======================================================================================================================
    //                                      DOCUMENTED FUNCTION
    //======================================================================================================================
 
public slots: // these functions (slots) will be available in QtScript
 
    // TESTED
    Number GetRadius() ;
 
    // TESTED
     SetRadius(Number Radius 
    );
 
    // TESTED
    Number GetPerimeter() ;
 
    // TESTED
    Array Discretize(
        Number deflection, 
        Number meanPointDistance
    ) ;
 
    // TESTED
    Number Distance(
        SPoint iPoint, 
        Boolean iCalcIn3D
    ) ;
 
    String toString() ;
};
 
// @brief
// This class allows to wrap static functions to SCircle easily.
// This allow to wrap constructor more easily : the constructor will be declared with the function New(...)
class SCircle
#ifndef FCT_DOC
    : public SObjectStatic
#endif // FCT_DOC
{
    //======================================================================================================================
    //                                       INTERNAL FUNCTION
    //======================================================================================================================
 
    //======================================================================================================================
    //                                      DOCUMENTED FUNCTION
    //======================================================================================================================
public slots:
    // TESTED
    static SCircle New();
 
    // TESTED
    static SCircle New(SCircle Other);
 
    // TESTED
    static SCircle New(
        SPoint Center, 
         SVector Normal, 
        Number Radius 
    );
 
    static SCircle New(
        SLine tang1, 
        SLine tang2, 
        SPoint Pt, 
        Boolean LargeQ
    );
 
    SCircle NewC(SCloud inCloud);
 
    // TESTED
    static SCircle New(
        SPoint FirstPt, 
        SPoint SecondPt, 
        SPoint ThirdPt 
    );
 
    static Array FromClick() { return SComp::GetFromClick<SCircle>(SV_CIRCLE); }
 
    // TESTED
    static Array FromName( String Name) { return SComp::GetFromName<SCircle>(Name); }
 
    // TESTED
    static Array FromSel() { return SFeature::GetFromSel<SCircle>(); }
 
    // TESTED
    static Array All(
        Number VisCrit
    )
    {
        return SComp::GetAll<SCircle>(VisCrit);
    }
 
    static String toString();
};
Q_DECLARE_METATYPE(SCircle::_SCircleDummy);
Q_DECLARE_METATYPE(SCircle);
 
#ifndef FCT_DOC
} // namespace rsh::ScriptBinding
#endif // !FCT_DOC