SOP_PackInject.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_PackInjectEnums
{
    enum class Method
    {
        REPLACE = 0,
        COLLATE
    };

    SYS_FORCE_INLINE UT_StringHolder
    getToken(Method enum_value) 
    {
        using namespace UT::Literal;
        switch (enum_value) {
        case Method::REPLACE: return "replace"_sh;
        case Method::COLLATE: return "collate"_sh;
        default: UT_ASSERT(false); return ""_sh;
        }
    }

    enum class Collate
    {
        SINGLE = 0,
        INDEX,
        ATTRIB,
        ATTRIBPAIR
    };

    SYS_FORCE_INLINE UT_StringHolder
    getToken(Collate enum_value) 
    {
        using namespace UT::Literal;
        switch (enum_value) {
        case Collate::SINGLE: return "single"_sh;
        case Collate::INDEX: return "index"_sh;
        case Collate::ATTRIB: return "attrib"_sh;
        case Collate::ATTRIBPAIR: return "attribpair"_sh;
        default: UT_ASSERT(false); return ""_sh;
        }
    }

}


class SOP_API SOP_PackInjectParms  : public SOP_NodeParms
{
public:
    static int version() { return 1; }

    SOP_PackInjectParms()
    {
        myGroup = ""_UTsh;
        myMethod = 0;
        myCollate = 2;
        mySource = 0;
        myMatchAttrib = "name"_UTsh;
        mySrcAttrib = "name"_UTsh;
        myIgnoremissing = true;
        myPreservetype = true;

    }

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

    ~SOP_PackInjectParms() override {}

    bool operator==(const SOP_PackInjectParms &src) const
    {
        if (myGroup != src.myGroup) return false;
        if (myMethod != src.myMethod) return false;
        if (myCollate != src.myCollate) return false;
        if (mySource != src.mySource) return false;
        if (myMatchAttrib != src.myMatchAttrib) return false;
        if (mySrcAttrib != src.mySrcAttrib) return false;
        if (myIgnoremissing != src.myIgnoremissing) return false;
        if (myPreservetype != src.myPreservetype) return false;


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

        return true;
    }
    bool operator!=(const SOP_PackInjectParms &src) const
    {
        return !operator==(src);
    }
    using Method = SOP_PackInjectEnums::Method;
    using Collate = SOP_PackInjectEnums::Collate;



