SGeneral.h

 
 
 
 
#pragma once
 
#include "RshPluginScript/RshPluginScriptDefines.h"
#include <QtScript/QScriptEngine>
 
#ifndef FCT_DOC
namespace rsh::ScriptBinding
{
#endif // !FCT_DOC
 
namespace ScriptUtil
{
#ifndef FCT_DOC
class EnumsWrapper : public QObject
{
    Q_OBJECT;
    Q_ENUMS(ViewDirEnum);
    Q_ENUMS(ViewModeEnum);
    Q_ENUMS(SketchFabCategories);
 
public:
#endif
    //------------------------------------------------
    // the enum must be defined here
    //------------------------------------------------
 
    enum ViewDirEnum
    {
        AXIS_X, // view on X axis, Z is up
        AXIS_Y, // view on Y axis, Z is up
        AXIS_Z, // view on Z axis, Y is up
        AXIS_REVERSE_X, // view on -X axis, Z is up
        AXIS_REVERSE_Y, // view on -Y axis, Z is up
        AXIS_REVERSE_Z // view on -Z axis, Y is up
    };
 
    enum ViewModeEnum
    {
        PERSPECTIVE, // To use the perspective view
        ORTHOGRAPHIC // To use the orthographic view
    };
 
    // Set of categories names, to send in SketchFab
    enum SketchFabCategories
    {
        Animals_Pets,
        Architecture,
        Art_Abstract,
        Cars_Vehicles,
        Characters_Creatures,
        Cultural_Heritage_History,
        Electronic_Gadgets,
        Fashion_Style,
        Food_Drink,
        Furniture_Home,
        Music,
        Nature_Plants,
        News_Politics,
        People,
        Places_Travel,
        Science_Technology,
        Sports_Fitness,
        Weapons_Military
    };
 
#ifndef FCT_DOC
 
public:
    EnumsWrapper(){};
    ~EnumsWrapper(){};
};
#endif
 
 
#ifdef FCT_DOC
 Sleep(Number Milliseconds 
);
#else
Array Sleep(
    QScriptContext ipContext, 
    QScriptEngine ipEngine 
);
#endif
 
#ifdef FCT_DOC
 Include(String FileName 
);
#else
Array Include(
    QScriptContext ipContext, 
    QScriptEngine ipEngine 
);
#endif
 
#ifdef FCT_DOC
Array OpenDoc(
    String FileName, 
    Boolean ClearDoc, 
    Boolean ApplyUnit
);
#else
// TESTED
Array OpenDoc(
    QScriptContext ipContext, 
    QScriptEngine ipEngine 
);
#endif
 
#ifdef FCT_DOC
Array OpenRsh(
    String FileName, 
    Boolean ClearDoc, 
    Boolean ApplyUnit
);
#else
// TESTED
Array OpenRsh(
    QScriptContext ipContext, 
    QScriptEngine ipEngine 
);
#endif
 
#ifdef FCT_DOC
Array SaveDoc(
    String FileName, 
    Boolean IsOverWrite 
);
#else
// NOT TESTED
Array SaveDoc(
    QScriptContext ipContext, 
    QScriptEngine ipEngine 
);
#endif
 
#ifdef FCT_DOC
Array SaveRsh(
    String FileName, 
    Boolean IsOverWrite 
);
#else
// NOT TESTED
Array SaveRsh(
    QScriptContext ipContext, 
    QScriptEngine ipEngine 
);
#endif
 
#ifdef FCT_DOC
 
Array SendToSketchFab(
     SComp CompToExport,
     String Token,
     String Name,
     String Description,
     String Tags,
    SketchFabCategories Category);
#else
Array SendToSketchFab(
    QScriptContext ipContext, 
    QScriptEngine ipEngine 
);
#endif
 
#ifdef FCT_DOC
String CurrentScriptPath();
#else
// TESTED
Array CurrentScriptPath(
    QScriptContext ipContext, 
    QScriptEngine ipEngine 
);
#endif
 
#ifdef FCT_DOC
String ScriptPath();
#else
// TESTED
Array ScriptPath(
    QScriptContext ipContext, 
    QScriptEngine ipEngine 
);
#endif
 
#ifdef FCT_DOC
String ApplicationPath();
#else
// TESTED
Array ApplicationPath(
    QScriptContext ipContext, 
    QScriptEngine ipEngine 
);
#endif
 
#ifdef FCT_DOC
String ToLocaleString(Number NumberToConvert);
#else
// TESTED
Array ToLocaleString(
    QScriptContext ipContext, 
    QScriptEngine ipEngine 
);
#endif
 
#ifdef FCT_DOC
Number ToLocaleNumber( String StringToConvert);
#else
// TESTED
Array ToLocaleNumber(
    QScriptContext ipContext, 
    QScriptEngine ipEngine 
);
#endif
 
#ifdef FCT_DOC
String GetOpenFileName(
     String Caption, 
     String Filter, 
     String DefaultPath = "" 
);
#else
// TESTED
Array GetOpenFileName(
    QScriptContext ipContext, 
    QScriptEngine ipEngine 
);
#endif
 
#ifdef FCT_DOC
QStringList GetOpenFileNames(
     String Caption, 
     String Filter, 
     String DefaultPath = "" 
);
#else
// TESTED
Array GetOpenFileNames(
    QScriptContext ipContext, 
    QScriptEngine ipEngine 
);
#endif
 
#ifdef FCT_DOC
String GetSaveFileName(
     String Caption, 
     String Filter, 
     String DefaultPath = "" 
);
#else
// TESTED
Array GetSaveFileName(
    QScriptContext ipContext, 
    QScriptEngine ipEngine 
);
#endif
 
#ifdef FCT_DOC
String GetOpenFolder(
     String Caption, 
     String DefaultPath = "" 
);
#else
// TESTED?
Array GetOpenFolder(
    QScriptContext ipContext, 
    QScriptEngine ipEngine 
);
#endif
 
#ifdef FCT_DOC
Boolean OpenUrl( String Url);
#else
// TESTED
Array OpenUrl(
    QScriptContext ipContext, 
    QScriptEngine ipEngine 
);
#endif
 
#ifdef FCT_DOC
String TempPath();
#else
// TESTED
Array TempPath(
    QScriptContext ipContext, 
    QScriptEngine ipEngine 
);
#endif
 
#ifdef FCT_DOC
 copydircontent( String DirOrg,  String DirDest);
#else
// TESTED
Array copydircontent(
    QScriptContext ipContext, 
    QScriptEngine ipEngine 
);
#endif
 
#ifdef FCT_DOC
Boolean mkdir( String DirName);
#else
// TESTED
Array mkdir(
    QScriptContext ipContext, 
    QScriptEngine ipEngine 
);
#endif
 
#ifdef FCT_DOC
Number Execute( String Program,  Array<String> Arguments);
#else
// TESTED
Array Execute(
    QScriptContext ipContext, 
    QScriptEngine ipEngine 
);
#endif
 
#ifdef FCT_DOC
 ClearDoc();
#else
// TESTED
Array ClearDoc(
    QScriptContext ipContext, 
    QScriptEngine ipEngine 
);
#endif
 
#ifdef FCT_DOC
 SetViewDir(ViewDirEnum Dir 
);
 SetViewDir(
    SVector Dir, 
    SVector Up 
);
#else
// TESTED
Array SetViewDir(
    QScriptContext ipContext, 
    QScriptEngine ipEngine 
);
#endif
 
#ifdef FCT_DOC
 ZoomAll();
#else
// TESTED
Array ZoomAll(
    QScriptContext ipContext, 
    QScriptEngine ipEngine 
);
#endif
 
#ifdef FCT_DOC
 ZoomOn(
    Array<SComp> TableOfObjects, 
    Number milliseconds 
);
#else
// TESTED
Array ZoomOn(
    QScriptContext ipContext, 
    QScriptEngine ipEngine 
);
#endif
 
#ifdef FCT_DOC
 SetCameraMode(ViewModeEnum Mode 
);
#else
Array SetCameraMode(
    QScriptContext ipContext, 
    QScriptEngine ipEngine 
);
#endif
 
#ifdef FCT_DOC
Array GetCameraMode();
#else
Array GetCameraMode(
    QScriptContext ipContext, 
    QScriptEngine ipEngine 
);
#endif
 
#ifdef FCT_DOC
Array IsCameraLocked();
#else
Array IsCameraLocked(
    QScriptContext ipContext, 
    QScriptEngine ipEngine 
);
#endif
 
#ifdef FCT_DOC
 LockCamera(Boolean lock 
);
#else
Array LockCamera(
    QScriptContext ipContext, 
    QScriptEngine ipEngine 
);
#endif
 
#ifdef FCT_DOC
Array GetCameraDirection(
     SPoint iTargetPt
);
#else
Array GetCameraDirection(
    QScriptContext ipContext, 
    QScriptEngine ipEngine 
);
#endif
 
#ifdef FCT_DOC
Array GetCameraPosition();
#else
Array GetCameraPosition(
    QScriptContext ipContext, 
    QScriptEngine ipEngine 
);
#endif
 
#ifdef FCT_DOC
 ZoomFactor(Number factor 
);
#else
// TESTED
Array ZoomFactor(
    QScriptContext ipContext, 
    QScriptEngine ipEngine 
);
#endif
 
#ifdef FCT_DOC
Array CreatePicture(
    String FileName, 
    Number Height, 
    Number Width, 
    Number Background, 
    Number PointLineMagnification 
);
#else
// TESTED
Array CreatePicture(
    QScriptContext ipContext, 
    QScriptEngine ipEngine 
);
#endif
 
#ifdef FCT_DOC
 Repaint();
#else
// TESTED
Array Repaint(
    QScriptContext ipContext, 
    QScriptEngine ipEngine 
);
#endif
 
#ifdef FCT_DOC
 FlushDisplay();
#else
// TESTED
Array FlushDisplay(
    QScriptContext ipContext, 
    QScriptEngine ipEngine 
);
#endif
 
#ifdef FCT_DOC
 SetTextSize(Number Size 
);
#else
// TESTED
Array SetTextSize(
    QScriptContext ipContext, 
    QScriptEngine ipEngine 
);
#endif
 
#ifdef FCT_DOC
Array GetCoordSysTransf();
#else
// TESTED
Array GetCoordSysTransf(
    QScriptContext ipContext, 
    QScriptEngine ipEngine 
);
#endif
 
#ifdef FCT_DOC
 trayCreate();
#else
Array trayCreate(
    QScriptContext ipContext, 
    QScriptEngine ipEngine 
);
#endif
 
#ifdef FCT_DOC
 trayRemove();
#else
Array trayRemove(
    QScriptContext ipContext, 
    QScriptEngine ipEngine 
);
#endif
 
#ifdef FCT_DOC
 SplitVert();
#else
Array SplitVert(
    QScriptContext ipContext, 
    QScriptEngine ipEngine 
);
#endif
 
#ifdef FCT_DOC
 SplitHor();
#else
Array SplitHor(
    QScriptContext ipContext, 
    QScriptEngine ipEngine 
);
#endif
 
#ifdef FCT_DOC
 KeepOnlyCurrentView();
#else
Array KeepOnlyCurrentView(
    QScriptContext ipContext, 
    QScriptEngine ipEngine 
);
#endif
 
#ifdef FCT_DOC
 RemoveSplit();
#else
Array RemoveSplit(
    QScriptContext ipContext, 
    QScriptEngine ipEngine 
);
#endif
 
#ifdef FCT_DOC
 SetActiveView(
    uint viewNumber, 
);
#else
Array SetActiveView(
    QScriptContext ipContext, 
    QScriptEngine ipEngine 
);
#endif
 
#ifdef FCT_DOC
 ShowOnly(Array<SComp> compsToShowOnly 
);
#else
Array ShowOnly(
    QScriptContext ipContext, 
    QScriptEngine ipEngine 
);
#endif
 
#ifdef FCT_DOC
 ShowOnlyInActiveView(Array<SComp> compsToShowOnly 
);
#else
Array ShowOnlyInActiveView(
    QScriptContext ipContext, 
    QScriptEngine ipEngine 
);
#endif
 
 
#ifdef FCT_DOC
Number GetScaleFactor();
#else
Array GetScaleFactor(QScriptContext ipContext, QScriptEngine ipEngine);
#endif
 
#ifdef FCT_DOC
Array GetThousandSeparator(
    String iLocale = "" 
);
#else
Array GetThousandSeparator(QScriptContext ipContext, QScriptEngine ipEngine);
#endif
 
#ifdef FCT_DOC
Array ConvertNumberToString(
    Number iNumberToConvert, 
    String iLocale = "" 
);
#else
Array ConvertNumberToString(QScriptContext ipContext, QScriptEngine ipEngine);
#endif
 
#ifdef FCT_DOC
Array GetListSeparator(
    String iLocale = "" 
);
#else
Array GetListSeparator(QScriptContext ipContext, QScriptEngine ipEngine);
#endif
 
} // namespace ScriptUtil
 
#ifndef FCT_DOC
} // namespace rsh::ScriptBinding
#endif // !FCT_DOC