PolygonEdge.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2011 ISIS Rutherford Appleton Laboratory UKRI,
//   NScD Oak Ridge National Laboratory, European Spallation Source,
//   Institut Laue - Langevin & CSNS, Institute of High Energy Physics, CAS
// SPDX - License - Identifier: GPL - 3.0 +
#pragma once
 
//-----------------------------------------------------------------------------
// Includes
//-----------------------------------------------------------------------------
#include "MantidGeometry/DllConfig.h"
#include "MantidKernel/V2D.h"
 
namespace Mantid {
namespace Geometry {
class MANTID_GEOMETRY_DLL PolygonEdge {
public:
  enum Orientation {
    Collinear,  
    Parallel,   
    Skew,       
    SkewCross,  
    SkewNoCross 
  };
 
  PolygonEdge(const Kernel::V2D &start, const Kernel::V2D &end);
  inline const Kernel::V2D &start() const { return m_start; }
  inline const Kernel::V2D &end() const { return m_end; }
  inline const Kernel::V2D &direction() const { return m_dir; }
  Kernel::V2D point(const double fraction) const;
 
private:
  PolygonEdge();
 
  const Kernel::V2D m_start;
  const Kernel::V2D m_end;
  const Kernel::V2D m_dir;
};
 
enum PointClassification {
  OnLeft,     
  OnRight,    
  Beyond,     
  Behind,     
  Between,    
  Origin,     
  Destination 
};
MANTID_GEOMETRY_DLL PointClassification classify(const Kernel::V2D &pt, const PolygonEdge &edge);
 
MANTID_GEOMETRY_DLL PolygonEdge::Orientation orientation(const PolygonEdge &focusEdge, const PolygonEdge &refEdge,
                                                         double &t);
MANTID_GEOMETRY_DLL PolygonEdge::Orientation crossingPoint(const PolygonEdge &edgeOne, const PolygonEdge &edgeTwo,
                                                           Kernel::V2D &crossPoint);
MANTID_GEOMETRY_DLL bool edgeAimsAt(const PolygonEdge &a, const PolygonEdge &b, PointClassification aclass,
                                    PolygonEdge::Orientation crossType);
 
} // namespace Geometry
} // namespace Mantid