GU_GuideCapture.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 Library (C++)
 *
 * COMMENTS:    Guide Shape Interpolation capture — assigns guide curve
 *              influences to each groom curve based on spatial proximity
 *              and arc-length shape similarity.
 */

#ifndef __GU_GuideCapture_h__
#define __GU_GuideCapture_h__

#include "GU_API.h"
#include <UT/UT_Array.h>
#include <UT/UT_VectorTypes.h>

class GU_Detail;

/// Parameters for guide shape interpolation capture.
struct GU_API GU_GuideCaptureParms
{
    int   max_candidates       = 32;
    float search_radius        = 0.2f;
    int   nsamples             = 20;
    int   min_guides           = 1;
    int   max_guides           = 8;
    float sigma_scale          = 0.1f;
    float weight_threshold     = 0.1f;
    float length_penalty_scale = 0.0f;
};

/// Capture groom curves against guide curves using arc-length shape similarity.
///
/// Outputs are in CSR (Compressed Sparse Row) format:
///   guidestarts  — nprims+1 entries; guidestarts[i]..guidestarts[i+1] is curve i's range
///   guideindices — flat guide prim indices
///   guideweights — flat normalised weights (sum to 1 per curve)
///
/// Returns false if groom or guides have no primitives.
GU_API bool GU_GuideCaptureShape(
    UT_IntArray   &guidestarts,
    UT_IntArray   &guideindices,
    UT_FloatArray &guideweights,
    const GU_Detail &groom,
    const GU_Detail &guides,
    const GU_GuideCaptureParms &parms);

#endif // __GU_GuideCapture_h__