SOP_VolumeConvolve3.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;
namespace SOP_VolumeConvolve3Enums
{
    enum class Operation
    {
        ADD = 0,
        ADDABS,
        MUL,
        MAX,
        MIN
    };

    SYS_FORCE_INLINE UT_StringHolder
    getToken(Operation enum_value) 
    {
        using namespace UT::Literal;
        switch (enum_value) {
        case Operation::ADD: return "add"_sh;
        case Operation::ADDABS: return "addabs"_sh;
        case Operation::MUL: return "mul"_sh;
        case Operation::MAX: return "max"_sh;
        case Operation::MIN: return "min"_sh;
        default: UT_ASSERT(false); return ""_sh;
        }
    }

}


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

    SOP_VolumeConvolve3Parms()
    {
        myGroup = ""_UTsh;
        myConvolveZM = UT_Matrix3D(0,0,0,0,0,0,0,0,0);
        myConvolveZZ = UT_Matrix3D(0,0,0,0,0,0,0,0,0);
        myConvolveZP = UT_Matrix3D(0,0,0,0,0,0,0,0,0);
        myNormalize = false;
        myOperation = 0;

    }

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

    ~SOP_VolumeConvolve3Parms() override {}

    bool operator==(const SOP_VolumeConvolve3Parms &src) const
    {
        if (myGroup != src.myGroup) return false;
        if (myConvolveZM != src.myConvolveZM) return false;
        if (myConvolveZZ != src.myConvolveZZ) return false;
        if (myConvolveZP != src.myConvolveZP) return false;
        if (myNormalize != src.myNormalize) return false;
        if (myOperation != src.myOperation) return false;

        return true;
    }
    bool operator!=(const SOP_VolumeConvolve3Parms &src) const
    {
        return !operator==(src);
    }
    using Operation = SOP_VolumeConvolve3Enums::Operation;



    void        buildFromOp(const OP_GraphProxy *graph, exint nodeidx, fpreal time, DEP_MicroNode *depnode)
    {
        myGroup = ""_UTsh;
        if (true)
            graph->evalOpParm(myGroup, nodeidx, "group", time, 0);
        myConvolveZM = UT_Matrix3D(0,0,0,0,0,0,0,0,0);
        if (true)
            graph->evalOpParm(myConvolveZM, nodeidx, "convolvezm", time, 0);
        myConvolveZZ = UT_Matrix3D(0,0,0,0,0,0,0,0,0);
        if (true)
            graph->evalOpParm(myConvolveZZ, nodeidx, "convolvezz", time, 0);
        myConvolveZP = UT_Matrix3D(0,0,0,0,0,0,0,0,0);
        if (true)
            graph->evalOpParm(myConvolveZP, nodeidx, "convolvezp", time, 0);
        myNormalize = false;
        if (true)
            graph->evalOpParm(myNormalize, nodeidx, "normalize", time, 0);
        myOperation = 0;
        if (true)
            graph->evalOpParm(myOperation, nodeidx, "operation", 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_VolumeConvolve3Parms *)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, myConvolveZM);
                break;
            case 2:
                coerceValue(value, myConvolveZZ);
                break;
            case 3:
                coerceValue(value, myConvolveZP);
                break;
            case 4:
                coerceValue(value, myNormalize);
                break;
            case 5:
                coerceValue(value, myOperation);
                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(myConvolveZM, ( ( value ) ));
                break;
            case 2:
                coerceValue(myConvolveZZ, ( ( value ) ));
                break;
            case 3:
                coerceValue(myConvolveZP, ( ( value ) ));
                break;
            case 4:
                coerceValue(myNormalize, ( ( value ) ));
                break;
            case 5:
                coerceValue(myOperation, clampMinValue(0,  clampMaxValue(4,  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 6;
        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 "convolvezm";
            case 2:
                return "convolvezz";
            case 3:
                return "convolvezp";
            case 4:
                return "normalize";
            case 5:
                return "operation";

        }
        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_MATRIX3;
            case 2:
                return PARM_MATRIX3;
            case 3:
                return PARM_MATRIX3;
            case 4:
                return PARM_INTEGER;
            case 5:
                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, myConvolveZM);
        saveData(os, myConvolveZZ);
        saveData(os, myConvolveZP);
        saveData(os, myNormalize);
        saveData(os, myOperation);

    }

    bool         load(UT_IStream &is)
    {
        int32           v;
        is.bread(&v, 1);
        if (version() != v)
        {
            // Fail incompatible versions
            return false;
        }
        loadData(is, myGroup);
        loadData(is, myConvolveZM);
        loadData(is, myConvolveZZ);
        loadData(is, myConvolveZP);
        loadData(is, myNormalize);
        loadData(is, myOperation);

        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;
    }
    UT_Matrix3D getConvolveZM() const { return myConvolveZM; }
    void setConvolveZM(UT_Matrix3D val) { myConvolveZM = val; }
    UT_Matrix3D opConvolveZM(const SOP_NodeVerb::CookParms &cookparms) const
    { 
        SOP_Node *thissop = cookparms.getNode();
        if (!thissop) return getConvolveZM();
        UT_Matrix3D result;
        OP_Utils::evalOpParm(result, thissop, "convolvezm", cookparms.getCookTime(), 0);
        return result;
    }
    UT_Matrix3D getConvolveZZ() const { return myConvolveZZ; }
    void setConvolveZZ(UT_Matrix3D val) { myConvolveZZ = val; }
    UT_Matrix3D opConvolveZZ(const SOP_NodeVerb::CookParms &cookparms) const
    { 
        SOP_Node *thissop = cookparms.getNode();
        if (!thissop) return getConvolveZZ();
        UT_Matrix3D result;
        OP_Utils::evalOpParm(result, thissop, "convolvezz", cookparms.getCookTime(), 0);
        return result;
    }
    UT_Matrix3D getConvolveZP() const { return myConvolveZP; }
    void setConvolveZP(UT_Matrix3D val) { myConvolveZP = val; }
    UT_Matrix3D opConvolveZP(const SOP_NodeVerb::CookParms &cookparms) const
    { 
        SOP_Node *thissop = cookparms.getNode();
        if (!thissop) return getConvolveZP();
        UT_Matrix3D result;
        OP_Utils::evalOpParm(result, thissop, "convolvezp", cookparms.getCookTime(), 0);
        return result;
    }
    bool getNormalize() const { return myNormalize; }
    void setNormalize(bool val) { myNormalize = val; }
    bool opNormalize(const SOP_NodeVerb::CookParms &cookparms) const
    { 
        SOP_Node *thissop = cookparms.getNode();
        if (!thissop) return getNormalize();
        bool result;
        OP_Utils::evalOpParm(result, thissop, "normalize", cookparms.getCookTime(), 0);
        return result;
    }
    Operation getOperation() const { return Operation(myOperation); }
    void setOperation(Operation val) { myOperation = int64(val); }
    Operation opOperation(const SOP_NodeVerb::CookParms &cookparms) const
    { 
        SOP_Node *thissop = cookparms.getNode();
        if (!thissop) return getOperation();
        int64 result;
        OP_Utils::evalOpParm(result, thissop, "operation", cookparms.getCookTime(), 0);
        return Operation(result);
    }

private:
    UT_StringHolder myGroup;
    UT_Matrix3D myConvolveZM;
    UT_Matrix3D myConvolveZZ;
    UT_Matrix3D myConvolveZP;
    bool myNormalize;
    int64 myOperation;

};