SLine.h

 
 
 
 
#pragma once
 
#include "RshPluginScript/RshPluginScriptDefines.h"
#include "RshPluginScript/SClass/SFeature.h"
 
#ifndef FCT_DOC
namespace rsh::ScriptBinding
{
#endif // !FCT_DOC
 
class SLine : public SFeature
{
    //======================================================================================================================
    //                                       INTERNAL FUNCTION
    //======================================================================================================================
 
    //======================================================================================================================
    //                                      DOCUMENTED FUNCTION
    //======================================================================================================================
 
public slots: // these functions (slots) will be available in QtScript
 
    // TESTED
    SPoint GetFirstPoint() ;
    // TESTED
    SPoint GetLastPoint() ;
    // TESTED
    Number GetLength() ;
    // TESTED
     SetLength(Number iLength);
 
    // TESTED
    Number GetPerimeter() ;
 
    // TESTED
    Array Discretize(
        Number deflection, 
        Number meanPointDistance
    ) ;
 
    // TESTED
    Number Distance(SPoint iPoint 
    ) ;
 
    // @retval Array.ErrorCode The error code.
    // 0    OK, no error
    // 1    An exception occurred
    // 2    Invalid list of component or bad or incomplete initialization or impossible to initialize.
    // 3    Objects are too far from each other: impossible to make bestfit.
    // @retval Array.Line The computed line.
    Array BestRevolutionAxis(SComp iSelComp);
 
    Array IntersectionBetween2Lines(SLine iSecondLine 
    );
 
    String toString() ;
};
 
// @brief
// This class allows to wrap static functions to SLine easily.
// This allow to wrap constructor more easily : the constructor will be declared with the function New(...)
class SLine
#ifndef FCT_DOC
    : public SObjectStatic
#endif // FCT_DOC
{
    //======================================================================================================================
    //                                       INTERNAL FUNCTION
    //======================================================================================================================
 
    //======================================================================================================================
    //                                      DOCUMENTED FUNCTION
    //======================================================================================================================
public slots:
    // TESTED
    static SLine New();
 
    // TESTED
    static SLine New(SLine Other);
 
    // TESTED
    static SLine New(
        SPoint Center, 
         SVector Normal, 
        Number Length 
    );
 
    // TESTED
    static SLine New(
        SPoint Point1, 
        SPoint Point2 
    );
 
    static Array FromClick() { return SComp::GetFromClick<SLine>(SV_LINE); }
 
    // TESTED
    static Array FromName( String Name) { return SComp::GetFromName<SLine>(Name); }
 
    // TESTED
    static Array FromSel() { return SFeature::GetFromSel<SLine>(); }
 
    // TESTED
    static Array All(
        Number VisCrit
    )
    {
        return SComp::GetAll<SLine>(VisCrit);
    }
 
    static String toString();
};
Q_DECLARE_METATYPE(SLine::_SLineDummy);
Q_DECLARE_METATYPE(SLine);
 
#ifndef FCT_DOC
} // namespace rsh::ScriptBinding
#endif // !FCT_DOC