GeometricOperations.hpp

#ifndef DM_GEOMETRIC_OPERATION_HPP_INCLUDED
#define DM_GEOMETRIC_OPERATION_HPP_INCLUDED

#ifdef _MSC_VER
  #pragma once
#endif

#include "DM/config.hpp"
#include "DM/AutoLink.hpp"
#include "DM/IGeometry.hpp"
#include "DM/IPoint.hpp"
#include "DM/IPolyline.hpp"
#include "DM/IPolygon.hpp"
#include "DM/IWindow.hpp"


DM_NAMESPACE_BEGIN

/// \brief provides a set of geometric operations for geometry objects (e.g. intersection, join, differences, etc. )
namespace GeometricOperations
{

  /// \brief Intersects a polyline with a polygon object (clipping)
  /** 
    The intersection process is done in 2D. The heights of new points will be computed from the height information of the 
    corresponding intersecting segments. In case both segments have height information available, the height at the new point
    will be averaged. This behavior can be changed by enabling or disabling the ignorePolygonHeights flag. If the flag is
    disabled (=default behavior) height information of polygon vertices will be ignored for height computation of new points. 
    Hence, only the polyline height values will play a roll.

    \param[in]  line                  polyline object to be clipped (object stays unchanged)
    \param[in]  polygon               polygon object use for clipping
    \param[in]  keepPointOrder        Flag if orientation of the resulting line should be preserved (e.g. 
                                      important for profiles). If the orientation is irrelevant disable the flag
                                      to improve processing speed.
    \param[in]  ignorePolygonHeights  enabling or disabling heights of polygon vertices for compute new points (see details)
    \return clipped polyline object
  */
  PolylineHandle  DM_API intersect(const IPolyline &line, const IPolygon &polygon,  
                                   bool keepPointOrder = false, bool ignorePolygonHeights = false);
  PolylineHandle  DM_API intersect(const IPolygon &polygon,  const IPolyline &line, 
                                   bool keepPointOrder = false, bool ignorePolygonHeights = false); ///< see above


  /// \brief intersection of two polygon objects (polygon1 'and' polygon2)
  /// whereas polylines only represents the boundary, polygons represent the full area of closed regions. hence, 
  /// the intersection of two polygons resulting a polygon containing the overlapping area of the source polygons 
  PolygonHandle   DM_API intersect(const IPolygon &polygon1, const IPolygon &polygon2);

  /// \brief intersection of two window objects (window1 'and' window2)
  /// if the two windows do not intersect and empty handle is returned
  WindowHandle    DM_API intersect(const IWindow &window1, const IWindow &window2);


  /// \brief join of two polygons (polygon1 'or' polygon2)
  PolygonHandle   DM_API join(const IPolygon &polygon1, const IPolygon &polygon2);

  /// \brief difference of two polygons (polygon1 \ polygon2)
  PolygonHandle   DM_API difference(const IPolygon &polygon1, const IPolygon &polygon2);

  /// \brief symmetric difference of two polygons ((polygon1 \ polygon2) 'or' (polygon2 \ polygon1))
  PolygonHandle   DM_API symmetric_difference(const IPolygon &polygon1, const IPolygon &polygon2);


  /// point-in-polygon test
  bool DM_API isIntersecting(const IPoint   &pt,      const IPolygon &polygon);
  bool DM_API isIntersecting(const IPolygon &polygon, const IPoint   &pt     ); ///< see above
}

DM_NAMESPACE_END


#endif //DM_GEOMETRIC_OPERATION_HPP_INCLUDED