GU_Snap.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_Snap.h ( GU Library, C++)
*
* COMMENTS: These routines allow you to snap points together without
*               fusing them.
*/

#ifndef __GU_Snap_h__
#define __GU_Snap_h__

#include "GU_API.h"
#include <GA/GA_Handle.h>
#include <GA/GA_Types.h>
#include <UT/UT_Array.h>
#include <SYS/SYS_Types.h>

class GA_Attribute;
class GU_Detail;

namespace GU_Snap
{
    enum AttributeMergeMethod
    {
        MERGE_ATTRIBUTE_MAX,
        MERGE_ATTRIBUTE_MIN,
        MERGE_ATTRIBUTE_MEAN,
        MERGE_ATTRIBUTE_MODE,
        MERGE_ATTRIBUTE_MEDIAN,
        MERGE_ATTRIBUTE_SUM,
        MERGE_ATTRIBUTE_SUMSQUARE,
        MERGE_ATTRIBUTE_RMS,
        MERGE_ATTRIBUTE_FIRST,
        MERGE_ATTRIBUTE_LAST,
        MERGE_ATTRIBUTE_CONCAT,
        MERGE_ATTRIBUTE_WEIGHTEDMEAN,
        MERGE_ATTRIBUTE_WEIGHTEDSUM,
        MERGE_ATTRIBUTE_MINWEIGHT,
        MERGE_ATTRIBUTE_MAXWEIGHT,
        MERGE_ATTRIBUTE_CONCATORDERED
    };

    struct GU_API AttributeMergeData
    {
        AttributeMergeData(AttributeMergeMethod merge_method,
            const GA_Attribute *src_attrib, GA_Attribute *dest_attrib)
            : myMergeMethod(merge_method)
            , mySrcAttrib(src_attrib)
            , myDestAttrib(dest_attrib)
        {
        }

        AttributeMergeData(AttributeMergeMethod merge_method,
            GA_Attribute *attrib)
            : myMergeMethod(merge_method)
            , mySrcAttrib(attrib)
            , myDestAttrib(attrib)
        {
        }

        AttributeMergeData(AttributeMergeMethod merge_method,
            const GA_Attribute *src_attrib, GA_Attribute *dest_attrib,
            const GA_Attribute *src_weight)
            : myMergeMethod(merge_method)
            , mySrcAttrib(src_attrib)
            , myDestAttrib(dest_attrib)
            , mySrcWeightAttrib(src_weight)
        {
        }

        AttributeMergeMethod myMergeMethod;
        const GA_Attribute *mySrcAttrib;
        GA_Attribute *myDestAttrib;
        // We probably need to add a weight attribute parameter here.
        // Lets see how this is used first in SOP.
        const GA_Attribute *mySrcWeightAttrib = nullptr;
    };

    struct GU_API CommonSnapParms
    {
        CommonSnapParms()
            : myQGroup(nullptr)
            , myTGroup(nullptr)
            , myModifyBothQueryAndTarget(false)
            , myConsolidate(false)
            , myDeleteConsolidated(false)
            , myOutputGroup(nullptr)
        {}

        const GA_ElementGroup *myQGroup;
        const GA_ElementGroup *myTGroup;
        bool myModifyBothQueryAndTarget;

        bool myConsolidate;
        bool myDeleteConsolidated;

        UT_Array<AttributeMergeData> myMergeAttribs;

        GA_ElementGroup *myOutputGroup;
        GA_RWHandleID myOutputAttribH;
    };

    struct GU_API PointSnapParms : public CommonSnapParms
    {
        PointSnapParms()
            : CommonSnapParms()
            , myAlgorithm(ALGORITHM_LOWEST_POINT)
            , myUseMatchAttrib(false)
        {
        }

        enum SnapAlgorithm
        {
            ALGORITHM_LOWEST_POINT,
            ALGORITHM_CLOSEST_POINT
        };

        fpreal myDistance;

        SnapAlgorithm myAlgorithm;

        GA_RWHandleV3 myQPosH;
        GA_ROHandleV3 myTPosH;

        GA_ROHandleF myQPscaleH;
        GA_ROHandleF myTPscaleH;

        GA_ROHandleI myQMatchIntH;
        GA_ROHandleI myTMatchIntH;
        GA_ROHandleF myQMatchFltH;
        GA_ROHandleF myTMatchFltH;
        GA_ROHandleS myQMatchStrH;
        GA_ROHandleS myTMatchStrH;
        float myMatchTol;
        bool myUseMatchAttrib;
        bool myMismatch;
    };

    struct GU_API GridSnapParms : public CommonSnapParms
    {
        GridSnapParms()
            : CommonSnapParms()
        {}

        GA_RWHandleV3 myPosH;
        int myGridSnapType;
        float myXLines;
        float myYLines;
        float myZLines;
        float myXOff;
        float myYOff;
        float myZOff;
        float myTol;
    };

    struct GU_API AttribSnapParms : public CommonSnapParms
    {
        AttribSnapParms()
            : CommonSnapParms()
        {}

        /// This gives indices of target elements to snap query elements to.
        GA_ROHandleID   myTargetElemAttrib;
        GA_AttributeOwner myTargetOwner;
    };
    
    /// Snaps together points in qgdp based on parameters in parms.
    /// If tgdp is null, qgdp is used for both the query
    /// points and target points.
    GU_API void snapPoints(
        GU_Detail &qgdp,
        const GU_Detail *tgdp,
        const PointSnapParms &parms);

    /// NOTE: myTGroup, myModifyBothQueryAndTarget, and myOutputAttribH are NOT
    ///       used by this.
    GU_API void snapGrid(
        GU_Detail &gdp,
        const GridSnapParms &parms);

    /// Snaps query elements to the target elements specified by
    /// parms.myTargetElemAttrib and parms.myTargetOwner.
    GU_API void snapByAttrib(
        GU_Detail &qgdp,
        const GU_Detail *tgdp,
        const AttribSnapParms &parms);
}

#endif