SClipping.h

 
 
 
 
#pragma once
 
#include "RshPluginScript/RshPluginScriptDefines.h"
#include "RshPluginScript/SClass/SComp.h"
#include "RshPluginScriptInterface/Script/ScriptDefine.h"
 
#ifndef FCT_DOC
namespace rsh::ScriptBinding
{
#endif // !FCT_DOC
 
class SClipping : public SComp
{
    //======================================================================================================================
    //                                       INTERNAL FUNCTION
    //======================================================================================================================
 
    //======================================================================================================================
    //                                      DOCUMENTED FUNCTION
    //======================================================================================================================
 
public slots: // these functions (slots) will be available in QtScript
 
    inline  Clip(SComp Comp)
    {
        if(Comp)
            thisDComp()->Clip(Comp);
        else
            rsh::Script::ParamIsInvalid<SComp>();
    }
 
    inline  ClipTable( Array<SComp> CompTable)
    {
        thisDComp()->Clip(CompTable);
    }
 
    inline  ClipAll() { thisDComp()->ClipAll(); }
 
    inline  Unclip(SComp Comp)
    {
        if(Comp)
            thisDComp()->Unclip(Comp);
        else
            rsh::Script::ParamIsInvalid<SComp>();
    }
 
    inline  UnclipTable( Array<SComp> CompTable)
    {
        thisDComp()->Unclip(CompTable);
    }
 
    inline  UnclipAll() { thisDComp()->UnclipAll(); }
 
     ActivateInScene(uint iSceneIndex);
 
    inline  ActivateInAllScenes() { thisDComp()->ActivateInAllScenes(); }
 
     DeactivateInScene(uint iSceneIndex);
 
    inline  DeactivateInAllScenes() { thisDComp()->DeactivateInAllScenes(); }
 
     String toString() ;
};
 
// @brief
// This class allows to wrap static functions to SClipping easily.
// This allow to wrap constructor more easily : the constructor will be declared with the function New(...)
class SClipping
#ifndef FCT_DOC
    : public SObjectStatic
#endif // FCT_DOC
{
    //======================================================================================================================
    //                                       INTERNAL FUNCTION
    //======================================================================================================================
 
    //======================================================================================================================
    //                                      DOCUMENTED FUNCTION
    //======================================================================================================================
public slots:
 
    static Array FromClick() { return SComp::GetFromClick<SClippingBase>(SV_CLIPPING); }
 
    // TESTED
    static Array FromName( String Name) { return SComp::GetFromName<SClippingBase>(Name); }
 
    // TESTED
    static Array FromSel();
 
    // TESTED
    static Array All(
        Number VisCrit
    )
    {
        return SComp::GetAll<SClippingBase>(VisCrit);
    }
 
    static Array GetAllActivated(
        Number VisCrit
    );
 
    static String toString();
};
RSH_SCOMP_STATIC_Q_DECLARE_METATYPE(SClipping, _SClippingDummy);
 
#ifndef FCT_DOC
} // namespace rsh::ScriptBinding
#endif // !FCT_DOC