GU_ExtractTransform.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.
 *
 */

#ifndef __GU_ExtractTransform_h__
#define __GU_ExtractTransform_h__

#include "GU_API.h"

#include <UT/UT_Quaternion.h>
#include <UT/UT_Vector3.h>
#include <UT/UT_VectorTypes.h>

class GA_Range;
class GU_Detail;

namespace GU_ExtractTransform
{
/// Specifies whether to only compute the best-fit rigid transform, allow
/// for a (non-)uniform scale, or just compute the full best-fit transform.
enum class Method
{
    Rigid,
    UniformScale,
    NonUniformScale,
    Full
};

struct GU_API Result
{
    UT_Matrix4D getXform() const;

    UT_Vector3D myPivot = {0, 0, 0};
    UT_Vector3D myPosition = {0, 0, 0};
    UT_QuaternionD myRotate = {0, 0, 0, 1};
    UT_Vector3D myScale = {1, 1, 1};
    UT_Vector3D myShear = {0, 0, 0};
    fpreal myDistortion = 0;
};

/// Computes the best-fit transform that aligns the reference geometry (A)
/// points with the target geometry (B) points.
GU_API void solve(const GU_Detail &gdp_a,
                  const GA_Range &pts_a,
                  const GU_Detail &gdp_b,
                  const GA_Range &pts_b,
                  Method method,
                  bool compute_distortion,
                  Result &result);
}

#endif