SOP_Invoke.proto.h

Go to the documentation of this file.

/* Automagically Generated by generate_proto.py
 * Do not Edit
 */
#pragma once

#include <SOP/SOP_API.h>
#include <SOP/SOP_NodeVerb.h>
#include <OP/OP_GraphProxy.h>

#include <OP/OP_Utils.h>
#include <PRM/PRM_Parm.h>
#include <UT/UT_IStream.h>
#include <UT/UT_NTStreamUtil.h>
#include <UT/UT_Ramp.h>
#include <UT/UT_SharedPtr.h>
#include <UT/UT_StringHolder.h>
#include <UT/UT_StringStream.h>
#include <UT/UT_VectorTypes.h>
#include <UT/UT_EnvControl.h>
#include <SYS/SYS_Types.h>

class DEP_MicroNode;
namespace SOP_InvokeEnums
{
    enum class Unload
    {
        NEVER = 0,
        FLAG,
        ALWAYS
    };

    SYS_FORCE_INLINE UT_StringHolder
    getToken(Unload enum_value) 
    {
        using namespace UT::Literal;
        switch (enum_value) {
        case Unload::NEVER: return "never"_sh;
        case Unload::FLAG: return "flag"_sh;
        case Unload::ALWAYS: return "always"_sh;
        default: UT_ASSERT(false); return ""_sh;
        }
    }

}


class SOP_API SOP_InvokeParms  : public SOP_NodeParms
{
public:
    static int version() { return 1; }
    struct Inputs
    {
        UT_StringHolder name;
        UT_StringHolder inputpath;


        Inputs()
        {
            name = ""_UTsh;
            inputpath = ""_UTsh;

        }

        bool operator==(const Inputs &src) const
        {
            if (name != src.name) return false;
            if (inputpath != src.inputpath) return false;

            return true;
        }
        bool operator!=(const Inputs &src) const
        {
            return !operator==(src);
        }

    };

    UT_StringHolder createString(const UT_Array<Inputs> &list) const
    {
        UT_WorkBuffer   buf;

        buf.strcat("[ ");
        for (int i = 0; i < list.entries(); i++)
        {
            if (i)
                buf.strcat(", ");
            buf.strcat("( ");
            buf.append("");
            { UT_String tmp; tmp = UT_StringWrap(list(i).name).makeQuotedString('"'); buf.strcat(tmp); }
            buf.append(", ");
            { UT_String tmp; tmp = UT_StringWrap(list(i).inputpath).makeQuotedString('"'); buf.strcat(tmp); }

            buf.strcat(" )");
        }
        buf.strcat(" ]");

        UT_StringHolder result = buf;
        return result;
    }

    SOP_InvokeParms()
    {
        myBlockpath = ""_UTsh;
        myInputs.setSize(4);
        myUnload = 2;

    }

    explicit SOP_InvokeParms(const SOP_InvokeParms &) = default;
    SOP_InvokeParms &operator=(const SOP_InvokeParms &) = default;
    SOP_InvokeParms(SOP_InvokeParms &&) noexcept = default;
    SOP_InvokeParms &operator=(SOP_InvokeParms &&) noexcept = default;

    ~SOP_InvokeParms() override {}

    bool operator==(const SOP_InvokeParms &src) const
    {
        if (myBlockpath != src.myBlockpath) return false;
        if (myInputs != src.myInputs) return false;
        if (myUnload != src.myUnload) return false;


        if (baseGetSignature() != src.baseGetSignature()) return false;

        return true;
    }
    bool operator!=(const SOP_InvokeParms &src) const
    {
        return !operator==(src);
    }
    using Unload = SOP_InvokeEnums::Unload;



    void        buildFromOp(const OP_GraphProxy *graph, exint nodeidx, fpreal time, DEP_MicroNode *depnode)
    {
        myBlockpath = ""_UTsh;
        if (true)
            graph->evalOpParm(myBlockpath, nodeidx, "blockpath", time, graph->isDirect()?nullptr:depnode);
        if (true)
        {
            int64   length = 0;
            graph->evalOpParm(length, nodeidx, "inputs", time, graph->isDirect()?nullptr:depnode);
            if (length < 0) length = 0;
            myInputs.setSize(length);
            for (exint i = 0; i < length; i++)
            {
                int     parmidx[1];
                int     offsets[1];
                parmidx[0] = i+0;
                offsets[0] = 0;
                auto && _curentry = myInputs(i);
                (void) _curentry;
                _curentry.name = ""_UTsh;
                if (true)
                    graph->evalOpParmInst(_curentry.name, nodeidx, "name#", parmidx, offsets, time, graph->isDirect()?nullptr:depnode, 2-1);
                _curentry.inputpath = ""_UTsh;
                if (true)
                    graph->evalOpParmInst(_curentry.inputpath, nodeidx, "inputpath#", parmidx, offsets, time, graph->isDirect()?nullptr:depnode, 2-1);

            }
        }
        else
            myInputs.clear();
        myUnload = 2;
        if (true)
            graph->evalOpParm(myUnload, nodeidx, "unload", time, graph->isDirect()?nullptr:depnode);

    }


