SOP_ExtractTransform.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_ExtractTransformEnums
{
    enum class PieceAttribClass
    {
        PRIMITIVE = 0,
        POINT
    };

    SYS_FORCE_INLINE UT_StringHolder
    getToken(PieceAttribClass enum_value) 
    {
        using namespace UT::Literal;
        switch (enum_value) {
        case PieceAttribClass::PRIMITIVE: return "primitive"_sh;
        case PieceAttribClass::POINT: return "point"_sh;
        default: UT_ASSERT(false); return ""_sh;
        }
    }

    enum class ExtractionMethod
    {
        RIGID = 0,
        UNIFORMSCALE,
        NONUNIFORMSCALE,
        FULL
    };

    SYS_FORCE_INLINE UT_StringHolder
    getToken(ExtractionMethod enum_value) 
    {
        using namespace UT::Literal;
        switch (enum_value) {
        case ExtractionMethod::RIGID: return "rigid"_sh;
        case ExtractionMethod::UNIFORMSCALE: return "uniformscale"_sh;
        case ExtractionMethod::NONUNIFORMSCALE: return "nonuniformscale"_sh;
        case ExtractionMethod::FULL: return "full"_sh;
        default: UT_ASSERT(false); return ""_sh;
        }
    }

    enum class OutputAttribs
    {
        INSTANCEATTRS = 0,
        MATRIX3,
        MATRIX4
    };

    SYS_FORCE_INLINE UT_StringHolder
    getToken(OutputAttribs enum_value) 
    {
        using namespace UT::Literal;
        switch (enum_value) {
        case OutputAttribs::INSTANCEATTRS: return "instanceattrs"_sh;
        case OutputAttribs::MATRIX3: return "matrix3"_sh;
        case OutputAttribs::MATRIX4: return "matrix4"_sh;
        default: UT_ASSERT(false); return ""_sh;
        }
    }

}


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

    SOP_ExtractTransformParms()
    {
        myUsePieceAttrib = false;
        myPieceAttrib = "name"_UTsh;
        myPieceAttribClass = 0;
        myExtractionMethod = 0;
        myOutputAttribs = 0;
        myComputeDistortion = false;
        myDistortionAttrib = "distortion"_UTsh;

    }

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

    ~SOP_ExtractTransformParms() override {}

    bool operator==(const SOP_ExtractTransformParms &src) const
    {
        if (myUsePieceAttrib != src.myUsePieceAttrib) return false;
        if (myPieceAttrib != src.myPieceAttrib) return false;
        if (myPieceAttribClass != src.myPieceAttribClass) return false;
        if (myExtractionMethod != src.myExtractionMethod) return false;
        if (myOutputAttribs != src.myOutputAttribs) return false;
        if (myComputeDistortion != src.myComputeDistortion) return false;
        if (myDistortionAttrib != src.myDistortionAttrib) return false;


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

        return true;
    }
    bool operator!=(const SOP_ExtractTransformParms &src) const
    {
        return !operator==(src);
    }
    using PieceAttribClass = SOP_ExtractTransformEnums::PieceAttribClass;
    using ExtractionMethod = SOP_ExtractTransformEnums::ExtractionMethod;
    using OutputAttribs = SOP_ExtractTransformEnums::OutputAttribs;



    void        buildFromOp(const OP_GraphProxy *graph, exint nodeidx, fpreal time, DEP_MicroNode *depnode)
    {
        myUsePieceAttrib = false;
        if (true)
            graph->evalOpParm(myUsePieceAttrib, nodeidx, "usepieceattrib", time, graph->isDirect()?nullptr:depnode);
        myPieceAttrib = "name"_UTsh;
        if (true && ( (true&&!(((getUsePieceAttrib()==0)))) ) )
            graph->evalOpParm(myPieceAttrib, nodeidx, "pieceattrib", time, graph->isDirect()?nullptr:depnode);
        myPieceAttribClass = 0;
        if (true && ( (true&&!(((getUsePieceAttrib()==0)))) ) )
            graph->evalOpParm(myPieceAttribClass, nodeidx, "pieceattribclass", time, graph->isDirect()?nullptr:depnode);
        myExtractionMethod = 0;
        if (true)
            graph->evalOpParm(myExtractionMethod, nodeidx, "extractionmethod", time, graph->isDirect()?nullptr:depnode);
        myOutputAttribs = 0;
        if (true)
            graph->evalOpParm(myOutputAttribs, nodeidx, "outputattribs", time, graph->isDirect()?nullptr:depnode);
        myComputeDistortion = false;
        if (true)
            graph->evalOpParm(myComputeDistortion, nodeidx, "computedistortion", time, graph->isDirect()?nullptr:depnode);
        myDistortionAttrib = "distortion"_UTsh;
        if (true && ( (true&&!(((getComputeDistortion()==0)))) ) )
            graph->evalOpParm(myDistortionAttrib, nodeidx, "distortionattrib", 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_ExtractTransformParms *)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, myUsePieceAttrib);
                break;
            case 1:
                coerceValue(value, myPieceAttrib);
                break;
            case 2:
                coerceValue(value, myPieceAttribClass);
                break;
            case 3:
                coerceValue(value, myExtractionMethod);
                break;
            case 4:
                coerceValue(value, myOutputAttribs);
                break;
            case 5:
                coerceValue(value, myComputeDistortion);
                break;
            case 6:
                coerceValue(value, myDistortionAttrib);
                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(myUsePieceAttrib, ( ( value ) ));
                break;
            case 1:
                coerceValue(myPieceAttrib, ( ( value ) ));
                break;
            case 2:
                coerceValue(myPieceAttribClass, clampMinValue(0,  clampMaxValue(1,  value ) ));
                break;
            case 3:
                coerceValue(myExtractionMethod, clampMinValue(0,  clampMaxValue(3,  value ) ));
                break;
            case 4:
                coerceValue(myOutputAttribs, clampMinValue(0,  clampMaxValue(2,  value ) ));
                break;
            case 5:
                coerceValue(myComputeDistortion, ( ( value ) ));
                break;
            case 6:
                coerceValue(myDistortionAttrib, ( ( 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 "usepieceattrib";
            case 1:
                return "pieceattrib";
            case 2:
                return "pieceattribclass";
            case 3:
                return "extractionmethod";
            case 4:
                return "outputattribs";
            case 5:
                return "computedistortion";
            case 6:
                return "distortionattrib";

        }
        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_STRING;
            case 2:
                return PARM_INTEGER;
            case 3:
                return PARM_INTEGER;
            case 4:
                return PARM_INTEGER;
            case 5:
                return PARM_INTEGER;
            case 6:
                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, myUsePieceAttrib);
        saveData(os, myPieceAttrib);
        saveData(os, myPieceAttribClass);
        saveData(os, myExtractionMethod);
        saveData(os, myOutputAttribs);
        saveData(os, myComputeDistortion);
        saveData(os, myDistortionAttrib);

    }

    bool         load(UT_IStream &is)
    {
        int32           v;
        is.bread(&v, 1);
        if (version() != v)
        {
            // Fail incompatible versions
            return false;
        }
        loadData(is, myUsePieceAttrib);
        loadData(is, myPieceAttrib);
        loadData(is, myPieceAttribClass);
        loadData(is, myExtractionMethod);
        loadData(is, myOutputAttribs);
        loadData(is, myComputeDistortion);
        loadData(is, myDistortionAttrib);

        return true;
    }

    bool getUsePieceAttrib() const { return myUsePieceAttrib; }
    void setUsePieceAttrib(bool val) { myUsePieceAttrib = val; }
    bool opUsePieceAttrib(const SOP_NodeVerb::CookParms &cookparms) const
    { 
        SOP_Node *thissop = cookparms.getNode();
        if (!thissop) return getUsePieceAttrib();
        bool result;
        OP_Utils::evalOpParm(result, thissop, "usepieceattrib", cookparms.getCookTime(), 0);
        return result;
    }
    const UT_StringHolder & getPieceAttrib() const { return myPieceAttrib; }
    void setPieceAttrib(const UT_StringHolder & val) { myPieceAttrib = val; }
    UT_StringHolder opPieceAttrib(const SOP_NodeVerb::CookParms &cookparms) const
    { 
        SOP_Node *thissop = cookparms.getNode();
        if (!thissop) return getPieceAttrib();
        UT_StringHolder result;
        OP_Utils::evalOpParm(result, thissop, "pieceattrib", cookparms.getCookTime(), 0);
        return result;
    }
    PieceAttribClass getPieceAttribClass() const { return PieceAttribClass(myPieceAttribClass); }
    void setPieceAttribClass(PieceAttribClass val) { myPieceAttribClass = int64(val); }
    PieceAttribClass opPieceAttribClass(const SOP_NodeVerb::CookParms &cookparms) const
    { 
        SOP_Node *thissop = cookparms.getNode();
        if (!thissop) return getPieceAttribClass();
        int64 result;
        OP_Utils::evalOpParm(result, thissop, "pieceattribclass", cookparms.getCookTime(), 0);
        return PieceAttribClass(result);
    }
    ExtractionMethod getExtractionMethod() const { return ExtractionMethod(myExtractionMethod); }
    void setExtractionMethod(ExtractionMethod val) { myExtractionMethod = int64(val); }
    ExtractionMethod opExtractionMethod(const SOP_NodeVerb::CookParms &cookparms) const
    { 
        SOP_Node *thissop = cookparms.getNode();
        if (!thissop) return getExtractionMethod();
        int64 result;
        OP_Utils::evalOpParm(result, thissop, "extractionmethod", cookparms.getCookTime(), 0);
        return ExtractionMethod(result);
    }
    OutputAttribs getOutputAttribs() const { return OutputAttribs(myOutputAttribs); }
    void setOutputAttribs(OutputAttribs val) { myOutputAttribs = int64(val); }
    OutputAttribs opOutputAttribs(const SOP_NodeVerb::CookParms &cookparms) const
    { 
        SOP_Node *thissop = cookparms.getNode();
        if (!thissop) return getOutputAttribs();
        int64 result;
        OP_Utils::evalOpParm(result, thissop, "outputattribs", cookparms.getCookTime(), 0);
        return OutputAttribs(result);
    }
    bool getComputeDistortion() const { return myComputeDistortion; }
    void setComputeDistortion(bool val) { myComputeDistortion = val; }
    bool opComputeDistortion(const SOP_NodeVerb::CookParms &cookparms) const
    { 
        SOP_Node *thissop = cookparms.getNode();
        if (!thissop) return getComputeDistortion();
        bool result;
        OP_Utils::evalOpParm(result, thissop, "computedistortion", cookparms.getCookTime(), 0);
        return result;
    }
    const UT_StringHolder & getDistortionAttrib() const { return myDistortionAttrib; }
    void setDistortionAttrib(const UT_StringHolder & val) { myDistortionAttrib = val; }
    UT_StringHolder opDistortionAttrib(const SOP_NodeVerb::CookParms &cookparms) const
    { 
        SOP_Node *thissop = cookparms.getNode();
        if (!thissop) return getDistortionAttrib();
        UT_StringHolder result;
        OP_Utils::evalOpParm(result, thissop, "distortionattrib", cookparms.getCookTime(), 0);
        return result;
    }

private:
    bool myUsePieceAttrib;
    UT_StringHolder myPieceAttrib;
    int64 myPieceAttribClass;
    int64 myExtractionMethod;
    int64 myOutputAttribs;
    bool myComputeDistortion;
    UT_StringHolder myDistortionAttrib;

};