GU_PointCapture.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_PointCapture.h ( GU Library, C++)
 *
 * COMMENTS:
 *     GU_PointCapture creates capture weights for use with linear blend skinning.
 *     The technique implemented here allows smooth transformations
 *     with small capture radii.
 */

#ifndef __GU_PointCapture__
#define __GU_PointCapture__

#include "GU_API.h"

#include <UT/UT_StringHolder.h>

#include <SYS/SYS_Types.h>

enum class GU_PointCaptureKernelType
{
    EXPONENTIAL_BUMP,
    TRUNCATED_GAUSSIAN,
    QUADRATIC,
    LINEAR
};

enum class GU_PointCaptureSmoothingMethod
{
    APPROXIMATING,
    INTERPOLATING,
    NONE
};

enum class GU_PointCaptureTetMeshTreatment
{
    AS_SURFACE,
    AS_SOLID,
    NONE
};

struct GU_PointCaptureConfiguration
{
    using KernelType = GU_PointCaptureKernelType;

    double myCaptureRadius;
    KernelType myKernelType;
    
    GU_PointCaptureSmoothingMethod mySmoothingMethod;
    exint mySmoothingLevel;
    
    GU_PointCaptureTetMeshTreatment myTetMeshTreatment;
    
    // If enabled, output the correspondence between rest points
    // and the (subdivided) capture mesh in the form of extra attributes:
    bool myOutputCorrespondence;
};

class GEO_Detail;
class GA_PointGroup;

enum class GU_PointCaptureStatus
{
    PC_FAILED,
    PC_SUCCEEDED,
    PC_INTERRUPTED
};

struct GU_PointCaptureResult
{
    GU_PointCaptureStatus myStatus;

    // Failure message in case myStatus == PC_FAILED
    // Warning message in case myStatus == PC_SUCCEEDED
    // empty string otherwise
    UT_StringHolder myMessage;
};

struct GU_API GU_PointCapture
{
    using Configuration = GU_PointCaptureConfiguration;

    // Create capture weights for each point of 'point_group' on 'detail'
    // based on 'capture_detail'
    GU_PointCaptureResult operator()(
        GEO_Detail& detail,
        const Configuration& configuration,
        const GA_PointGroup*const point_group,
        const GEO_Detail& capture_detail,
        const char*const capture_points_attribute_name,
        const char*const capture_weights_attribute_name
    ) const noexcept;
};

struct GU_SimplexRefineConfiguration
{    
    GU_PointCaptureSmoothingMethod mySmoothingMethod;
    exint mySmoothingLevel;
};


enum class GU_SimplexRefineStatus
{
    PC_FAILED,
    PC_SUCCEEDED,
    PC_INTERRUPTED
};

struct GU_SimplexRefineResult
{
    GU_SimplexRefineStatus myStatus;

    // Failure message in case myStatus == PC_FAILED
    // Warning message in case myStatus == PC_SUCCEEDED
    // empty string otherwise
    UT_StringHolder myMessage;
};

struct GU_API GU_SimplexRefine
{
    using Configuration = GU_SimplexRefineConfiguration;

    GU_SimplexRefineResult operator()(
        GEO_Detail& detail,
        const Configuration& configuration,
        const GEO_Detail& capture_detail
    ) const noexcept;
};

#endif