SOP_VolumeVectorJoin.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;

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

    SOP_VolumeVectorJoinParms()
    {
        mySetcomponents = false;
        myComponents = 4;
        myXgroup = "@name=*.x"_UTsh;
        myYgroup = "@name=*.y"_UTsh;
        myZgroup = "@name=*.z"_UTsh;
        myWgroup = "@name=*.w"_UTsh;
        myKeep = false;

    }

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

    ~SOP_VolumeVectorJoinParms() override {}

    bool operator==(const SOP_VolumeVectorJoinParms &src) const
    {
        if (mySetcomponents != src.mySetcomponents) return false;
        if (myComponents != src.myComponents) return false;
        if (myXgroup != src.myXgroup) return false;
        if (myYgroup != src.myYgroup) return false;
        if (myZgroup != src.myZgroup) return false;
        if (myWgroup != src.myWgroup) return false;
        if (myKeep != src.myKeep) return false;


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

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



    void        buildFromOp(const OP_GraphProxy *graph, exint nodeidx, fpreal time, DEP_MicroNode *depnode)
    {
        mySetcomponents = false;
        if (true)
            graph->evalOpParm(mySetcomponents, nodeidx, "setcomponents", time, graph->isDirect()?nullptr:depnode);
        myComponents = 4;
        if (true && ( (true&&!(((getSetcomponents()==0)))) ) )
            graph->evalOpParm(myComponents, nodeidx, "components", time, graph->isDirect()?nullptr:depnode);
        myXgroup = "@name=*.x"_UTsh;
        if (true)
            graph->evalOpParm(myXgroup, nodeidx, "xgroup", time, graph->isDirect()?nullptr:depnode);
        myYgroup = "@name=*.y"_UTsh;
        if (true && ( (true&&!(((getSetcomponents()==1)&&(int64(getComponents())<2)))) ) )
            graph->evalOpParm(myYgroup, nodeidx, "ygroup", time, graph->isDirect()?nullptr:depnode);
        myZgroup = "@name=*.z"_UTsh;
        if (true && ( (true&&!(((getSetcomponents()==1)&&(int64(getComponents())<3)))) ) )
            graph->evalOpParm(myZgroup, nodeidx, "zgroup", time, graph->isDirect()?nullptr:depnode);
        myWgroup = "@name=*.w"_UTsh;
        if (true && ( (true&&!(((getSetcomponents()==1)&&(int64(getComponents())<4)))) ) )
            graph->evalOpParm(myWgroup, nodeidx, "wgroup", time, graph->isDirect()?nullptr:depnode);
        myKeep = false;
        if (true)
            graph->evalOpParm(myKeep, nodeidx, "keep", 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_VolumeVectorJoinParms *)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, mySetcomponents);
                break;
            case 1:
                coerceValue(value, myComponents);
                break;
            case 2:
                coerceValue(value, myXgroup);
                break;
            case 3:
                coerceValue(value, myYgroup);
                break;
            case 4:
                coerceValue(value, myZgroup);
                break;
            case 5:
                coerceValue(value, myWgroup);
                break;
            case 6:
                coerceValue(value, myKeep);
                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(mySetcomponents, ( ( value ) ));
                break;
            case 1:
                coerceValue(myComponents, clampMinValue(1,  clampMaxValue(4,  value ) ));
                break;
            case 2:
                coerceValue(myXgroup, ( ( value ) ));
                break;
            case 3:
                coerceValue(myYgroup, ( ( value ) ));
                break;
            case 4:
                coerceValue(myZgroup, ( ( value ) ));
                break;
            case 5:
                coerceValue(myWgroup, ( ( value ) ));
                break;
            case 6:
                coerceValue(myKeep, ( ( 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 7;
        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 "setcomponents";
            case 1:
                return "components";
            case 2:
                return "xgroup";
            case 3:
                return "ygroup";
            case 4:
                return "zgroup";
            case 5:
                return "wgroup";
            case 6:
                return "keep";

        }
        return 0;
    }

    ParmType getNestParmType(TempIndex fieldnum) const override
    {
        if (fieldnum.size() < 1)
            return PARM_UNSUPPORTED;
        switch (fieldnum[0])
        {
            case 0:
                return PARM_INTEGER;
            case 1:
                return PARM_INTEGER;
            case 2:
                return PARM_STRING;
            case 3:
                return PARM_STRING;
            case 4:
                return PARM_STRING;
            case 5:
                return PARM_STRING;
            case 6:
                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, mySetcomponents);
        saveData(os, myComponents);
        saveData(os, myXgroup);
        saveData(os, myYgroup);
        saveData(os, myZgroup);
        saveData(os, myWgroup);
        saveData(os, myKeep);

    }

    bool         load(UT_IStream &is)
    {
        int32           v;
        is.bread(&v, 1);
        if (version() != v)
        {
            // Fail incompatible versions
            return false;
        }
        loadData(is, mySetcomponents);
        loadData(is, myComponents);
        loadData(is, myXgroup);
        loadData(is, myYgroup);
        loadData(is, myZgroup);
        loadData(is, myWgroup);
        loadData(is, myKeep);

        return true;
    }

    bool getSetcomponents() const { return mySetcomponents; }
    void setSetcomponents(bool val) { mySetcomponents = val; }
    bool opSetcomponents(const SOP_NodeVerb::CookParms &cookparms) const
    { 
        SOP_Node *thissop = cookparms.getNode();
        if (!thissop) return getSetcomponents();
        bool result;
        OP_Utils::evalOpParm(result, thissop, "setcomponents", cookparms.getCookTime(), 0);
        return result;
    }
    int64 getComponents() const { return myComponents; }
    void setComponents(int64 val) { myComponents = val; }
    int64 opComponents(const SOP_NodeVerb::CookParms &cookparms) const
    { 
        SOP_Node *thissop = cookparms.getNode();
        if (!thissop) return getComponents();
        int64 result;
        OP_Utils::evalOpParm(result, thissop, "components", cookparms.getCookTime(), 0);
        return result;
    }
    const UT_StringHolder & getXgroup() const { return myXgroup; }
    void setXgroup(const UT_StringHolder & val) { myXgroup = val; }
    UT_StringHolder opXgroup(const SOP_NodeVerb::CookParms &cookparms) const
    { 
        SOP_Node *thissop = cookparms.getNode();
        if (!thissop) return getXgroup();
        UT_StringHolder result;
        OP_Utils::evalOpParm(result, thissop, "xgroup", cookparms.getCookTime(), 0);
        return result;
    }
    const UT_StringHolder & getYgroup() const { return myYgroup; }
    void setYgroup(const UT_StringHolder & val) { myYgroup = val; }
    UT_StringHolder opYgroup(const SOP_NodeVerb::CookParms &cookparms) const
    { 
        SOP_Node *thissop = cookparms.getNode();
        if (!thissop) return getYgroup();
        UT_StringHolder result;
        OP_Utils::evalOpParm(result, thissop, "ygroup", cookparms.getCookTime(), 0);
        return result;
    }
    const UT_StringHolder & getZgroup() const { return myZgroup; }
    void setZgroup(const UT_StringHolder & val) { myZgroup = val; }
    UT_StringHolder opZgroup(const SOP_NodeVerb::CookParms &cookparms) const
    { 
        SOP_Node *thissop = cookparms.getNode();
        if (!thissop) return getZgroup();
        UT_StringHolder result;
        OP_Utils::evalOpParm(result, thissop, "zgroup", cookparms.getCookTime(), 0);
        return result;
    }
    const UT_StringHolder & getWgroup() const { return myWgroup; }
    void setWgroup(const UT_StringHolder & val) { myWgroup = val; }
    UT_StringHolder opWgroup(const SOP_NodeVerb::CookParms &cookparms) const
    { 
        SOP_Node *thissop = cookparms.getNode();
        if (!thissop) return getWgroup();
        UT_StringHolder result;
        OP_Utils::evalOpParm(result, thissop, "wgroup", cookparms.getCookTime(), 0);
        return result;
    }
    bool getKeep() const { return myKeep; }
    void setKeep(bool val) { myKeep = val; }
    bool opKeep(const SOP_NodeVerb::CookParms &cookparms) const
    { 
        SOP_Node *thissop = cookparms.getNode();
        if (!thissop) return getKeep();
        bool result;
        OP_Utils::evalOpParm(result, thissop, "keep", cookparms.getCookTime(), 0);
        return result;
    }

private:
    bool mySetcomponents;
    int64 myComponents;
    UT_StringHolder myXgroup;
    UT_StringHolder myYgroup;
    UT_StringHolder myZgroup;
    UT_StringHolder myWgroup;
    bool myKeep;

};