SOP_SBlend.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 <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 <UT/UT_EnvControl.h>
#include <SYS/SYS_Types.h>

class DEP_MicroNode;

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

    SOP_SBlendParms()
    {
        myBlend = 0;
        myDoPos = true;
        myDoClr = false;
        myDoNml = false;
        myDoUVW = false;
        myDoVoxel = false;
        myDoSlerp = false;
        myPtIDAttr = ""_UTsh;
        myPrimIDAttr = ""_UTsh;

    }

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

    ~SOP_SBlendParms() override {}

    bool operator==(const SOP_SBlendParms &src) const
    {
        if (myBlend != src.myBlend) return false;
        if (myDoPos != src.myDoPos) return false;
        if (myDoClr != src.myDoClr) return false;
        if (myDoNml != src.myDoNml) return false;
        if (myDoUVW != src.myDoUVW) return false;
        if (myDoVoxel != src.myDoVoxel) return false;
        if (myDoSlerp != src.myDoSlerp) return false;
        if (myPtIDAttr != src.myPtIDAttr) return false;
        if (myPrimIDAttr != src.myPrimIDAttr) return false;

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



    void        buildFromOp(const OP_GraphProxy *graph, exint nodeidx, fpreal time, DEP_MicroNode *depnode)
    {
        myBlend = 0;
        if (true)
            graph->evalOpParm(myBlend, nodeidx, "blend", time, 0);
        myDoPos = true;
        if (true)
            graph->evalOpParm(myDoPos, nodeidx, "dopos", time, 0);
        myDoClr = false;
        if (true)
            graph->evalOpParm(myDoClr, nodeidx, "doclr", time, 0);
        myDoNml = false;
        if (true)
            graph->evalOpParm(myDoNml, nodeidx, "donml", time, 0);
        myDoUVW = false;
        if (true)
            graph->evalOpParm(myDoUVW, nodeidx, "douvw", time, 0);
        myDoVoxel = false;
        if (true)
            graph->evalOpParm(myDoVoxel, nodeidx, "dovoxel", time, 0);
        myDoSlerp = false;
        if (true)
            graph->evalOpParm(myDoSlerp, nodeidx, "doslerp", time, 0);
        myPtIDAttr = ""_UTsh;
        if (true)
            graph->evalOpParm(myPtIDAttr, nodeidx, "ptidattr", time, 0);
        myPrimIDAttr = ""_UTsh;
        if (true)
            graph->evalOpParm(myPrimIDAttr, nodeidx, "primidattr", time, 0);

    }


    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_SBlendParms *)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, myBlend);
                break;
            case 1:
                coerceValue(value, myDoPos);
                break;
            case 2:
                coerceValue(value, myDoClr);
                break;
            case 3:
                coerceValue(value, myDoNml);
                break;
            case 4:
                coerceValue(value, myDoUVW);
                break;
            case 5:
                coerceValue(value, myDoVoxel);
                break;
            case 6:
                coerceValue(value, myDoSlerp);
                break;
            case 7:
                coerceValue(value, myPtIDAttr);
                break;
            case 8:
                coerceValue(value, myPrimIDAttr);
                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(myBlend, clampMinValue(0,  ( value ) ));
                break;
            case 1:
                coerceValue(myDoPos, ( ( value ) ));
                break;
            case 2:
                coerceValue(myDoClr, ( ( value ) ));
                break;
            case 3:
                coerceValue(myDoNml, ( ( value ) ));
                break;
            case 4:
                coerceValue(myDoUVW, ( ( value ) ));
                break;
            case 5:
                coerceValue(myDoVoxel, ( ( value ) ));
                break;
            case 6:
                coerceValue(myDoSlerp, ( ( value ) ));
                break;
            case 7:
                coerceValue(myPtIDAttr, ( ( value ) ));
                break;
            case 8:
                coerceValue(myPrimIDAttr, ( ( 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 "blend";
            case 1:
                return "dopos";
            case 2:
                return "doclr";
            case 3:
                return "donml";
            case 4:
                return "douvw";
            case 5:
                return "dovoxel";
            case 6:
                return "doslerp";
            case 7:
                return "ptidattr";
            case 8:
                return "primidattr";

        }
        return 0;
    }

    ParmType getNestParmType(TempIndex fieldnum) const override
    {
        if (fieldnum.size() < 1)
            return PARM_UNSUPPORTED;
        switch (fieldnum[0])
        {
            case 0:
                return PARM_FLOAT;
            case 1:
                return PARM_INTEGER;
            case 2:
                return PARM_INTEGER;
            case 3:
                return PARM_INTEGER;
            case 4:
                return PARM_INTEGER;
            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, myBlend);
        saveData(os, myDoPos);
        saveData(os, myDoClr);
        saveData(os, myDoNml);
        saveData(os, myDoUVW);
        saveData(os, myDoVoxel);
        saveData(os, myDoSlerp);
        saveData(os, myPtIDAttr);
        saveData(os, myPrimIDAttr);

    }

    bool         load(UT_IStream &is)
    {
        int32           v;
        is.bread(&v, 1);
        if (version() != v)
        {
            // Fail incompatible versions
            return false;
        }
        loadData(is, myBlend);
        loadData(is, myDoPos);
        loadData(is, myDoClr);
        loadData(is, myDoNml);
        loadData(is, myDoUVW);
        loadData(is, myDoVoxel);
        loadData(is, myDoSlerp);
        loadData(is, myPtIDAttr);
        loadData(is, myPrimIDAttr);

        return true;
    }

    fpreal64 getBlend() const { return myBlend; }
    void setBlend(fpreal64 val) { myBlend = val; }
    fpreal64 opBlend(const SOP_NodeVerb::CookParms &cookparms) const
    { 
        SOP_Node *thissop = cookparms.getNode();
        if (!thissop) return getBlend();
        fpreal64 result;
        OP_Utils::evalOpParm(result, thissop, "blend", cookparms.getCookTime(), 0);
        return result;
    }
    bool getDoPos() const { return myDoPos; }
    void setDoPos(bool val) { myDoPos = val; }
    bool opDoPos(const SOP_NodeVerb::CookParms &cookparms) const
    { 
        SOP_Node *thissop = cookparms.getNode();
        if (!thissop) return getDoPos();
        bool result;
        OP_Utils::evalOpParm(result, thissop, "dopos", cookparms.getCookTime(), 0);
        return result;
    }
    bool getDoClr() const { return myDoClr; }
    void setDoClr(bool val) { myDoClr = val; }
    bool opDoClr(const SOP_NodeVerb::CookParms &cookparms) const
    { 
        SOP_Node *thissop = cookparms.getNode();
        if (!thissop) return getDoClr();
        bool result;
        OP_Utils::evalOpParm(result, thissop, "doclr", cookparms.getCookTime(), 0);
        return result;
    }
    bool getDoNml() const { return myDoNml; }
    void setDoNml(bool val) { myDoNml = val; }
    bool opDoNml(const SOP_NodeVerb::CookParms &cookparms) const
    { 
        SOP_Node *thissop = cookparms.getNode();
        if (!thissop) return getDoNml();
        bool result;
        OP_Utils::evalOpParm(result, thissop, "donml", cookparms.getCookTime(), 0);
        return result;
    }
    bool getDoUVW() const { return myDoUVW; }
    void setDoUVW(bool val) { myDoUVW = val; }
    bool opDoUVW(const SOP_NodeVerb::CookParms &cookparms) const
    { 
        SOP_Node *thissop = cookparms.getNode();
        if (!thissop) return getDoUVW();
        bool result;
        OP_Utils::evalOpParm(result, thissop, "douvw", cookparms.getCookTime(), 0);
        return result;
    }
    bool getDoVoxel() const { return myDoVoxel; }
    void setDoVoxel(bool val) { myDoVoxel = val; }
    bool opDoVoxel(const SOP_NodeVerb::CookParms &cookparms) const
    { 
        SOP_Node *thissop = cookparms.getNode();
        if (!thissop) return getDoVoxel();
        bool result;
        OP_Utils::evalOpParm(result, thissop, "dovoxel", cookparms.getCookTime(), 0);
        return result;
    }
    bool getDoSlerp() const { return myDoSlerp; }
    void setDoSlerp(bool val) { myDoSlerp = val; }
    bool opDoSlerp(const SOP_NodeVerb::CookParms &cookparms) const
    { 
        SOP_Node *thissop = cookparms.getNode();
        if (!thissop) return getDoSlerp();
        bool result;
        OP_Utils::evalOpParm(result, thissop, "doslerp", cookparms.getCookTime(), 0);
        return result;
    }
    const UT_StringHolder & getPtIDAttr() const { return myPtIDAttr; }
    void setPtIDAttr(const UT_StringHolder & val) { myPtIDAttr = val; }
    UT_StringHolder opPtIDAttr(const SOP_NodeVerb::CookParms &cookparms) const
    { 
        SOP_Node *thissop = cookparms.getNode();
        if (!thissop) return getPtIDAttr();
        UT_StringHolder result;
        OP_Utils::evalOpParm(result, thissop, "ptidattr", cookparms.getCookTime(), 0);
        return result;
    }
    const UT_StringHolder & getPrimIDAttr() const { return myPrimIDAttr; }
    void setPrimIDAttr(const UT_StringHolder & val) { myPrimIDAttr = val; }
    UT_StringHolder opPrimIDAttr(const SOP_NodeVerb::CookParms &cookparms) const
    { 
        SOP_Node *thissop = cookparms.getNode();
        if (!thissop) return getPrimIDAttr();
        UT_StringHolder result;
        OP_Utils::evalOpParm(result, thissop, "primidattr", cookparms.getCookTime(), 0);
        return result;
    }

private:
    fpreal64 myBlend;
    bool myDoPos;
    bool myDoClr;
    bool myDoNml;
    bool myDoUVW;
    bool myDoVoxel;
    bool myDoSlerp;
    UT_StringHolder myPtIDAttr;
    UT_StringHolder myPrimIDAttr;

};