GU_Sort.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:        GU_Sort.h (GU Library, C++)
 *
 * COMMENTS:    Geometry sorting implementations
 */

#include <UT/UT_KDTree.h>
#include <UT/UT_Vector3.h>
#include <UT/UT_VectorTypes.h>
#include <GA/GA_Handle.h>
#include <GA/GA_Range.h>
#include <GA/GA_Types.h>

class GA_Attribute;
class GA_ElementGroup;
class GA_PointGroup;

/// Set the indexattrib value of each element in the range to its GA_Index.
GU_API void GUenumerateElements(
        const GA_RWHandleID &indexattrib,
        const GA_Range &range);

/// Set the indexattrib value of each element in the group to its GA_Index.
GU_API void GUenumerateElements(
        const GA_RWHandleID &indexattrib,
        const GA_ElementGroup *group = nullptr);

///
/// Argsort implementations of GU_Detail's sorting routines.
/// Each fills the provided indexattrib with the sorted indices.
/// Elements excluded from the group are set to their current GA_Index.
/// 
/// If combine_argsort is set to true, the existing indexattrib indices
/// are used for argsorting.
///

/// Attribute argsort
/// @see GU_Detail::sortElements()
GU_API void GUargsortElements(
        const GA_RWHandleID &indexattrib,
        const GA_Attribute *order,
        int component = 0,
        const GA_ElementGroup *group = nullptr,
        bool combine_argsort = false);

/// Axis argsort
/// @see GU_Detail::sortPoints()
GU_API void GUargsortElements(
        const GA_RWHandleID &indexattib,
        GU_AxisType axis,
        const GA_ElementGroup *group = nullptr,
        bool combine_argsort = false);

/// Random argsort
/// @see GU_Detail::sortPoints()
GU_API void GUargsortRandom(
        const GA_RWHandleID &indexattrib,
        int seed,
        bool combine_argsort = false);

/// Shift argsort
/// @see GU_Detail::shiftPoints()
GU_API void GUargsortShift(
        const GA_RWHandleID &indexattrib,
        GA_Size shift,
        const GA_ElementGroup *group = nullptr,
        bool combine_argsort = false);

/// Reverse argsort
/// @see GU_Detail::reversePoints()
GU_API void GUargsortReverse(
        const GA_RWHandleID &indexattrib,
        const GA_ElementGroup *group = nullptr,
        bool combine_argsort = false);

/// Spatial argsort
/// @see GU_Detail::sortPointsSpatial()
GU_API void GUargsortSpatial(
        const GA_RWHandleID &indexattrib,
        const GA_ElementGroup *group = nullptr,
        bool combine_argsort = false);

/// Proximity argsort
/// @see GU_Detail::proximityPoints()
GU_API void GUargsortProximity(
        const GA_RWHandleID &indexattrib,
        UT_Vector3F &point,
        const GA_ElementGroup *group = nullptr,
        bool combine_argsort = false);

/// Vector argsort
/// @see GU_Detail::sortPoints()
GU_API void GUargsortVector(
        const GA_RWHandleID &indexattrib,
        const UT_Vector3F &origin,
        const UT_Vector3F &direction,
        const GA_ElementGroup *group = nullptr,
        bool combine_argsort = false);

/// Vertex argsort
/// @see GU_Detail::vertexOrder()
GU_API void GUargsortPointsByVertexOrder(
        const GA_RWHandleID &indexattrib,
        const GA_PointGroup *group = nullptr,
        bool combine_argsort = false);

/// Sort a component of an attribute as an array
GU_API void GUsortAttribute(
        GA_Attribute *attrib,
        int component = 0,
        bool descending = false);


// A KD-Tree to sort the model's point or primitive positions
class GU_SortKDTree : public UT_KDTree {
public:
    GU_SortKDTree(size_t size)
        : UT_KDTree(3, size)
        , myPos(size)
    {
        myPos.entries(size);
        setMaxLeafNodes(4);
        setBalancer(UT_KD_CENTROID);
    }

    void         setPos(int idx, const UT_Vector3 &pos) { myPos(idx) = pos; }

    const int   *getIndices() const     { return myList; }

    int          comparePosition(int idx0, int idx1, int dim) const override
    {
        return myPos(idx0)[dim] < myPos(idx1)[dim] ? -1 : 1;
    }
    const float *getP(int idx) const override { return myPos(idx).vec; }

private:
    UT_Vector3Array     myPos;
};