SOP_VolumeReduce.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_VolumeReduceEnums
{
    enum class Reduction
    {
        MAX = 0,
        MIN,
        MAXABS,
        MINABS,
        AVERAGE,
        MEDIAN,
        SUM,
        SUMABS,
        SUMSQUARE,
        RMS
    };

    SYS_FORCE_INLINE UT_StringHolder
    getToken(Reduction enum_value) 
    {
        using namespace UT::Literal;
        switch (enum_value) {
        case Reduction::MAX: return "max"_sh;
        case Reduction::MIN: return "min"_sh;
        case Reduction::MAXABS: return "maxabs"_sh;
        case Reduction::MINABS: return "minabs"_sh;
        case Reduction::AVERAGE: return "average"_sh;
        case Reduction::MEDIAN: return "median"_sh;
        case Reduction::SUM: return "sum"_sh;
        case Reduction::SUMABS: return "sumabs"_sh;
        case Reduction::SUMSQUARE: return "sumsquare"_sh;
        case Reduction::RMS: return "rms"_sh;
        default: UT_ASSERT(false); return ""_sh;
        }
    }

    enum class Scaleby
    {
        NONE = 0,
        LENGTH,
        AREA,
        VOLUME
    };

    SYS_FORCE_INLINE UT_StringHolder
    getToken(Scaleby enum_value) 
    {
        using namespace UT::Literal;
        switch (enum_value) {
        case Scaleby::NONE: return "none"_sh;
        case Scaleby::LENGTH: return "length"_sh;
        case Scaleby::AREA: return "area"_sh;
        case Scaleby::VOLUME: return "volume"_sh;
        default: UT_ASSERT(false); return ""_sh;
        }
    }

    enum class Result
    {
        VOLUME = 0,
        VERTEX,
        POINT,
        PRIM,
        DETAIL
    };

    SYS_FORCE_INLINE UT_StringHolder
    getToken(Result enum_value) 
    {
        using namespace UT::Literal;
        switch (enum_value) {
        case Result::VOLUME: return "volume"_sh;
        case Result::VERTEX: return "vertex"_sh;
        case Result::POINT: return "point"_sh;
        case Result::PRIM: return "prim"_sh;
        case Result::DETAIL: return "detail"_sh;
        default: UT_ASSERT(false); return ""_sh;
        }
    }

}


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

    SOP_VolumeReduceParms()
    {
        myGroup = ""_UTsh;
        myReduction = 0;
        myPercentile = 50;
        myScaleby = 0;
        myResult = 0;
        myResultattrib = "density"_UTsh;
        myCreateVarMap = false;
        myResultlvar = ""_UTsh;

    }

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

    ~SOP_VolumeReduceParms() override {}

    bool operator==(const SOP_VolumeReduceParms &src) const
    {
        if (myGroup != src.myGroup) return false;
        if (myReduction != src.myReduction) return false;
        if (myPercentile != src.myPercentile) return false;
        if (myScaleby != src.myScaleby) return false;
        if (myResult != src.myResult) return false;
        if (myResultattrib != src.myResultattrib) return false;
        if (myCreateVarMap != src.myCreateVarMap) return false;
        if (myResultlvar != src.myResultlvar) return false;


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

        return true;
    }
    bool operator!=(const SOP_VolumeReduceParms &src) const
    {
        return !operator==(src);
    }
    using Reduction = SOP_VolumeReduceEnums::Reduction;
    using Scaleby = SOP_VolumeReduceEnums::Scaleby;
    using Result = SOP_VolumeReduceEnums::Result;



    void        buildFromOp(const OP_GraphProxy *graph, exint nodeidx, fpreal time, DEP_MicroNode *depnode)
    {
        myGroup = ""_UTsh;
        if (true)
            graph->evalOpParm(myGroup, nodeidx, "group", time, graph->isDirect()?nullptr:depnode);
        myReduction = 0;
        if (true)
            graph->evalOpParm(myReduction, nodeidx, "reduction", time, graph->isDirect()?nullptr:depnode);
        myPercentile = 50;
        if (true && ( (true&&!(((int64(getReduction())!=5)))) ) )
            graph->evalOpParm(myPercentile, nodeidx, "percentile", time, graph->isDirect()?nullptr:depnode);
        myScaleby = 0;
        if (true)
            graph->evalOpParm(myScaleby, nodeidx, "scaleby", time, graph->isDirect()?nullptr:depnode);
        myResult = 0;
        if (true)
            graph->evalOpParm(myResult, nodeidx, "result", time, graph->isDirect()?nullptr:depnode);
        myResultattrib = "density"_UTsh;
        if (true && ( (true&&!(((int64(getResult())==0)))) ) )
            graph->evalOpParm(myResultattrib, nodeidx, "resultattrib", time, graph->isDirect()?nullptr:depnode);
        myCreateVarMap = false;
        if (true)
            graph->evalOpParm(myCreateVarMap, nodeidx, "createvarmap", time, graph->isDirect()?nullptr:depnode);
        myResultlvar = ""_UTsh;
        if (true && ( (true&&!(((getCreateVarMap()==0))||((int64(getResult())==0)))) ) )
            graph->evalOpParm(myResultlvar, nodeidx, "resultlvar", 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_VolumeReduceParms *)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, myReduction);
                break;
            case 2:
                coerceValue(value, myPercentile);
                break;
            case 3:
                coerceValue(value, myScaleby);
                break;
            case 4:
                coerceValue(value, myResult);
                break;
            case 5:
                coerceValue(value, myResultattrib);
                break;
            case 6:
                coerceValue(value, myCreateVarMap);
                break;
            case 7:
                coerceValue(value, myResultlvar);
                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(myReduction, clampMinValue(0,  clampMaxValue(9,  value ) ));
                break;
            case 2:
                coerceValue(myPercentile, clampMinValue(0,  clampMaxValue(100,  value ) ));
                break;
            case 3:
                coerceValue(myScaleby, clampMinValue(0,  clampMaxValue(3,  value ) ));
                break;
            case 4:
                coerceValue(myResult, clampMinValue(0,  clampMaxValue(4,  value ) ));
                break;
            case 5:
                coerceValue(myResultattrib, ( ( value ) ));
                break;
            case 6:
                coerceValue(myCreateVarMap, ( ( value ) ));
                break;
            case 7:
                coerceValue(myResultlvar, ( ( 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 8;
        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 "reduction";
            case 2:
                return "percentile";
            case 3:
                return "scaleby";
            case 4:
                return "result";
            case 5:
                return "resultattrib";
            case 6:
                return "createvarmap";
            case 7:
                return "resultlvar";

        }
        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_FLOAT;
            case 3:
                return PARM_INTEGER;
            case 4:
                return PARM_INTEGER;
            case 5:
                return PARM_STRING;
            case 6:
                return PARM_INTEGER;
            case 7:
                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, myGroup);
        saveData(os, myReduction);
        saveData(os, myPercentile);
        saveData(os, myScaleby);
        saveData(os, myResult);
        saveData(os, myResultattrib);
        saveData(os, myCreateVarMap);
        saveData(os, myResultlvar);

    }

    bool         load(UT_IStream &is)
    {
        int32           v;
        is.bread(&v, 1);
        if (version() != v)
        {
            // Fail incompatible versions
            return false;
        }
        loadData(is, myGroup);
        loadData(is, myReduction);
        loadData(is, myPercentile);
        loadData(is, myScaleby);
        loadData(is, myResult);
        loadData(is, myResultattrib);
        loadData(is, myCreateVarMap);
        loadData(is, myResultlvar);

        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;
    }
    Reduction getReduction() const { return Reduction(myReduction); }
    void setReduction(Reduction val) { myReduction = int64(val); }
    Reduction opReduction(const SOP_NodeVerb::CookParms &cookparms) const
    { 
        SOP_Node *thissop = cookparms.getNode();
        if (!thissop) return getReduction();
        int64 result;
        OP_Utils::evalOpParm(result, thissop, "reduction", cookparms.getCookTime(), 0);
        return Reduction(result);
    }
    fpreal64 getPercentile() const { return myPercentile; }
    void setPercentile(fpreal64 val) { myPercentile = val; }
    fpreal64 opPercentile(const SOP_NodeVerb::CookParms &cookparms) const
    { 
        SOP_Node *thissop = cookparms.getNode();
        if (!thissop) return getPercentile();
        fpreal64 result;
        OP_Utils::evalOpParm(result, thissop, "percentile", cookparms.getCookTime(), 0);
        return result;
    }
    Scaleby getScaleby() const { return Scaleby(myScaleby); }
    void setScaleby(Scaleby val) { myScaleby = int64(val); }
    Scaleby opScaleby(const SOP_NodeVerb::CookParms &cookparms) const
    { 
        SOP_Node *thissop = cookparms.getNode();
        if (!thissop) return getScaleby();
        int64 result;
        OP_Utils::evalOpParm(result, thissop, "scaleby", cookparms.getCookTime(), 0);
        return Scaleby(result);
    }
    Result getResult() const { return Result(myResult); }
    void setResult(Result val) { myResult = int64(val); }
    Result opResult(const SOP_NodeVerb::CookParms &cookparms) const
    { 
        SOP_Node *thissop = cookparms.getNode();
        if (!thissop) return getResult();
        int64 result;
        OP_Utils::evalOpParm(result, thissop, "result", cookparms.getCookTime(), 0);
        return Result(result);
    }
    const UT_StringHolder & getResultattrib() const { return myResultattrib; }
    void setResultattrib(const UT_StringHolder & val) { myResultattrib = val; }
    UT_StringHolder opResultattrib(const SOP_NodeVerb::CookParms &cookparms) const
    { 
        SOP_Node *thissop = cookparms.getNode();
        if (!thissop) return getResultattrib();
        UT_StringHolder result;
        OP_Utils::evalOpParm(result, thissop, "resultattrib", cookparms.getCookTime(), 0);
        return result;
    }
    bool getCreateVarMap() const { return myCreateVarMap; }
    void setCreateVarMap(bool val) { myCreateVarMap = val; }
    bool opCreateVarMap(const SOP_NodeVerb::CookParms &cookparms) const
    { 
        SOP_Node *thissop = cookparms.getNode();
        if (!thissop) return getCreateVarMap();
        bool result;
        OP_Utils::evalOpParm(result, thissop, "createvarmap", cookparms.getCookTime(), 0);
        return result;
    }
    const UT_StringHolder & getResultlvar() const { return myResultlvar; }
    void setResultlvar(const UT_StringHolder & val) { myResultlvar = val; }
    UT_StringHolder opResultlvar(const SOP_NodeVerb::CookParms &cookparms) const
    { 
        SOP_Node *thissop = cookparms.getNode();
        if (!thissop) return getResultlvar();
        UT_StringHolder result;
        OP_Utils::evalOpParm(result, thissop, "resultlvar", cookparms.getCookTime(), 0);
        return result;
    }

private:
    UT_StringHolder myGroup;
    int64 myReduction;
    fpreal64 myPercentile;
    int64 myScaleby;
    int64 myResult;
    UT_StringHolder myResultattrib;
    bool myCreateVarMap;
    UT_StringHolder myResultlvar;

};