libigl/include/igl/edge_vectors.h

// This file is part of libigl, a simple c++ geometry processing library.
//
// Copyright (C) 2020 Oded Stein <[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_EDGE_VECTORS_H
#define IGL_EDGE_VECTORS_H
#include "igl_inline.h"

#include <Eigen/Dense>
namespace igl
{
  /// Computes the normalized edge vectors for edges in a triangle mesh
  ///
  /// @tparam whether to compute edge perpendiculars
  /// @param[in] V  #V by 3 list of vertex positions
  /// @param[in] F  #F by 3 list of triangle indices
  /// @param[in] E #F by 3 a mapping from each halfedge to each edge
  /// @param[in] oE #F by 3 the orientation (e.g., -1 or 1) of each halfedge
  ///    compared to the orientation of the actual edge, as computed with
  ///    orient_halfedges. will be computed if not provided.
  /// @param[out] vecParallel |HE| list of edge vectors
  /// @param[out] vecPerpendicular |HE| list of vectors perpendicular to vec
  template<bool computePerpendicular=true,
  typename DerivedV,typename DerivedF,typename DerivedE,
  typename DerivedoE, typename DerivedvecParallel,
  typename DerivedvecPerpendicular>
  IGL_INLINE void edge_vectors(
    const Eigen::MatrixBase<DerivedV> &V,
    const Eigen::MatrixBase<DerivedF> &F,
    const Eigen::MatrixBase<DerivedE> &E,
    const Eigen::MatrixBase<DerivedoE> &oE,
    Eigen::PlainObjectBase<DerivedvecParallel> &vecParallel,
    Eigen::PlainObjectBase<DerivedvecPerpendicular> &vecPerpendicular);
  /// \overload
  template<typename DerivedV,typename DerivedF,typename DerivedE,
  typename DerivedoE, typename Derivedvec>
  IGL_INLINE void edge_vectors(
    const Eigen::MatrixBase<DerivedV> &V,
    const Eigen::MatrixBase<DerivedF> &F,
    const Eigen::MatrixBase<DerivedE> &E,
    const Eigen::MatrixBase<DerivedoE> &oE,
    Eigen::PlainObjectBase<Derivedvec> &vec);
}

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

#endif