SOP_SplitPointsHDK.C

Go to the documentation of this file.

/*
 * Copyright (c) 2024
 *      Side Effects Software Inc.  All rights reserved.
 *
 * Redistribution and use of Houdini Development Kit samples in source and
 * binary forms, with or without modification, are permitted provided that the
 * following conditions are met:
 * 1. Redistributions of source code must retain the above copyright notice,
 *    this list of conditions and the following disclaimer.
 * 2. The name of Side Effects Software may not be used to endorse or
 *    promote products derived from this software without specific prior
 *    written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY SIDE EFFECTS SOFTWARE `AS IS' AND ANY EXPRESS
 * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN
 * NO EVENT SHALL SIDE EFFECTS SOFTWARE BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
 * OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
 * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 *----------------------------------------------------------------------------
 * This SOP splits points, optionally limited based on differences in vertex
 * or primitive attributes.
 */

#include "SOP_SplitPointsHDK.proto.h"

#include "GEO_SplitPoints.h"

#include <SOP/SOP_Node.h>
#include <GU/GU_Detail.h>
#include <GU/GU_Promote.h>
#include <PRM/PRM_Include.h>
#include <PRM/PRM_TemplateBuilder.h>
#include <UT/UT_Assert.h>
#include <UT/UT_DSOVersion.h>

using namespace UT::Literal;

namespace HDK_Sample {

//******************************************************************************
//*                 Setup                                                      *
//******************************************************************************

class SOP_SplitPointsHDKVerb : public SOP_NodeVerb
{
public:
    SOP_SplitPointsHDKVerb() {}
    virtual ~SOP_SplitPointsHDKVerb() {}

    virtual SOP_NodeParms *allocParms() const { return new SOP_SplitPointsHDKParms(); }
    virtual UT_StringHolder name() const { return theSOPTypeName; }

    virtual CookMode cookMode(const SOP_NodeParms *parms) const { return COOK_INPLACE; }

    virtual void cook(const CookParms &cookparms) const;

    /// This is the internal name of the SOP type.
    /// It isn't allowed to be the same as any other SOP's type name.
    static const UT_StringHolder theSOPTypeName;

    /// This static data member automatically registers
    /// this verb class at library load time.
    static const SOP_NodeVerb::Register<SOP_SplitPointsHDKVerb> theVerb;

    /// This is the parameter interface string, below.
    static const char *const theDsFile;
};

// The static member variable definitions have to be outside the class definition.
// The declarations are inside the class.
const UT_StringHolder SOP_SplitPointsHDKVerb::theSOPTypeName("hdk_splitpoints"_sh);
const SOP_NodeVerb::Register<SOP_SplitPointsHDKVerb> SOP_SplitPointsHDKVerb::theVerb;

/// This is the SOP class definition.
class SOP_SplitPointsHDK : public SOP_Node
{
public:
    SOP_SplitPointsHDK(OP_Network *net, const char *, OP_Operator *entry);
    virtual ~SOP_SplitPointsHDK();

    virtual OP_ERROR cookInputGroups(OP_Context &context, int alone);

    static OP_Node *myConstructor(OP_Network  *net, const char *name, OP_Operator *entry);
    static PRM_Template *buildTemplates();
    virtual const SOP_NodeVerb *cookVerb() const;

    static void buildAttribMenu(
        void *data, PRM_Name *entries, int size,
        const PRM_SpareData *, const PRM_Parm *);

