EBGeometry_DCEL_Face.hpp

Go to the documentation of this file.

// SPDX-FileCopyrightText: 2022 Robert Marskar <robert.marskar@sintef.no>
//
// SPDX-License-Identifier: GPL-3.0-or-later
 
#ifndef EBGEOMETRY_DCEL_FACE_HPP
#define EBGEOMETRY_DCEL_FACE_HPP
 
// Std includes
#include <cstddef>
#include <memory>
#include <type_traits>
#include <vector>
 
// Our includes
#include "EBGeometry_DCEL.hpp"
#include "EBGeometry_DCEL_Edge.hpp"
#include "EBGeometry_DCEL_Vertex.hpp"
#include "EBGeometry_Polygon2D.hpp"
#include "EBGeometry_Vec.hpp"
 
namespace EBGeometry {
 
namespace DCEL {
 
template <class T, class Meta>
class FaceT
{
  static_assert(std::is_floating_point_v<T>, "FaceT requires a floating-point T");
 
public:
  using Vec3 = Vec3T<T>;
 
  using Vertex = VertexT<T, Meta>;
 
  using Edge = EdgeT<T, Meta>;
 
  using Face = FaceT<T, Meta>;
 
  using VertexPtr = std::shared_ptr<Vertex>;
 
  using EdgePtr = std::shared_ptr<Edge>;
 
  using FacePtr = std::shared_ptr<Face>;
 
  using EdgeIterator = EdgeIteratorT<T, Meta>;
 
  FaceT() = default;
 
  FaceT(const EdgePtr& a_edge);
 
  FaceT(const Face& a_otherFace);
 
  FaceT(Face&& a_otherFace) = default;
 
  ~FaceT() = default;
 
  Face&
  operator=(const Face& a_otherFace) noexcept;
 
  Face&
  operator=(Face&& a_otherFace) = default;
 
  inline void
  define(const Vec3& a_normal, const EdgePtr& a_edge) noexcept;
 
  inline void
  reconcile();
 
  inline void
  computePolygon2D();
 
  inline void
  flipNormal() noexcept;
 
  inline void
  setHalfEdge(const EdgePtr& a_halfEdge) noexcept;
 
  inline void
  setMetaData(const Meta& a_metaData) noexcept;
 
  inline void
  setInsideOutsideAlgorithm(typename Polygon2D<T>::InsideOutsideAlgorithm& a_algorithm) noexcept;
 
  [[nodiscard]] inline EdgePtr
  getHalfEdge() noexcept;
 
  [[nodiscard]] inline EdgePtr
  getHalfEdge() const noexcept;
 
  [[nodiscard]] inline Vec3T<T>&
  getCentroid() noexcept;
 
  [[nodiscard]] inline const Vec3T<T>&
  getCentroid() const noexcept;
 
  [[nodiscard]] inline T&
  getCentroid(const size_t a_dir) noexcept;
 
  [[nodiscard]] inline const T&
  getCentroid(const size_t a_dir) const noexcept;
 
  [[nodiscard]] inline Vec3T<T>&
  getNormal() noexcept;
 
  [[nodiscard]] inline const Vec3T<T>&
  getNormal() const noexcept;
 
  [[nodiscard]] inline T&
  getArea() noexcept;
 
  [[nodiscard]] inline const T&
  getArea() const noexcept;
 
  [[nodiscard]] inline Meta&
  getMetaData() noexcept;
 
  [[nodiscard]] inline const Meta&
  getMetaData() const noexcept;
 
  [[nodiscard]] inline T
  signedDistance(const Vec3& a_x0) const noexcept;
 
  [[nodiscard]] inline T
  unsignedDistance2(const Vec3& a_x0) const noexcept;
 
  [[nodiscard]] inline std::vector<Vec3T<T>>
  getAllVertexCoordinates() const;
 
  [[nodiscard]] inline std::vector<VertexPtr>
  gatherVertices() const;
 
  [[nodiscard]] inline std::vector<EdgePtr>
  gatherEdges() const;
 
  [[nodiscard]] inline Vec3T<T>
  getSmallestCoordinate() const;
 
  [[nodiscard]] inline Vec3T<T>
  getHighestCoordinate() const;
 
protected:
  std::weak_ptr<Edge> m_halfEdge;
 
  Vec3 m_normal = Vec3::zeros();
 
  Vec3 m_centroid = Vec3::zeros();
 
  Meta m_metaData{};
 
  T m_area{T(0)};
 
  std::shared_ptr<Polygon2D<T>> m_poly2 = nullptr;
 
  typename Polygon2D<T>::InsideOutsideAlgorithm m_poly2Algorithm = Polygon2D<T>::InsideOutsideAlgorithm::CrossingNumber;
 
  inline void
  computeCentroid();
 
  inline void
  computeNormal();
 
  inline void
  computeArea();
 
  inline void
  normalizeNormalVector() noexcept;
 
  [[nodiscard]] inline Vec3T<T>
  projectPointIntoFacePlane(const Vec3& a_p) const noexcept;
 
  [[nodiscard]] inline bool
  isPointInsideFace(const Vec3& a_p) const noexcept;
};
} // namespace DCEL
 
} // namespace EBGeometry
 
#include "EBGeometry_DCEL_FaceImplem.hpp"
 
#endif