SColorGradient.h

 
 
 
 
#pragma once
 
#include "RshPluginScript/RshPluginScriptDefines.h"
#include "RshPluginScript/SClass/SObject.h"
 
#ifndef FCT_DOC
namespace rsh::ScriptBinding
{
#endif // !FCT_DOC
 
class SColorGradient : public SObject
{
    //======================================================================================================================
    //                                       INTERNAL FUNCTION
    //======================================================================================================================
    //======================================================================================================================
    //                                      DOCUMENTED FUNCTION
    //======================================================================================================================
 
public:
    enum DisplayFlag
    {
        HIDE, 
        SHOW_FOREGROUND, 
        SHOW_BACKGROUND, 
    };
 
    enum Interpolation
    {
        Linear,
        HSLCounterClockwise,
        HSLClockwise,
        HSLShortest,
        HSLLongest,
    };
 
public slots:
 
    // TESTED
     SetDisplayOption(DisplayFlag DisplayPalette);
 
     SetMagnification(Number magnification 
    );
 
    // TESTED
    Array SetRange(
        Number MinValue, 
        Number MaxValue 
    );
 
    // TESTED
    Array GetRange();
 
    // TESTED
    Array SetColBefore(
        Number Index, 
        Number Red, 
        Number Green, 
        Number Blue, 
        Number Alpha = -1 
    );
 
    // TESTED
    Array SetColAfter(
        Number Index, 
        Number Red, 
        Number Green, 
        Number Blue, 
        Number Alpha = -1 
    );
 
    Array GetCursorInfo(Number Index);
 
    // TESTED
    Array AddCursor(Number Position);
 
    // TESTED
    Array DeleteCursor(Number Index);
 
    // TESTED
    Array SetCursorPos(Number Index, Number Position);
 
    // TESTED
     SetColUndefined(
        Number Red, 
        Number Green, 
        Number Blue, 
        Number Alpha = -1 
    );
 
    // TESTED
    Array GetColUndefined();
 
    // TESTED
     SetInterpolation(Interpolation Method);
 
    // TESTED
    Array SetNbCursor(Number NbCursor 
    );
 
    // TESTED
    Number GetNbCursor();
 
    // TESTED
    Number GetNbCursorMax();
 
    Array GetColorFromValue(Number value);
 
     String toString() ;
};
 
Q_DECLARE_METATYPE(SColorGradient::_SColorGradientDummy);
 
#ifndef FCT_DOC
} // namespace rsh::ScriptBinding
#endif // !FCT_DOC