    virtual OP_ERROR cookMySop(OP_Context &context);
};

static GA_GroupType
sopSplitPointsGroupType(SOP_SplitPointsHDKParms::GroupType parmgrouptype)
{
    using namespace SOP_SplitPointsHDKEnums;
    switch (parmgrouptype)
    {
        case GroupType::GUESS:      return GA_GROUP_INVALID;    break;
        case GroupType::POINTS:     return GA_GROUP_POINT;      break;
        case GroupType::PRIMS:      return GA_GROUP_PRIMITIVE;  break;
        case GroupType::VERTICES:   return GA_GROUP_VERTEX;     break;
    }
    UT_ASSERT_MSG(0, "Unhandled group type!");
    return GA_GROUP_INVALID;
}

void
SOP_SplitPointsHDK::buildAttribMenu(
    void *data, PRM_Name *entries, int size,
    const PRM_SpareData *, const PRM_Parm *)
{
    SOP_SplitPointsHDK *sop = (SOP_SplitPointsHDK *)data;
    if (!sop)
        return;

    const int input = 0; // input from which to obtain attribs

    sop->fillAttribNameMenu(entries, size, GA_ATTRIB_VERTEX, input);
}
static PRM_ChoiceList  sop_attribmenu(
    (PRM_ChoiceListType)(PRM_CHOICELIST_TOGGLE),
    SOP_SplitPointsHDK::buildAttribMenu);

PRM_Template*
SOP_SplitPointsHDK::buildTemplates()
{
    static PRM_TemplateBuilder templ("SOP_SplitPointsHDK.C"_sh, SOP_SplitPointsHDKVerb::theDsFile);
    if (templ.justBuilt())
    {
        templ.setChoiceListPtr("group", &SOP_Node::pointGroupMenu);
        templ.setChoiceListPtr("attribname", &sop_attribmenu);
    }
    return templ.templates();
}

OP_Node *
SOP_SplitPointsHDK::myConstructor(OP_Network *net,const char *name,OP_Operator *entry)
{
    return new SOP_SplitPointsHDK(net, name, entry);
}


SOP_SplitPointsHDK::SOP_SplitPointsHDK(OP_Network *net, const char *name, OP_Operator *entry)
    : SOP_Node(net, name, entry)
{
    mySopFlags.setManagesDataIDs(true);
}

SOP_SplitPointsHDK::~SOP_SplitPointsHDK()
{}

OP_ERROR
SOP_SplitPointsHDK::cookInputGroups(OP_Context &context, int alone)
{
    UT_ASSERT(alone);

    GA_GroupType grouptype = sopSplitPointsGroupType(
        (SOP_SplitPointsHDKEnums::GroupType)evalInt("grouptype"_sh, 0, context.getTime()));

    const GA_Group *group;
    cookInputAllGroups(
        context,
        group,
        alone != 0,
        true,   // do_selection
        0,      // group parm index
        1,      // group type parm index
        grouptype,
        true,   // allow_reference
        false   // is_default_prim
        );
    return error();
}

OP_ERROR
SOP_SplitPointsHDK::cookMySop(OP_Context &context)
{
    return cookMyselfAsVerb(context);
}

const SOP_NodeVerb *
SOP_SplitPointsHDK::cookVerb() const 
{ 
    return SOP_SplitPointsHDKVerb::theVerb.get();
}

} // End of HDK_Sample namespace

/// newSopOperator is the hook that Houdini grabs from this dll
/// and invokes to register the SOP.  In this case, we add ourselves
/// to the specified operator table.
void newSopOperator(OP_OperatorTable *table)
{
    table->addOperator(new OP_Operator(
        HDK_Sample::SOP_SplitPointsHDKVerb::theSOPTypeName, // Internal name
        "HDK Split Points",                                 // UI name
        HDK_Sample::SOP_SplitPointsHDK::myConstructor,      // How to build the SOP
        HDK_Sample::SOP_SplitPointsHDK::buildTemplates(),   // My parameters
        1,      // Min # of sources
        1,      // Max # of sources
        nullptr,// Custom local variables (none)
        0));    // No flags: not a generator, no merge input, not an output
}

namespace HDK_Sample {

//******************************************************************************
//*                 Parameters                                                 *
//******************************************************************************

/// This is a multi-line raw string specifying the parameter interface for this SOP.
const char *const SOP_SplitPointsHDKVerb::theDsFile = R"THEDSFILE(
{
    name        parameters
    parm {
        name    "group"
        label   "Group"
        type    string
        default { "" }
        parmtag { "script_action" "import soputils\nkwargs['geometrytype'] = kwargs['node'].parmTuple('grouptype')\nkwargs['inputindex'] = 0\nsoputils.selectGroupParm(kwargs)" }
        parmtag { "script_action_help" "Select geometry from an available viewport.\nShift-click to turn on Select Groups." }
        parmtag { "script_action_icon" "BUTTONS_reselect" }
    }
    parm {
        name    "grouptype"
        cppname "GroupType"
        label   "Group Type"
        type    ordinal
        default { "0" }
        menu    {
            "guess"     "Guess from Group"
            "vertices"  "Vertices"
            "points"    "Points"
            "prims"     "Primitives"
        }
    }
    parm {
        name    "useattrib"
        cppname "UseAttrib"
        label   "Limit by Attribute"
        type    toggle
        default { "0" }
        nolabel
        joinnext
    }
    parm {
        name    "attribname"
        cppname "AttribName"
        label   "Attributes"
        type    string
        default { "N" }
        disablewhen "{ useattrib == 0 }"
    }
    parm {
        name    "tol"
        label   "Tolerance"
        type    log
        default { "0.001" }
        range   { 0! 1 }
        disablewhen "{ useattrib == 0 }"
    }
    parm {
        name    "promote"
        label   "Promote to Point Attribute"
        type    toggle
        default { "0" }
        disablewhen "{ useattrib == 0 }"
    }
}
)THEDSFILE";


