SOP/SOP_GroupRename.C

/*
 * Copyright (c) 2013
 *      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.
 *
 *----------------------------------------------------------------------------
 * The GroupRename SOP.  This SOP renames groups.
 */

#include <UT/UT_DSOVersion.h>
#include <GU/GU_Detail.h>
#include <PRM/PRM_Include.h>
#include <OP/OP_Operator.h>
#include <OP/OP_OperatorTable.h>
#include "SOP_GroupRename.h"

using namespace HDK_Sample;

void
newSopOperator(OP_OperatorTable *table)
{
     table->addOperator(new OP_Operator("hdk_grouprename",
                                        "GroupRename",
                                         SOP_GroupRename::myConstructor,
                                         SOP_GroupRename::myTemplateList,
                                         1,
                                         1,
                                         0));
}

static PRM_Name        names[] = {
    PRM_Name("oldname", "Old Name"),
    PRM_Name("newname", "New Name"),
};

PRM_Template
SOP_GroupRename::myTemplateList[] = {
    PRM_Template(PRM_STRING,    1, &names[0], 0, &SOP_Node::groupMenu),
    PRM_Template(PRM_STRING,    1, &names[1]),
    PRM_Template(),
};


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

SOP_GroupRename::SOP_GroupRename(OP_Network *net, const char *name, OP_Operator *op)
        : SOP_Node(net, name, op)
{
}

SOP_GroupRename::~SOP_GroupRename() {}

unsigned
SOP_GroupRename::disableParms()
{
    unsigned changed = 0;

    return changed;
}


OP_ERROR
SOP_GroupRename::cookInputGroups(OP_Context &context, int alone)
{
    return error();
}

static bool
sopRenameGroups( const GB_GroupList &grp_list, 
                 const UT_String &from, const UT_String &to )
{
    bool         renamed = false;
    GB_Group    *curr;
    UT_String    string;

    for (curr = grp_list.head(); curr; curr = (GB_Group *)curr->next())
    {
        string.harden(curr->getName());
        string.patternRename(from, to);
        if (strcmp(string, curr->getName()))
        {
            curr->setName(string);
            renamed = true;
        }
    }
    return renamed;
}

OP_ERROR
SOP_GroupRename::cookMySop(OP_Context &context)
{
    double               now = context.getTime();
    UT_String            oldname, newname;

    // Before we do anything, we must lock our inputs.  Before returning,
    //  we have to make sure that the inputs get unlocked.
    if (lockInputs(context) >= UT_ERROR_ABORT)
        return error();

    // Duplicate incoming geometry.
    duplicateSource(0, context);
    
    OLDNAME(oldname, now);
    NEWNAME(newname, now);

    // Rename all matching groups.
    sopRenameGroups(gdp->primitiveGroups(), oldname, newname);
    sopRenameGroups(gdp->pointGroups(), oldname, newname);

    unlockInputs();
    
    return error();
}

const char *
SOP_GroupRename::inputLabel(unsigned) const
{
    return "Geometry to Rename Groups in";
}