GEO_SplitPoints.h

Go to the documentation of this file.

/*
 * Copyright (c) 2023
 *      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.
 *
 *----------------------------------------------------------------------------
 * Declarations of functions for splitting points based on vertices or primitives
 */

#pragma once

#ifndef __HDK_GEO_SplitPoints__
#define __HDK_GEO_SplitPoints__

#include <GA/GA_Types.h>
#include <SYS/SYS_Types.h>

class GEO_Detail;
class GA_Range;
class GA_Attribute;
class GA_ElementGroup;

namespace HDK_Sample {

/// group can be a point, vertex, or primitive group to split out
/// new points for all vertices associated with elements in the group,
/// if the points are shared.
/// This splits all points if group is nullptr.
/// Returns the number of points added.
/// This bumps data IDs as necessary if any points are split.
GA_Size GEOsplitPoints(
    GEO_Detail *detail,
    const GA_ElementGroup *group=nullptr);

/// group can be a point, vertex, or primitive group to split out
/// new points for all clusters of vertices in the group where their values are
/// unequal to at least one vertex (whether in the group or not) on the shared point.
/// This splits all points by the attribute if group is nullptr.
/// Returns the number of points added.
/// This bumps data IDs as necessary if any points are split.
GA_Size GEOsplitPointsByAttrib(
    GEO_Detail *detail,
    const GA_ElementGroup *group,
    const GA_Attribute *attrib,
    fpreal tolerance = 0);

/// Returns the number of points added.
/// NOTE: You can use GU_Promote to promote primitive attributes to point attributes.
/// This bumps data IDs as necessary if any points are split.
GA_Size GEOsplitPointsByAttrib(
    GEO_Detail *detail,
    const GA_Range &points,
    const GA_Attribute *attrib,
    fpreal tolerance = 0);

} // End of HDK_Sample namespace

#endif