SOP_PackParms.proto.h

Go to the documentation of this file.

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

#include <SOP/SOP_NodeVerb.h>
#include <SOP/SOP_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 <SYS/SYS_Types.h>

using namespace UT::Literal;

class DEP_MicroNode;

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

    SOP_PackParms()
    {
        myViewportLOD = "full"_sh;
        myCreatePath = true;
        myPath = ""_sh;
        myPackByName = false;
        myNameAttrib = "name"_sh;
        myPackedFragments = true;
        myPivot = 1;
        myTransferAttributes = ""_sh;
        myTransferGroups = ""_sh;

    }

    explicit SOP_PackParms(const SOP_PackParms &) = default;

    ~SOP_PackParms() override {}

    bool operator==(const SOP_PackParms &src) const
    {
        if (myViewportLOD != src.myViewportLOD) return false;
        if (myCreatePath != src.myCreatePath) return false;
        if (myPath != src.myPath) return false;
        if (myPackByName != src.myPackByName) return false;
        if (myNameAttrib != src.myNameAttrib) return false;
        if (myPackedFragments != src.myPackedFragments) return false;
        if (myPivot != src.myPivot) return false;
        if (myTransferAttributes != src.myTransferAttributes) return false;
        if (myTransferGroups != src.myTransferGroups) return false;

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



    void        buildFromOp(const SOP_GraphProxy *graph, exint nodeidx, fpreal time, DEP_MicroNode *depnode)
    {
        myViewportLOD = "full"_sh;
        if (true)
            graph->evalOpParm(myViewportLOD, nodeidx, "viewportlod", time, 0);
        myCreatePath = true;
        if (true)
            graph->evalOpParm(myCreatePath, nodeidx, "createpath", time, 0);
        myPath = ""_sh;
        if (true && ( (getCreatePath()) ) )
            graph->evalOpParm(myPath, nodeidx, "path", time, 0);
        myPackByName = false;
        if (true)
            graph->evalOpParm(myPackByName, nodeidx, "packbyname", time, 0);
        myNameAttrib = "name"_sh;
        if (true && ( (getPackByName()) ) )
            graph->evalOpParm(myNameAttrib, nodeidx, "nameattribute", time, 0);
        myPackedFragments = true;
        if (true)
            graph->evalOpParm(myPackedFragments, nodeidx, "packedfragments", time, 0);
        myPivot = 1;
        if (true)
            graph->evalOpParm(myPivot, nodeidx, "pivot", time, 0);
        myTransferAttributes = ""_sh;
        if (true)
            graph->evalOpParm(myTransferAttributes, nodeidx, "transfer_attributes", time, 0);
        myTransferGroups = ""_sh;
        if (true)
            graph->evalOpParm(myTransferGroups, nodeidx, "transfer_groups", time, 0);

    }


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


    void copyFrom(const SOP_NodeParms *src) override
    {
        *this = *((const SOP_PackParms *)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, myViewportLOD);
                break;
            case 1:
                coerceValue(value, myCreatePath);
                break;
            case 2:
                coerceValue(value, myPath);
                break;
            case 3:
                coerceValue(value, myPackByName);
                break;
            case 4:
                coerceValue(value, myNameAttrib);
                break;
            case 5:
                coerceValue(value, myPackedFragments);
                break;
            case 6:
                coerceValue(value, myPivot);
                break;
            case 7:
                coerceValue(value, myTransferAttributes);
                break;
            case 8:
                coerceValue(value, myTransferGroups);
                break;

        }
    }

    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(myViewportLOD, value);
                break;
            case 1:
                coerceValue(myCreatePath, value);
                break;
            case 2:
                coerceValue(myPath, value);
                break;
            case 3:
                coerceValue(myPackByName, value);
                break;
            case 4:
                coerceValue(myNameAttrib, value);
                break;
            case 5:
                coerceValue(myPackedFragments, value);
                break;
            case 6:
                coerceValue(myPivot, value);
                break;
            case 7:
                coerceValue(myTransferAttributes, value);
                break;
            case 8:
                coerceValue(myTransferGroups, 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 9;
        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 "viewportlod";
            case 1:
                return "createpath";
            case 2:
                return "path";
            case 3:
                return "packbyname";
            case 4:
                return "nameattribute";
            case 5:
                return "packedfragments";
            case 6:
                return "pivot";
            case 7:
                return "transfer_attributes";
            case 8:
                return "transfer_groups";

        }
        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_STRING;
            case 3:
                return PARM_INTEGER;
            case 4:
                return PARM_STRING;
            case 5:
                return PARM_INTEGER;
            case 6:
                return PARM_INTEGER;
            case 7:
                return PARM_STRING;
            case 8:
                return PARM_STRING;

        }
        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, myViewportLOD);
        saveData(os, myCreatePath);
        saveData(os, myPath);
        saveData(os, myPackByName);
        saveData(os, myNameAttrib);
        saveData(os, myPackedFragments);
        saveData(os, myPivot);
        saveData(os, myTransferAttributes);
        saveData(os, myTransferGroups);

    }

    bool         load(UT_IStream &is)
    {
        int32           v;
        is.bread(&v, 1);
        if (version() != v)
        {
            // Fail incompatible versions
            return false;
        }
        loadData(is, myViewportLOD);
        loadData(is, myCreatePath);
        loadData(is, myPath);
        loadData(is, myPackByName);
        loadData(is, myNameAttrib);
        loadData(is, myPackedFragments);
        loadData(is, myPivot);
        loadData(is, myTransferAttributes);
        loadData(is, myTransferGroups);

        return true;
    }

    const UT_StringHolder & getViewportLOD() const { return myViewportLOD; }
    void setViewportLOD(const UT_StringHolder & val) { myViewportLOD = val; }
    UT_StringHolder opViewportLOD(const SOP_NodeVerb::CookParms &cookparms) const
    { 
        SOP_Node *thissop = cookparms.getNode();
        if (!thissop) return getViewportLOD();
        UT_StringHolder result;
        OP_Utils::evalOpParm(result, thissop, "viewportlod", cookparms.getCookTime(), 0);
        return result;
    }
    bool getCreatePath() const { return myCreatePath; }
    void setCreatePath(bool val) { myCreatePath = val; }
    bool opCreatePath(const SOP_NodeVerb::CookParms &cookparms) const
    { 
        SOP_Node *thissop = cookparms.getNode();
        if (!thissop) return getCreatePath();
        bool result;
        OP_Utils::evalOpParm(result, thissop, "createpath", cookparms.getCookTime(), 0);
        return result;
    }
    const UT_StringHolder & getPath() const { return myPath; }
    void setPath(const UT_StringHolder & val) { myPath = val; }
    UT_StringHolder opPath(const SOP_NodeVerb::CookParms &cookparms) const
    { 
        SOP_Node *thissop = cookparms.getNode();
        if (!thissop) return getPath();
        UT_StringHolder result;
        OP_Utils::evalOpParm(result, thissop, "path", cookparms.getCookTime(), 0);
        return result;
    }
    bool getPackByName() const { return myPackByName; }
    void setPackByName(bool val) { myPackByName = val; }
    bool opPackByName(const SOP_NodeVerb::CookParms &cookparms) const
    { 
        SOP_Node *thissop = cookparms.getNode();
        if (!thissop) return getPackByName();
        bool result;
        OP_Utils::evalOpParm(result, thissop, "packbyname", cookparms.getCookTime(), 0);
        return result;
    }
    const UT_StringHolder & getNameAttrib() const { return myNameAttrib; }
    void setNameAttrib(const UT_StringHolder & val) { myNameAttrib = val; }
    UT_StringHolder opNameAttrib(const SOP_NodeVerb::CookParms &cookparms) const
    { 
        SOP_Node *thissop = cookparms.getNode();
        if (!thissop) return getNameAttrib();
        UT_StringHolder result;
        OP_Utils::evalOpParm(result, thissop, "nameattribute", cookparms.getCookTime(), 0);
        return result;
    }
    bool getPackedFragments() const { return myPackedFragments; }
    void setPackedFragments(bool val) { myPackedFragments = val; }
    bool opPackedFragments(const SOP_NodeVerb::CookParms &cookparms) const
    { 
        SOP_Node *thissop = cookparms.getNode();
        if (!thissop) return getPackedFragments();
        bool result;
        OP_Utils::evalOpParm(result, thissop, "packedfragments", cookparms.getCookTime(), 0);
        return result;
    }
    int64 getPivot() const { return myPivot; }
    void setPivot(int64 val) { myPivot = val; }
    int64 opPivot(const SOP_NodeVerb::CookParms &cookparms) const
    { 
        SOP_Node *thissop = cookparms.getNode();
        if (!thissop) return getPivot();
        int64 result;
        OP_Utils::evalOpParm(result, thissop, "pivot", cookparms.getCookTime(), 0);
        return result;
    }
    const UT_StringHolder & getTransferAttributes() const { return myTransferAttributes; }
    void setTransferAttributes(const UT_StringHolder & val) { myTransferAttributes = val; }
    UT_StringHolder opTransferAttributes(const SOP_NodeVerb::CookParms &cookparms) const
    { 
        SOP_Node *thissop = cookparms.getNode();
        if (!thissop) return getTransferAttributes();
        UT_StringHolder result;
        OP_Utils::evalOpParm(result, thissop, "transfer_attributes", cookparms.getCookTime(), 0);
        return result;
    }
    const UT_StringHolder & getTransferGroups() const { return myTransferGroups; }
    void setTransferGroups(const UT_StringHolder & val) { myTransferGroups = val; }
    UT_StringHolder opTransferGroups(const SOP_NodeVerb::CookParms &cookparms) const
    { 
        SOP_Node *thissop = cookparms.getNode();
        if (!thissop) return getTransferGroups();
        UT_StringHolder result;
        OP_Utils::evalOpParm(result, thissop, "transfer_groups", cookparms.getCookTime(), 0);
        return result;
    }

private:
    UT_StringHolder myViewportLOD;
    bool myCreatePath;
    UT_StringHolder myPath;
    bool myPackByName;
    UT_StringHolder myNameAttrib;
    bool myPackedFragments;
    int64 myPivot;
    UT_StringHolder myTransferAttributes;
    UT_StringHolder myTransferGroups;

};