    void loadFromOpSubclass(const LoadParms &loadparms) override
    {
        buildFromOp(loadparms.graph(), loadparms.nodeIdx(), loadparms.context().getTime(), loadparms.depnode());
    }


    void copyFrom(const OP_NodeParms *src) override
    {
        *this = *((const SOP_InvokeParms *)src);
    }

    template <typename T>
    void
    doGetParmValue(TempIndex idx, TempIndex instance, T &value) const
    {
        if (idx.size() < 1)
            return;
        UT_ASSERT(idx.size() == instance.size()+1);
        if (idx.size() != instance.size()+1)
            return;
        switch (idx[0])
        {
            case 0:
                coerceValue(value, myBlockpath);
                break;
            case 1:
                if (idx.size() == 1)
                    coerceValue(value, myInputs.entries());
                else if (instance[0] < myInputs.entries())
                {
                    auto && _data = myInputs(instance[0]);
                    switch (idx[1])
                    {
                    case 0:
                        coerceValue(value, _data.name);
                        break;
                    case 1:
                        coerceValue(value, _data.inputpath);
                        break;

                    }
                }
                break;
            case 2:
                coerceValue(value, myUnload);
                break;

        }
    }

    bool isParmColorRamp(exint idx) const override
    { 
            switch (idx)
            {

            }
            return false;
    }

    void getNestParmValue(TempIndex idx, TempIndex instance, exint &value) const override
    { doGetParmValue(idx, instance, value); }
    void getNestParmValue(TempIndex idx, TempIndex instance, fpreal &value) const override
    { doGetParmValue(idx, instance, value); }
    void getNestParmValue(TempIndex idx, TempIndex instance, UT_Vector2D &value) const override
    { doGetParmValue(idx, instance, value); }
    void getNestParmValue(TempIndex idx, TempIndex instance, UT_Vector3D &value) const override
    { doGetParmValue(idx, instance, value); }
    void getNestParmValue(TempIndex idx, TempIndex instance, UT_Vector4D &value) const override
    { doGetParmValue(idx, instance, value); }
    void getNestParmValue(TempIndex idx, TempIndex instance, UT_Matrix2D &value) const override
    { doGetParmValue(idx, instance, value); }
    void getNestParmValue(TempIndex idx, TempIndex instance, UT_Matrix3D &value) const override
    { doGetParmValue(idx, instance, value); }
    void getNestParmValue(TempIndex idx, TempIndex instance, UT_Matrix4D &value) const override
    { doGetParmValue(idx, instance, value); }
    void getNestParmValue(TempIndex idx, TempIndex instance, UT_StringHolder &value) const override
    { doGetParmValue(idx, instance, value); }
    void getNestParmValue(TempIndex idx, TempIndex instance, UT_SharedPtr<UT_Ramp> &value) const override
    { doGetParmValue(idx, instance, value); }
    void getNestParmValue(TempIndex idx, TempIndex instance, PRM_DataItemHandle &value) const override
    { doGetParmValue(idx, instance, value); }

    template <typename T>
    void
    doSetParmValue(TempIndex idx, TempIndex instance, const T &value) 
    {
        if (idx.size() < 1)
            return;
        UT_ASSERT(idx.size() == instance.size()+1);
        if (idx.size() != instance.size()+1)
            return;
        switch (idx[0])
        {
            case 0:
                coerceValue(myBlockpath, ( ( value ) ));
                break;
            case 1:
                if (idx.size() == 1)
                {
                    exint       newsize;
                    coerceValue(newsize, value);
                    if (newsize < 0) newsize = 0;
                    myInputs.setSize(newsize);
                }
                else
                {
                    if (instance[0] < 0)
                        return;
                    myInputs.setSizeIfNeeded(instance[0]+1);
                    auto && _data = myInputs(instance[0]);
                    switch (idx[1])
                    {
                    case 0:
                        coerceValue(_data.name, value);
                        break;
                    case 1:
                        coerceValue(_data.inputpath, value);
                        break;

                    }
                }
                break;
            case 2:
                coerceValue(myUnload, clampMinValue(0,  clampMaxValue(2,  value ) ));
                break;

        }
    }