    void        buildFromOp(const OP_GraphProxy *graph, exint nodeidx, fpreal time, DEP_MicroNode *depnode)
    {
        myGroup = ""_UTsh;
        if (true)
            graph->evalOpParm(myGroup, nodeidx, "group", time, graph->isDirect()?nullptr:depnode);
        myMethod = 0;
        if (true)
            graph->evalOpParm(myMethod, nodeidx, "method", time, graph->isDirect()?nullptr:depnode);
        myCollate = 2;
        if (true && ( (true&&!(((int64(getMethod())!=1)))) ) )
            graph->evalOpParm(myCollate, nodeidx, "collate", time, graph->isDirect()?nullptr:depnode);
        mySource = 0;
        if (true && ( (true&&!(((int64(getMethod())!=1))||((int64(getCollate())!=0)))) ) )
            graph->evalOpParm(mySource, nodeidx, "source", time, graph->isDirect()?nullptr:depnode);
        myMatchAttrib = "name"_UTsh;
        if (true && ( (true&&!(((int64(getMethod())!=1))||((int64(getCollate())==1)&&(int64(getCollate())==0)))) ) )
            graph->evalOpParm(myMatchAttrib, nodeidx, "matchattrib", time, graph->isDirect()?nullptr:depnode);
        mySrcAttrib = "name"_UTsh;
        if (true && ( (true&&!(((int64(getMethod())!=1))||((int64(getCollate())!=3)))) ) )
            graph->evalOpParm(mySrcAttrib, nodeidx, "srcattrib", time, graph->isDirect()?nullptr:depnode);
        myIgnoremissing = true;
        if (true && ( (true&&!(((int64(getMethod())!=1)))) ) )
            graph->evalOpParm(myIgnoremissing, nodeidx, "ignoremissing", time, graph->isDirect()?nullptr:depnode);
        myPreservetype = true;
        if (true && ( (true&&!(((int64(getMethod())!=1)))) ) )
            graph->evalOpParm(myPreservetype, nodeidx, "preservetype", 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_PackInjectParms *)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, myGroup);
                break;
            case 1:
                coerceValue(value, myMethod);
                break;
            case 2:
                coerceValue(value, myCollate);
                break;
            case 3:
                coerceValue(value, mySource);
                break;
            case 4:
                coerceValue(value, myMatchAttrib);
                break;
            case 5:
                coerceValue(value, mySrcAttrib);
                break;
            case 6:
                coerceValue(value, myIgnoremissing);
                break;
            case 7:
                coerceValue(value, myPreservetype);
                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(myGroup, ( ( value ) ));
                break;
            case 1:
                coerceValue(myMethod, clampMinValue(0,  clampMaxValue(1,  value ) ));
                break;
            case 2:
                coerceValue(myCollate, clampMinValue(0,  clampMaxValue(3,  value ) ));
                break;
            case 3:
                coerceValue(mySource, ( ( value ) ));
                break;
            case 4:
                coerceValue(myMatchAttrib, ( ( value ) ));
                break;
            case 5:
                coerceValue(mySrcAttrib, ( ( value ) ));
                break;
            case 6:
                coerceValue(myIgnoremissing, ( ( value ) ));
                break;
            case 7:
                coerceValue(myPreservetype, ( ( 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 8;
        switch (idx[0])
        {

        }
        // Invalid
        return 0;
    }

    const char *getNestParmName(TempIndex fieldnum) const override
    {
        if (fieldnum.size() < 1)
            return 0;
        switch (fieldnum[0])
        {
            case 0:
                return "group";
            case 1:
                return "method";
            case 2:
                return "collate";
            case 3:
                return "source";
            case 4:
                return "matchattrib";
            case 5:
                return "srcattrib";
            case 6:
                return "ignoremissing";
            case 7:
                return "preservetype";

        }
        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:
                return PARM_INTEGER;
            case 2:
                return PARM_INTEGER;
            case 3:
                return PARM_INTEGER;
            case 4:
                return PARM_STRING;
            case 5:
                return PARM_STRING;
            case 6:
                return PARM_INTEGER;
            case 7:
                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, myGroup);
        saveData(os, myMethod);
        saveData(os, myCollate);
        saveData(os, mySource);
        saveData(os, myMatchAttrib);
        saveData(os, mySrcAttrib);
        saveData(os, myIgnoremissing);
        saveData(os, myPreservetype);

    }

    bool         load(UT_IStream &is)
    {
        int32           v;
        is.bread(&v, 1);
        if (version() != v)
        {
            // Fail incompatible versions
            return false;
        }
        loadData(is, myGroup);
        loadData(is, myMethod);
        loadData(is, myCollate);
        loadData(is, mySource);
        loadData(is, myMatchAttrib);
        loadData(is, mySrcAttrib);
        loadData(is, myIgnoremissing);
        loadData(is, myPreservetype);

        return true;
    }

    const UT_StringHolder & getGroup() const { return myGroup; }
    void setGroup(const UT_StringHolder & val) { myGroup = val; }
    UT_StringHolder opGroup(const SOP_NodeVerb::CookParms &cookparms) const
    { 
        SOP_Node *thissop = cookparms.getNode();
        if (!thissop) return getGroup();
        UT_StringHolder result;
        OP_Utils::evalOpParm(result, thissop, "group", cookparms.getCookTime(), 0);
        return result;
    }
    Method getMethod() const { return Method(myMethod); }
    void setMethod(Method val) { myMethod = int64(val); }
    Method opMethod(const SOP_NodeVerb::CookParms &cookparms) const
    { 
        SOP_Node *thissop = cookparms.getNode();
        if (!thissop) return getMethod();
        int64 result;
        OP_Utils::evalOpParm(result, thissop, "method", cookparms.getCookTime(), 0);
        return Method(result);
    }
    Collate getCollate() const { return Collate(myCollate); }
    void setCollate(Collate val) { myCollate = int64(val); }
    Collate opCollate(const SOP_NodeVerb::CookParms &cookparms) const
    { 
        SOP_Node *thissop = cookparms.getNode();
        if (!thissop) return getCollate();
        int64 result;
        OP_Utils::evalOpParm(result, thissop, "collate", cookparms.getCookTime(), 0);
        return Collate(result);
    }
    int64 getSource() const { return mySource; }
    void setSource(int64 val) { mySource = val; }
    int64 opSource(const SOP_NodeVerb::CookParms &cookparms) const
    { 
        SOP_Node *thissop = cookparms.getNode();
        if (!thissop) return getSource();
        int64 result;
        OP_Utils::evalOpParm(result, thissop, "source", cookparms.getCookTime(), 0);
        return result;
    }
    const UT_StringHolder & getMatchAttrib() const { return myMatchAttrib; }
    void setMatchAttrib(const UT_StringHolder & val) { myMatchAttrib = val; }
    UT_StringHolder opMatchAttrib(const SOP_NodeVerb::CookParms &cookparms) const
    { 
        SOP_Node *thissop = cookparms.getNode();
        if (!thissop) return getMatchAttrib();
        UT_StringHolder result;
        OP_Utils::evalOpParm(result, thissop, "matchattrib", cookparms.getCookTime(), 0);
        return result;
    }
    const UT_StringHolder & getSrcAttrib() const { return mySrcAttrib; }
    void setSrcAttrib(const UT_StringHolder & val) { mySrcAttrib = val; }
    UT_StringHolder opSrcAttrib(const SOP_NodeVerb::CookParms &cookparms) const
    { 
        SOP_Node *thissop = cookparms.getNode();
        if (!thissop) return getSrcAttrib();
        UT_StringHolder result;
        OP_Utils::evalOpParm(result, thissop, "srcattrib", cookparms.getCookTime(), 0);
        return result;
    }
    bool getIgnoremissing() const { return myIgnoremissing; }
    void setIgnoremissing(bool val) { myIgnoremissing = val; }
    bool opIgnoremissing(const SOP_NodeVerb::CookParms &cookparms) const
    { 
        SOP_Node *thissop = cookparms.getNode();
        if (!thissop) return getIgnoremissing();
        bool result;
        OP_Utils::evalOpParm(result, thissop, "ignoremissing", cookparms.getCookTime(), 0);
        return result;
    }
    bool getPreservetype() const { return myPreservetype; }
    void setPreservetype(bool val) { myPreservetype = val; }
    bool opPreservetype(const SOP_NodeVerb::CookParms &cookparms) const
    { 
        SOP_Node *thissop = cookparms.getNode();
        if (!thissop) return getPreservetype();
        bool result;
        OP_Utils::evalOpParm(result, thissop, "preservetype", cookparms.getCookTime(), 0);
        return result;
    }

private:
    UT_StringHolder myGroup;
    int64 myMethod;
    int64 myCollate;
    int64 mySource;
    UT_StringHolder myMatchAttrib;
    UT_StringHolder mySrcAttrib;
    bool myIgnoremissing;
    bool myPreservetype;

};