SOP_VolumeBin.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_VolumeBinEnums
{
    enum class Rangemode
    {
        AUTO = 0,
        SPEC
    };

    SYS_FORCE_INLINE UT_StringHolder
    getToken(Rangemode enum_value) 
    {
        using namespace UT::Literal;
        switch (enum_value) {
        case Rangemode::AUTO: return "auto"_sh;
        case Rangemode::SPEC: return "spec"_sh;
        default: UT_ASSERT(false); return ""_sh;
        }
    }

}


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

    SOP_VolumeBinParms()
    {
        myVolume = "density"_UTsh;
        myStencil = "active"_UTsh;
        myDoignore = true;
        myIgnore = 0;
        myBins = 50;
        myRangemode = 0;
        myMinmax = UT_Vector2D(0,1);
        myKeepall = true;
        myKeeprange = UT_Vector2D(0,1);

    }

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

    ~SOP_VolumeBinParms() override {}

    bool operator==(const SOP_VolumeBinParms &src) const
    {
        if (myVolume != src.myVolume) return false;
        if (myStencil != src.myStencil) return false;
        if (myDoignore != src.myDoignore) return false;
        if (myIgnore != src.myIgnore) return false;
        if (myBins != src.myBins) return false;
        if (myRangemode != src.myRangemode) return false;
        if (myMinmax != src.myMinmax) return false;
        if (myKeepall != src.myKeepall) return false;
        if (myKeeprange != src.myKeeprange) return false;


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

        return true;
    }
    bool operator!=(const SOP_VolumeBinParms &src) const
    {
        return !operator==(src);
    }
    using Rangemode = SOP_VolumeBinEnums::Rangemode;



    void        buildFromOp(const OP_GraphProxy *graph, exint nodeidx, fpreal time, DEP_MicroNode *depnode)
    {
        myVolume = "density"_UTsh;
        if (true)
            graph->evalOpParm(myVolume, nodeidx, "volume", time, graph->isDirect()?nullptr:depnode);
        myStencil = "active"_UTsh;
        if (true)
            graph->evalOpParm(myStencil, nodeidx, "stencil", time, graph->isDirect()?nullptr:depnode);
        myDoignore = true;
        if (true)
            graph->evalOpParm(myDoignore, nodeidx, "doignore", time, graph->isDirect()?nullptr:depnode);
        myIgnore = 0;
        if (true && ( (true&&!(((getDoignore()==0)))) ) )
            graph->evalOpParm(myIgnore, nodeidx, "ignore", time, graph->isDirect()?nullptr:depnode);
        myBins = 50;
        if (true)
            graph->evalOpParm(myBins, nodeidx, "bins", time, graph->isDirect()?nullptr:depnode);
        myRangemode = 0;
        if (true)
            graph->evalOpParm(myRangemode, nodeidx, "rangemode", time, graph->isDirect()?nullptr:depnode);
        myMinmax = UT_Vector2D(0,1);
        if (true && ( (true&&!(((int64(getRangemode())==0)))) ) )
            graph->evalOpParm(myMinmax, nodeidx, "minmax", time, graph->isDirect()?nullptr:depnode);
        myKeepall = true;
        if (true)
            graph->evalOpParm(myKeepall, nodeidx, "keepall", time, graph->isDirect()?nullptr:depnode);
        myKeeprange = UT_Vector2D(0,1);
        if (true && ( (true&&!(((getKeepall()==1)))) ) )
            graph->evalOpParm(myKeeprange, nodeidx, "keeprange", 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_VolumeBinParms *)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, myVolume);
                break;
            case 1:
                coerceValue(value, myStencil);
                break;
            case 2:
                coerceValue(value, myDoignore);
                break;
            case 3:
                coerceValue(value, myIgnore);
                break;
            case 4:
                coerceValue(value, myBins);
                break;
            case 5:
                coerceValue(value, myRangemode);
                break;
            case 6:
                coerceValue(value, myMinmax);
                break;
            case 7:
                coerceValue(value, myKeepall);
                break;
            case 8:
                coerceValue(value, myKeeprange);
                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(myVolume, ( ( value ) ));
                break;
            case 1:
                coerceValue(myStencil, ( ( value ) ));
                break;
            case 2:
                coerceValue(myDoignore, ( ( value ) ));
                break;
            case 3:
                coerceValue(myIgnore, ( ( value ) ));
                break;
            case 4:
                coerceValue(myBins, clampMinValue(1,  ( value ) ));
                break;
            case 5:
                coerceValue(myRangemode, clampMinValue(0,  clampMaxValue(1,  value ) ));
                break;
            case 6:
                coerceValue(myMinmax, ( ( value ) ));
                break;
            case 7:
                coerceValue(myKeepall, ( ( value ) ));
                break;
            case 8:
                coerceValue(myKeeprange, clampMinValue(0,  clampMaxValue(1,  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 "volume";
            case 1:
                return "stencil";
            case 2:
                return "doignore";
            case 3:
                return "ignore";
            case 4:
                return "bins";
            case 5:
                return "rangemode";
            case 6:
                return "minmax";
            case 7:
                return "keepall";
            case 8:
                return "keeprange";

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

        }
        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, myVolume);
        saveData(os, myStencil);
        saveData(os, myDoignore);
        saveData(os, myIgnore);
        saveData(os, myBins);
        saveData(os, myRangemode);
        saveData(os, myMinmax);
        saveData(os, myKeepall);
        saveData(os, myKeeprange);

    }

    bool         load(UT_IStream &is)
    {
        int32           v;
        is.bread(&v, 1);
        if (version() != v)
        {
            // Fail incompatible versions
            return false;
        }
        loadData(is, myVolume);
        loadData(is, myStencil);
        loadData(is, myDoignore);
        loadData(is, myIgnore);
        loadData(is, myBins);
        loadData(is, myRangemode);
        loadData(is, myMinmax);
        loadData(is, myKeepall);
        loadData(is, myKeeprange);

        return true;
    }

    const UT_StringHolder & getVolume() const { return myVolume; }
    void setVolume(const UT_StringHolder & val) { myVolume = val; }
    UT_StringHolder opVolume(const SOP_NodeVerb::CookParms &cookparms) const
    { 
        SOP_Node *thissop = cookparms.getNode();
        if (!thissop) return getVolume();
        UT_StringHolder result;
        OP_Utils::evalOpParm(result, thissop, "volume", cookparms.getCookTime(), 0);
        return result;
    }
    const UT_StringHolder & getStencil() const { return myStencil; }
    void setStencil(const UT_StringHolder & val) { myStencil = val; }
    UT_StringHolder opStencil(const SOP_NodeVerb::CookParms &cookparms) const
    { 
        SOP_Node *thissop = cookparms.getNode();
        if (!thissop) return getStencil();
        UT_StringHolder result;
        OP_Utils::evalOpParm(result, thissop, "stencil", cookparms.getCookTime(), 0);
        return result;
    }
    bool getDoignore() const { return myDoignore; }
    void setDoignore(bool val) { myDoignore = val; }
    bool opDoignore(const SOP_NodeVerb::CookParms &cookparms) const
    { 
        SOP_Node *thissop = cookparms.getNode();
        if (!thissop) return getDoignore();
        bool result;
        OP_Utils::evalOpParm(result, thissop, "doignore", cookparms.getCookTime(), 0);
        return result;
    }
    fpreal64 getIgnore() const { return myIgnore; }
    void setIgnore(fpreal64 val) { myIgnore = val; }
    fpreal64 opIgnore(const SOP_NodeVerb::CookParms &cookparms) const
    { 
        SOP_Node *thissop = cookparms.getNode();
        if (!thissop) return getIgnore();
        fpreal64 result;
        OP_Utils::evalOpParm(result, thissop, "ignore", cookparms.getCookTime(), 0);
        return result;
    }
    int64 getBins() const { return myBins; }
    void setBins(int64 val) { myBins = val; }
    int64 opBins(const SOP_NodeVerb::CookParms &cookparms) const
    { 
        SOP_Node *thissop = cookparms.getNode();
        if (!thissop) return getBins();
        int64 result;
        OP_Utils::evalOpParm(result, thissop, "bins", cookparms.getCookTime(), 0);
        return result;
    }
    Rangemode getRangemode() const { return Rangemode(myRangemode); }
    void setRangemode(Rangemode val) { myRangemode = int64(val); }
    Rangemode opRangemode(const SOP_NodeVerb::CookParms &cookparms) const
    { 
        SOP_Node *thissop = cookparms.getNode();
        if (!thissop) return getRangemode();
        int64 result;
        OP_Utils::evalOpParm(result, thissop, "rangemode", cookparms.getCookTime(), 0);
        return Rangemode(result);
    }
    UT_Vector2D getMinmax() const { return myMinmax; }
    void setMinmax(UT_Vector2D val) { myMinmax = val; }
    UT_Vector2D opMinmax(const SOP_NodeVerb::CookParms &cookparms) const
    { 
        SOP_Node *thissop = cookparms.getNode();
        if (!thissop) return getMinmax();
        UT_Vector2D result;
        OP_Utils::evalOpParm(result, thissop, "minmax", cookparms.getCookTime(), 0);
        return result;
    }
    bool getKeepall() const { return myKeepall; }
    void setKeepall(bool val) { myKeepall = val; }
    bool opKeepall(const SOP_NodeVerb::CookParms &cookparms) const
    { 
        SOP_Node *thissop = cookparms.getNode();
        if (!thissop) return getKeepall();
        bool result;
        OP_Utils::evalOpParm(result, thissop, "keepall", cookparms.getCookTime(), 0);
        return result;
    }
    UT_Vector2D getKeeprange() const { return myKeeprange; }
    void setKeeprange(UT_Vector2D val) { myKeeprange = val; }
    UT_Vector2D opKeeprange(const SOP_NodeVerb::CookParms &cookparms) const
    { 
        SOP_Node *thissop = cookparms.getNode();
        if (!thissop) return getKeeprange();
        UT_Vector2D result;
        OP_Utils::evalOpParm(result, thissop, "keeprange", cookparms.getCookTime(), 0);
        return result;
    }

private:
    UT_StringHolder myVolume;
    UT_StringHolder myStencil;
    bool myDoignore;
    fpreal64 myIgnore;
    int64 myBins;
    int64 myRangemode;
    UT_Vector2D myMinmax;
    bool myKeepall;
    UT_Vector2D myKeeprange;

};