    void setNestParmValue(TempIndex idx, TempIndex instance, const exint &value)  override
    { doSetParmValue(idx, instance, value); }
    void setNestParmValue(TempIndex idx, TempIndex instance, const fpreal &value)  override
    { doSetParmValue(idx, instance, value); }
    void setNestParmValue(TempIndex idx, TempIndex instance, const UT_Vector2D &value)  override
    { doSetParmValue(idx, instance, value); }
    void setNestParmValue(TempIndex idx, TempIndex instance, const UT_Vector3D &value)  override
    { doSetParmValue(idx, instance, value); }
    void setNestParmValue(TempIndex idx, TempIndex instance, const UT_Vector4D &value)  override
    { doSetParmValue(idx, instance, value); }
    void setNestParmValue(TempIndex idx, TempIndex instance, const UT_Matrix2D &value)  override
    { doSetParmValue(idx, instance, value); }
    void setNestParmValue(TempIndex idx, TempIndex instance, const UT_Matrix3D &value)  override
    { doSetParmValue(idx, instance, value); }
    void setNestParmValue(TempIndex idx, TempIndex instance, const UT_Matrix4D &value)  override
    { doSetParmValue(idx, instance, value); }
    void setNestParmValue(TempIndex idx, TempIndex instance, const UT_StringHolder &value)  override
    { doSetParmValue(idx, instance, value); }
    void setNestParmValue(TempIndex idx, TempIndex instance, const UT_SharedPtr<UT_Ramp> &value)  override
    { doSetParmValue(idx, instance, value); }
    void setNestParmValue(TempIndex idx, TempIndex instance, const PRM_DataItemHandle &value)  override
    { doSetParmValue(idx, instance, value); }

    exint getNestNumParms(TempIndex idx) const override
    {
        if (idx.size() == 0)
            return 3;
        switch (idx[0])
        {
            case 1:
                return 2;

        }
        // Invalid
        return 0;
    }

    const char *getNestParmName(TempIndex fieldnum) const override
    {
        if (fieldnum.size() < 1)
            return 0;
        switch (fieldnum[0])
        {
            case 0:
                return "blockpath";
            case 1:
                if (fieldnum.size() == 1)
                    return "inputs";
                switch (fieldnum[1])
                {
                    case 0:
                        return "name#";
                    case 1:
                        return "inputpath#";

                }
                return 0;
            case 2:
                return "unload";

        }
        return 0;
    }

    ParmType getNestParmType(TempIndex fieldnum) const override
    {
        if (fieldnum.size() < 1)
            return PARM_UNSUPPORTED;
        switch (fieldnum[0])
        {
            case 0:
                return PARM_STRING;
            case 1:
                if (fieldnum.size() == 1)
                    return PARM_MULTIPARM;
                switch (fieldnum[1])
                {
                    case 0:
                        return PARM_STRING;
                    case 1:
                        return PARM_STRING;

                }
                return PARM_UNSUPPORTED;
            case 2:
                return PARM_INTEGER;

        }
        return PARM_UNSUPPORTED;
    }