void
SOP_SplitPointsHDKVerb::cook(const SOP_NodeVerb::CookParms &cookparms) const
{
    auto &&sopparms = cookparms.parms<SOP_SplitPointsHDKParms>();
    GU_Detail *gdp = cookparms.gdh().gdpNC();
    GOP_Manager gop;

    const GA_ElementGroup *group = nullptr;

    const UT_StringHolder &groupname = sopparms.getGroup();
    if (groupname.isstring())
    {
        GA_GroupType grouptype = sopSplitPointsGroupType(sopparms.getGroupType());

        bool ok = true;
        const GA_Group *anygroup = gop.parseGroupDetached(groupname, grouptype, gdp, true, false, ok);

        if (!ok || (anygroup && !anygroup->isElementGroup()))
        {
            cookparms.sopAddWarning(SOP_ERR_BADGROUP, groupname);
        }
        if (anygroup && anygroup->isElementGroup())
        {
            group = UTverify_cast<const GA_ElementGroup *>(anygroup);
        }
    }
    notifyGroupParmListeners(cookparms.getNode(), 0, 1, gdp, group);

    if (sopparms.getUseAttrib() && sopparms.getAttribName().isstring())
    {
        fpreal tolerance = sopparms.getTol();
        const bool promote = sopparms.getPromote();

        const char *pattern = sopparms.getAttribName().c_str();
        if (UT_String::multiMatchCheck(pattern))
        {
            UT_StringArray attribsToPromote;
            auto &&functor = [pattern,promote,gdp,group,tolerance,&attribsToPromote](GA_Attribute *attrib)
            {
                UT_String attribname_string(attrib->getName().c_str());
                if (!attribname_string.multiMatch(pattern))
                    return;

                // NOTE: This will bump any data IDs as needed, if any points are split.
                GEOsplitPointsByAttrib(gdp, group, attrib, tolerance);

                if (promote)
                {
                    // Don't promote the attributes while iterating over them
                    attribsToPromote.append(attrib->getName());
                }
            };

            // NOTE: The iteration order must be alphabetical, instead of
            //       the hash table order, for consistency.
            for (auto it = gdp->vertexAttribs().obegin(GA_SCOPE_PUBLIC); !it.atEnd(); ++it)
                functor(it.item());
            for (exint i = 0; i < attribsToPromote.size(); ++i)
            {
                GA_Attribute *attrib = gdp->findAttribute(GA_ATTRIB_VERTEX, GA_SCOPE_PUBLIC, attribsToPromote[i]);
                if (attrib)
                    GU_Promote::promote(*gdp, attrib, GA_ATTRIB_POINT, true, GU_Promote::GU_PROMOTE_FIRST);
            }
            attribsToPromote.clear();

            for (auto it = gdp->primitiveAttribs().obegin(GA_SCOPE_PUBLIC); !it.atEnd(); ++it)
                functor(it.item());
            for (exint i = 0; i < attribsToPromote.size(); ++i)
            {
                GA_Attribute *attrib = gdp->findAttribute(GA_ATTRIB_PRIMITIVE, GA_SCOPE_PUBLIC, attribsToPromote[i]);
                if (attrib)
                    GU_Promote::promote(*gdp, attrib, GA_ATTRIB_POINT, true, GU_Promote::GU_PROMOTE_FIRST);
            }
            attribsToPromote.clear();

            for (auto it = gdp->vertexAttribs().obegin(GA_SCOPE_GROUP); !it.atEnd(); ++it)
                functor(it.item());
            for (exint i = 0; i < attribsToPromote.size(); ++i)
            {
                GA_ElementGroup *cur_group = gdp->findVertexGroup(attribsToPromote[i]);
                if (cur_group && !cur_group->isInternal())
                    GU_Promote::promote(*gdp, cur_group, GA_ATTRIB_POINT, true, GU_Promote::GU_PROMOTE_FIRST);
            }
            attribsToPromote.clear();

            for (auto it = gdp->primitiveAttribs().obegin(GA_SCOPE_GROUP); !it.atEnd(); ++it)
                functor(it.item());
            for (exint i = 0; i < attribsToPromote.size(); ++i)
            {
                GA_ElementGroup *cur_group = gdp->findPrimitiveGroup(attribsToPromote[i]);
                if (cur_group && !cur_group->isInternal())
                    GU_Promote::promote(*gdp, cur_group, GA_ATTRIB_POINT, true, GU_Promote::GU_PROMOTE_FIRST);
            }
            attribsToPromote.clear();
        }
        else
        {
            GA_Attribute *attrib = gdp->vertexAttribs().find(GA_SCOPE_PUBLIC, sopparms.getAttribName());
            if (!attrib)
            {
                attrib = gdp->primitiveAttribs().find(GA_SCOPE_PUBLIC, sopparms.getAttribName());
                if (!attrib)
                {
                    // The attribute should be able to be a group, so that we
                    // can easily split along group boundaries.
                    attrib = gdp->vertexGroups().find(sopparms.getAttribName());
                    if (!attrib)
                    {
                        attrib = gdp->primitiveGroups().find(sopparms.getAttribName());
                        if (!attrib)
                        {
                            cookparms.sopAddWarning(SOP_MESSAGE, "Couldn't find specified vertex or primitive attribute");
                            return;
                        }
                    }
                }
            }

            // NOTE: This will bump any data IDs as needed, if any points are split.
            GEOsplitPointsByAttrib(gdp, group, attrib, tolerance);

            if (promote)
            {
                GU_Promote::promote(*gdp, attrib, GA_ATTRIB_POINT, true, GU_Promote::GU_PROMOTE_FIRST);
            }
        }
    }
    else if (!sopparms.getUseAttrib())
    {
        // NOTE: This will bump any data IDs as needed, if any points are split.
        GEOsplitPoints(gdp, group);
    }
}

} // End of HDK_Sample namespace