SPoint.h

 
 
 
 
#pragma once
 
#include "RshPluginScript/RshPluginScriptDefines.h"
#include "RshPluginScript/SClass/SComp.h"
 
#ifndef FCT_DOC
namespace rsh::ScriptBinding
{
#endif // !FCT_DOC
 
class SPoint : public SComp
{
    //======================================================================================================================
    //                                       INTERNAL FUNCTION
    //======================================================================================================================
 
 
    //======================================================================================================================
    //                                      DOCUMENTED FUNCTION
    //======================================================================================================================
 
public slots: // These functions (slots) will be available in QtScript
    // TESTED
     Number GetX() ;
    // TESTED
      SetX(Number X);
 
    // TESTED
     Number GetY() ;
    // TESTED
      SetY(Number Y);
 
    // TESTED
     Number GetZ() ;
    // TESTED
      SetZ(Number Z);
 
    // TESTED
    Number Distance(SPoint iPtToCompare);
 
    // TESTED
    Boolean Equals(SPoint iPtToCompare) ;
 
    // TESTED
    SPoint Add(SPoint iPtToAdd);
 
    // TESTED
    SPoint Sub(SPoint iPtToSub);
 
    // TESTED
    SPoint Div(Number Scalar);
 
    // TESTED
    SPoint Mult(Number Scalar);
 
     SetPointSize(Number pointSize 
    );
 
    Number GetPointSize();
 
    String toString() ;
 
     ShowName(Boolean iShowName 
    );
 
    String ValuesToString() ;
};
 
// @brief
// this class allow to wrap static function to SPoint easily
// this allow to wrap constructor more easily the constructor will be declared with the function New(...)
class SPoint
#ifndef FCT_DOC
    : public SObjectStatic
#endif // FCT_DOC
{
    //======================================================================================================================
    //                                       INTERNAL FUNCTION
    //======================================================================================================================
 
    //======================================================================================================================
    //                                      DOCUMENTED FUNCTION
    //======================================================================================================================
 
public slots:
    static SPoint New();
 
    // TESTED
    static SPoint New(SPoint Other);
 
    // TESTED
    static SPoint New(
        Number X, 
        Number Y, 
        Number Z 
    );
 
    static Array FromClick();
 
    // TESTED
    static Array FromName( String Name) { return SComp::GetFromName<SPoint>(Name); }
 
    // TESTED
    static Array FromSel();
 
    // TESTED
    static Array All(
        Number iVisCrit
    );
 
    // TESTED
    static Array FromFile(String FileName 
    );
 
    // TESTED
    static Array Save(
        String FilePath, 
         Array<SPoint> PointsToSave, 
        SMatrix CoordinateSystemMatrix = {}
    );
 
    static String toString();
};
 
Q_DECLARE_METATYPE(SPoint::_SPointDummy);
Q_DECLARE_METATYPE(SPoint);
 
#ifndef FCT_DOC
} // namespace rsh::ScriptBinding
#endif // !FCT_DOC
 
#ifndef FCT_DOC
namespace rsh::Script::ScriptConvert
{
template<>
struct TblConvert<SPoint>
{
    static  char GetClassName() { return "SPoint"; } // return the name of the script class mapped with
 
    typedef SPoint ScriptClass; 
    typedef SPoint DCompClass;
 
    static GPointComp GetGCompClass(SPoint _iCompClass)
    {
        return _iCompClass.Point;
    } // return the SComp from the SComp _iCompClass
 
    static  SPoint ForDCompConstructor(SPoint _iEnt)
    {
        return _iEnt;
    } // return the correct SComp to create a new SComp
};
#endif
}