    // Boiler plate to load individual types.
    static void  loadData(UT_IStream &is, int64 &v)
    { is.bread(&v, 1); }
    static void  loadData(UT_IStream &is, bool &v)
    { int64     iv; is.bread(&iv, 1); v = iv; }
    static void  loadData(UT_IStream &is, fpreal64 &v)
    { is.bread<fpreal64>(&v, 1); }
    static void  loadData(UT_IStream &is, UT_Vector2D &v)
    { is.bread<fpreal64>(&v.x(), 1); is.bread<fpreal64>(&v.y(), 1); }
    static void  loadData(UT_IStream &is, UT_Vector3D &v)
    { is.bread<fpreal64>(&v.x(), 1); is.bread<fpreal64>(&v.y(), 1);
      is.bread<fpreal64>(&v.z(), 1); }
    static void  loadData(UT_IStream &is, UT_Vector4D &v)
    { is.bread<fpreal64>(&v.x(), 1); is.bread<fpreal64>(&v.y(), 1);
      is.bread<fpreal64>(&v.z(), 1); is.bread<fpreal64>(&v.w(), 1); }
    static void  loadData(UT_IStream &is, UT_Matrix2D &v)
    { for (int r = 0; r < 2; r++) for (int c = 0; c < 2; c++) is.bread<fpreal64>(&v(r, c), 1); }
    static void  loadData(UT_IStream &is, UT_Matrix3D &v)
    { for (int r = 0; r < 3; r++) for (int c = 0; c < 3; c++) is.bread<fpreal64>(&v(r, c), 1); }
    static void  loadData(UT_IStream &is, UT_Matrix4D &v)
    { for (int r = 0; r < 4; r++) for (int c = 0; c < 4; c++) is.bread<fpreal64>(&v(r, c), 1); }
    static void  loadData(UT_IStream &is, UT_Vector2I &v)
    { is.bread<int64>(&v.x(), 1); is.bread<int64>(&v.y(), 1); }
    static void  loadData(UT_IStream &is, UT_Vector3I &v)
    { is.bread<int64>(&v.x(), 1); is.bread<int64>(&v.y(), 1);
      is.bread<int64>(&v.z(), 1); }
    static void  loadData(UT_IStream &is, UT_Vector4I &v)
    { is.bread<int64>(&v.x(), 1); is.bread<int64>(&v.y(), 1);
      is.bread<int64>(&v.z(), 1); is.bread<int64>(&v.w(), 1); }
    static void  loadData(UT_IStream &is, UT_StringHolder &v)
    { is.bread(v); }
    static void  loadData(UT_IStream &is, UT_SharedPtr<UT_Ramp> &v)
    {   UT_StringHolder   rampdata;
        loadData(is, rampdata);
        if (rampdata.isstring())
        {
            v.reset(new UT_Ramp());
            UT_IStream  istr((const char *) rampdata, rampdata.length(), UT_ISTREAM_ASCII);
            v->load(istr);
        }
        else v.reset();
    }
    static void  loadData(UT_IStream &is, PRM_DataItemHandle &v)
    {   UT_StringHolder   data;
        loadData(is, data);
        if (data.isstring())
        {
            // Find the data type.
            const char *colon = UT_StringWrap(data).findChar(':');
            if (colon)
            {
                int             typelen = colon - data.buffer();
                UT_WorkBuffer   type;
                type.strncpy(data.buffer(), typelen);
                UT_IStream  istr(((const char *) data) + typelen + 1, data.length() - (typelen + 1), UT_ISTREAM_BINARY);
                
                v = PRM_DataFactory::parseBinary(type.buffer(), istr);
            }
        }
        else v.reset();
    }

    static void  saveData(std::ostream &os, int64 v)
    { UTwrite(os, &v); }
    static void  saveData(std::ostream &os, bool v)
    { int64 iv = v; UTwrite(os, &iv); }
    static void  saveData(std::ostream &os, fpreal64 v)
    { UTwrite<fpreal64>(os, &v); }
    static void  saveData(std::ostream &os, UT_Vector2D v)
    { UTwrite<fpreal64>(os, &v.x()); UTwrite<fpreal64>(os, &v.y()); }
    static void  saveData(std::ostream &os, UT_Vector3D v)
    { UTwrite<fpreal64>(os, &v.x()); UTwrite<fpreal64>(os, &v.y());
      UTwrite<fpreal64>(os, &v.z()); }
    static void  saveData(std::ostream &os, UT_Vector4D v)
    { UTwrite<fpreal64>(os, &v.x()); UTwrite<fpreal64>(os, &v.y());
      UTwrite<fpreal64>(os, &v.z()); UTwrite<fpreal64>(os, &v.w()); }
    static void  saveData(std::ostream &os, UT_Matrix2D v)
    { for (int r = 0; r < 2; r++) for (int c = 0; c < 2; c++) UTwrite<fpreal64>(os, &v(r, c)); }
    static void  saveData(std::ostream &os, UT_Matrix3D v)
    { for (int r = 0; r < 3; r++) for (int c = 0; c < 3; c++) UTwrite<fpreal64>(os, &v(r, c)); }
    static void  saveData(std::ostream &os, UT_Matrix4D v)
    { for (int r = 0; r < 4; r++) for (int c = 0; c < 4; c++) UTwrite<fpreal64>(os, &v(r, c)); }
    static void  saveData(std::ostream &os, UT_StringHolder s)
    { UT_StringWrap(s).saveBinary(os); }
    static void  saveData(std::ostream &os, UT_SharedPtr<UT_Ramp> s)
    {   UT_StringHolder         result;
        UT_OStringStream        ostr;
        if (s) s->save(ostr);
        result = ostr.str();
        saveData(os, result);
    }
    static void  saveData(std::ostream &os, PRM_DataItemHandle s)
    {   UT_StringHolder         result;
        UT_OStringStream        ostr;
        if (s) 
        {
            ostr << s->getDataTypeToken();
            ostr << ":";
            s->saveBinary(ostr);
        }
        result = ostr.str();
        saveData(os, result);
    }


