libigl/include/igl/frame_field_deformer.h

// This file is part of libigl, a simple c++ geometry processing library.
//
// Copyright (C) 2014 Daniele Panozzo <[email protected]>
//
// This Source Code Form is subject to the terms of the Mozilla Public License
// v. 2.0. If a copy of the MPL was not distributed with this file, You can
// obtain one at http://mozilla.org/MPL/2.0/.
#ifndef IGL_FRAME_FIELD_DEFORMER_H
#define IGL_FRAME_FIELD_DEFORMER_H
#include "igl_inline.h"

#include <Eigen/Dense>

namespace igl
{
  /// Deform a mesh to transform the given per-face frame field to be as close
  /// as possible to a cross field, in the least square sense.
  ///
  /// @param[in] V       #V by 3 coordinates of the vertices
  /// @param[in] F       #F by 3 list of mesh faces (must be triangles)
  /// @param[in] FF1     #F by 3 first representative vector of the frame field
  /// @param[in] FF2     #F by 3 second representative vector of the frame field
  /// @param[out] V_d     #V? by 3 deformed, first representative vector??
  /// @param[out] FF1_d     #F by 3 deformed, first representative vector??
  /// @param[out] FF2_d     #F by 3 deformed, first representative vector??
  /// @param[in] iterations  number of iterations
  /// @param[in] lambda  laplacian regularization parameter 0=no regularization 1=full regularization
  /// @param[in] perturb_initial_guess  whether to perturb the initial guess
  IGL_INLINE void frame_field_deformer(
    const Eigen::MatrixXd& V,
    const Eigen::MatrixXi& F,
    const Eigen::MatrixXd& FF1,
    const Eigen::MatrixXd& FF2,
    Eigen::MatrixXd&       V_d,
    Eigen::MatrixXd&       FF1_d,
    Eigen::MatrixXd&       FF2_d,
    const int              iterations = 50,
    const double           lambda = 0.1,
    const bool             perturb_initial_guess = true);

}

#ifndef IGL_STATIC_LIBRARY
#  include "frame_field_deformer.cpp"
#endif

#endif