SComp.h

 
 
 
 
#pragma once
 
#include "RshPluginScript/RshPluginScriptDefines.h"
#include "RshDisplay/SComp/DGroup.h"
#include "RshDisplay/Display/DCompSelectionModel.h"
#include "RshPluginScript/SClass/SObject.h"
#include "RshPluginScript/SClass/SVector3.h"
#include "RshPluginScript/Script/SEngineManager.h"
#include "RshPluginScriptInterface/Script/ScriptConvert.h"
 
#ifndef FCT_DOC
namespace rsh::ScriptBinding
{
#endif // !FCT_DOC
class RshPluginScriptAPI SComp : public SObject
{
    //======================================================================================================================
    //                                       INTERNAL FUNCTION
    //======================================================================================================================
 
    //======================================================================================================================
    //                                      DOCUMENTED FUNCTION
    //======================================================================================================================
 
public:
    enum RepresentationTypeEnum
    {
        SMOOTH, // smooth shading + rotation idem
        FLAT, // flat shading and compatible with real time edition + rotation idem
        WIRE, // wireframe + rotation idem
        SMOOTH_WIRE, // smooth shading et wireframe together + rotation idem
        FLAT_WIRE, // flat shading and wireframe together + rotation idem
        SMOOTH_ROTWIRE, // smooth shading and wireframe together + rotation wireframe
        FLAT_ROTWIRE, // flat shading and wireframe together + rotation wireframe
        TEXTURE, // Colored points / Vertex
        INSPECTION, // Calculate a color based on a value on each vertex.
    };
 
public slots: // these functions (slots) will be available in QtScript
    // TESTED
     Translate( SVector Vector 
    );
 
    // TESTED
     ApplyTransformation( SMatrix iMatrix 
    );
 
    // @note (not in the documentation)
    // If no error occurred the ownership is taken by the DComptree
    // TESTED
      AddToDoc();
 
    // @note (not in the documentation)
    // If no error occurred the ownership is taken by the qtScript
    // TESTED
     RemoveFromDoc();
 
    // TESTED
     MoveToGroup(
        String GroupPath, 
        Boolean MoveInsideTopParent
    );
 
    // TESTED
    Boolean IsInDoc() ;
 
    // TESTED
     SetColors(
        Number Red, 
        Number Green, 
        Number Blue 
    );
 
    Array GetColors();
 
    // TESTED
     SetTransparency(Number Alpha 
    );
 
    // TESTED
     SetName(String ComponentName 
    );
 
    // TESTED
    String GetName() ;
 
    // TESTED
    String GetFolderName() ;
 
    String GetPath() ;
 
      Clear()  {}
 
    // TESTED
    Array GetBoundingBox();
 
     SetVisibility(Boolean Visible 
    ) ;
 
    Boolean IsVisible() ;
 
     Invert();
 
     SetRepresentationType(RepresentationTypeEnum Representation 
    );
 
     SetClippable(Boolean clipping);
 
     String toString() ;
 
private:
    static Number SelectDComp(
         std::type_index iDCompType, SComp opSelectedComp, rsh::Display::DCompTree ipCompTree);
};
 
// @brief
// This class allows to wrap static functions to SComp easily.
// This allow to wrap constructor more easily : the constructor will be declared with the function New(...)
class RshPluginScriptAPI SComp
#ifndef FCT_DOC
    : public SObjectStatic
#endif // FCT_DOC
{
    //======================================================================================================================
    //                                       INTERNAL FUNCTION
    //======================================================================================================================
 
    //======================================================================================================================
    //                                      DOCUMENTED FUNCTION
    //======================================================================================================================
public slots:
 
    static Array FromClick() { return SComp::GetFromClick<SComp>(SV_COMP); }
 
    // TESTED
    static Array FromName( String Name) { return SComp::GetFromName<SComp>(Name); }
 
    // TESTED
    static Array FromSel();
 
    // TESTED
    static Array All(
        Number VisCrit
    )
    {
        return SComp::GetAll<SComp>(VisCrit);
    }
 
     String toString() ;
};
RSH_SCOMP_STATIC_Q_DECLARE_METATYPE(SComp, _SCompDummy);
 
 
#ifndef FCT_DOC
 
} // namespace rsh::ScriptBinding
#endif // !FCT_DOC
 
#ifndef FCT_DOC
namespace rsh::Script::ScriptConvert
{
//-------------------------------------------------------------------------------------------------------------------
template<typename DCompClass>
 DCompFromScriptValue( Array _iScriptValue, DCompClass _oDComp)
{
    using namespace rsh::Display;
    using namespace rsh::ScriptBinding;
 
    _oDComp = nullptr;
    QObject myObj = _iScriptValue.prototype().toQObject();
    SComp currentScomp = dynamic_cast<SComp>(myObj);
    if(currentScomp)
    {
        SComp myDcomp = currentScomp->thisDComp(_iScriptValue);
        _oDComp = dynamic_cast<DCompClass>(myDcomp);
    }
}
 
} // namespace rsh::Script::ScriptConvert
#endif // !FCT_DOC
 
RSH_Q_DECLARE_METATYPE_FORWARD(rsh::ScriptBinding::SCircle);
RSH_Q_DECLARE_METATYPE_FORWARD(rsh::ScriptBinding::SPlane);
RSH_Q_DECLARE_METATYPE_FORWARD(rsh::ScriptBinding::SCylinder);
RSH_Q_DECLARE_METATYPE_FORWARD(rsh::ScriptBinding::SMultiline);
RSH_Q_DECLARE_METATYPE_FORWARD(rsh::ScriptBinding::SPoint);
RSH_Q_DECLARE_METATYPE_FORWARD(rsh::ScriptBinding::SPoly);
RSH_Q_DECLARE_METATYPE_FORWARD(rsh::ScriptBinding::SCloud);
RSH_Q_DECLARE_METATYPE_FORWARD(rsh::ScriptBinding::SLabel);
RSH_Q_DECLARE_METATYPE_FORWARD(rsh::ScriptBinding::SSetMultiline);
RSH_Q_DECLARE_METATYPE_FORWARD(rsh::ScriptBinding::SLine);
RSH_Q_DECLARE_METATYPE_FORWARD(rsh::ScriptBinding::SCone);
RSH_Q_DECLARE_METATYPE_FORWARD(rsh::ScriptBinding::SSphere);
RSH_Q_DECLARE_METATYPE_FORWARD(rsh::ScriptBinding::SRoundSlot);
RSH_Q_DECLARE_METATYPE_FORWARD(rsh::ScriptBinding::SSquareSlot);
RSH_Q_DECLARE_METATYPE_FORWARD(rsh::ScriptBinding::SViewSet);
RSH_Q_DECLARE_METATYPE_FORWARD(rsh::ScriptBinding::SCADSurface);
RSH_Q_DECLARE_METATYPE_FORWARD(rsh::ScriptBinding::SFeature);
RSH_Q_DECLARE_METATYPE_FORWARD(rsh::ScriptBinding::SClipping);
RSH_Q_DECLARE_METATYPE_FORWARD(rsh::ScriptBinding::SClippingPlane);
RSH_Q_DECLARE_METATYPE_FORWARD(rsh::ScriptBinding::SClippingBox);
RSH_Q_DECLARE_METATYPE_FORWARD(rsh::ScriptBinding::SReportData);
RSH_Q_DECLARE_METATYPE_FORWARD(rsh::ScriptBinding::SReport);