    void         save(std::ostream &os) const
    {
        int32           v = version();
        UTwrite(os, &v);
        saveData(os, myBlockpath);
        {
            int64   length = myInputs.entries();
            UTwrite(os, &length);
            for (exint i = 0; i < length; i++)
            {
                auto && _curentry = myInputs(i);
                (void) _curentry;
                saveData(os, _curentry.name);
                saveData(os, _curentry.inputpath);

            }
        }
        saveData(os, myUnload);

    }

    bool         load(UT_IStream &is)
    {
        int32           v;
        is.bread(&v, 1);
        if (version() != v)
        {
            // Fail incompatible versions
            return false;
        }
        loadData(is, myBlockpath);
        {
            int64   length;
            is.read(&length, 1);
            myInputs.setSize(length);
            for (exint i = 0; i < length; i++)
            {
                auto && _curentry = myInputs(i);
                (void) _curentry;
                loadData(is, _curentry.name);
                loadData(is, _curentry.inputpath);

            }
        }
        loadData(is, myUnload);

        return true;
    }

    const UT_StringHolder & getBlockpath() const { return myBlockpath; }
    void setBlockpath(const UT_StringHolder & val) { myBlockpath = val; }
    UT_StringHolder opBlockpath(const SOP_NodeVerb::CookParms &cookparms) const
    { 
        SOP_Node *thissop = cookparms.getNode();
        if (!thissop) return getBlockpath();
        UT_StringHolder result;
        OP_Utils::evalOpParm(result, thissop, "blockpath", cookparms.getCookTime(), 0);
        return result;
    }
    const UT_Array<Inputs> &getInputs() const { return myInputs; }
void setInputs(const UT_Array<Inputs> &val) { myInputs = val; }
    exint opInputs(const SOP_NodeVerb::CookParms &cookparms) const
    { 
        SOP_Node *thissop = cookparms.getNode();
        if (!thissop) return getInputs().entries();
        exint result;
        OP_Utils::evalOpParm(result, thissop, "inputs", cookparms.getCookTime(), 0);
        return result;
    }
        UT_StringHolder opInputs_name(const SOP_NodeVerb::CookParms &cookparms, int _idx) const
    { return opinstInputs_name(cookparms, &_idx); }
    UT_StringHolder opinstInputs_name(const SOP_NodeVerb::CookParms &cookparms, const int *_idx) const
    {
        SOP_Node *thissop = cookparms.getNode();
        if (!thissop) return (myInputs(_idx[0]).name);
        int _parmidx[2-1];
        _parmidx[1-1] = _idx[1-1] + 0;

        UT_StringHolder result;
        OP_Utils::evalOpParmInst(result, thissop, "name#", _parmidx, cookparms.getCookTime(), 0, 2-1);
        return (result);
    }
    UT_StringHolder opInputs_inputpath(const SOP_NodeVerb::CookParms &cookparms, int _idx) const
    { return opinstInputs_inputpath(cookparms, &_idx); }
    UT_StringHolder opinstInputs_inputpath(const SOP_NodeVerb::CookParms &cookparms, const int *_idx) const
    {
        SOP_Node *thissop = cookparms.getNode();
        if (!thissop) return (myInputs(_idx[0]).inputpath);
        int _parmidx[2-1];
        _parmidx[1-1] = _idx[1-1] + 0;

        UT_StringHolder result;
        OP_Utils::evalOpParmInst(result, thissop, "inputpath#", _parmidx, cookparms.getCookTime(), 0, 2-1);
        return (result);
    }

    Unload getUnload() const { return Unload(myUnload); }
    void setUnload(Unload val) { myUnload = int64(val); }
    Unload opUnload(const SOP_NodeVerb::CookParms &cookparms) const
    { 
        SOP_Node *thissop = cookparms.getNode();
        if (!thissop) return getUnload();
        int64 result;
        OP_Utils::evalOpParm(result, thissop, "unload", cookparms.getCookTime(), 0);
        return Unload(result);
    }

private:
    UT_StringHolder myBlockpath;
    UT_Array<Inputs> myInputs;
    int64 myUnload;

};