GEO_SplitPoints.h

Go to the documentation of this file.

/*
 * PROPRIETARY INFORMATION.  This software is proprietary to
 * Side Effects Software Inc., and is not to be reproduced,
 * transmitted, or disclosed in any way without written permission.
 *
 * NAME:        GEO_SplitPoints.h (GEO Library, C++)
 *
 * COMMENTS:    Functions for splitting points based on vertices or primitives
 */

#pragma once

#ifndef __GEO_SplitPoints__
#define __GEO_SplitPoints__

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

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

/// 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 GEO_API 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 GEO_API 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 GEO_API GEOsplitPointsByAttrib(
    GEO_Detail *detail,
    const GA_Range &points,
    const GA_Attribute *attrib,
    fpreal tolerance = 0);

#endif