libigl/include/igl/faces_first.h

// This file is part of libigl, a simple c++ geometry processing library.
// 
// Copyright (C) 2013 Alec Jacobson <[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_FACES_FIRST_H
#define IGL_FACES_FIRST_H
#include "igl_inline.h"
namespace igl
{
  /// Reorder vertices so that vertices in face list come before
  /// vertices that don't appear in the face list. This is especially useful if
  /// the face list contains only surface faces and you want surface vertices
  /// listed before internal vertices
  ///
  ///
  /// @tparam MatV  matrix for vertex positions, e.g. Eigen::MatrixXd
  /// @tparam MatF  matrix for face indices, e.g. Eigen::MatrixXi
  /// @tparam VecI  vector for index map, e.g. Eigen::VectorXi
  /// @param[in] V  # vertices by 3 vertex positions
  /// @param[in] F  # faces by 3 list of face indices
  /// @param[out] RV  # vertices by 3 vertex positions, order such that if the jth vertex is
  ///    some face in F, and the kth vertex is not then j comes before k
  /// @param[out] RF  # faces by 3 list of face indices, reindexed to use RV
  /// @param[out] IM  #V by 1 list of indices such that: RF = IM(F) and RT = IM(T)
  ///    and RV(IM,:) = V
  ///
  ///
  /// #### Example:
  /// \code{cpp}
  ///   // Tet mesh in (V,T,F)
  ///   faces_first(V,F,IM);
  ///   T = T.unaryExpr(bind1st(mem_fun( static_cast<VectorXi::Scalar&
  ///     (VectorXi::*)(VectorXi::Index)>(&VectorXi::operator())),
  ///     &IM)).eval();
  /// \endcode
  template <typename MatV, typename MatF, typename VecI>
  IGL_INLINE void faces_first(
    const MatV & V, 
    const MatF & F, 
    MatV & RV, 
    MatF & RF, 
    VecI & IM);
  /// \overload
  template <typename MatV, typename MatF, typename VecI>
  IGL_INLINE void faces_first(
    MatV & V, 
    MatF & F, 
    VecI & IM);
}

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

#endif