src/foam/algorithms/polygon/clipping/SutherlandHodgman.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | foam-extend: Open Source CFD
   4    \\    /   O peration     | Version:     3.2
   5     \\  /    A nd           | Web:         http://www.foam-extend.org
   6      \\/     M anipulation  | For copyright notice see file Copyright
   7 -------------------------------------------------------------------------------
   8 License
   9     This file is part of foam-extend.
  10
  11     foam-extend is free software: you can redistribute it and/or modify it
  12     under the terms of the GNU General Public License as published by the
  13     Free Software Foundation, either version 3 of the License, or (at your
  14     option) any later version.
  15
  16     foam-extend is distributed in the hope that it will be useful, but
  17     WITHOUT ANY WARRANTY; without even the implied warranty of
  18     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  19     General Public License for more details.
  20
  21     You should have received a copy of the GNU General Public License
  22     along with foam-extend.  If not, see <http://www.gnu.org/licenses/>.
  23
  24 Class
  25     SutherlandHodgman
  26
  27 Description
  28     This is an implementation of the Sutherland Hodgman algorithm:
  29     Reentrant Polygon Clipping, Sutherland, Hodgman,
  30     Communications of the ACM, 1974
  31
  32     Wikipedia has a very simple Pseudo-Code example of this algorithm
  33     http://en.wikipedia.org/wiki/Sutherland-Hodgeman.
  34
  35     The subject polygon will be clipped by the clipping polygon.
  36
  37 Author
  38     Martin Beaudoin, Hydro-Quebec, (2008)
  39
  40 SourceFiles
  41     SutherlandHodgmanI.H
  42     SutherlandHodgman.C
  43
  44 \*---------------------------------------------------------------------------*/
  45
  46 #ifndef SutherlandHodgman_H
  47 #define SutherlandHodgman_H
  48
  49 #include "DynamicList.H"
  50 #include "point2D.H"
  51
  52 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  53
  54 namespace Foam
  55 {
  56
  57 /*---------------------------------------------------------------------------*\
  58                       Class SutherlandHodgman Declaration
  59 \*---------------------------------------------------------------------------*/
  60
  61 class SutherlandHodgman
  62 {
  63     // Private data
  64
  65         //- The current subjectPolygon
  66         List<point2D> subjectPolygon_;
  67
  68         //- The clipping polygon
  69         List<point2D> clippingPolygon_;
  70
  71         //- Clipped edge, polygon 1
  72         label currentClipEdgeP1_;
  73
  74         //- Clipped edge, polygon 2
  75         label currentClipEdgeP2_;
  76
  77         //- Tolerance for detecting intersecting segment
  78         scalar intersectSegDistTol_;
  79
  80
  81     // Private Member Functions
  82
  83         //- Disallow default bitwise copy construct
  84         SutherlandHodgman(const SutherlandHodgman&);
  85
  86         //- Disallow default bitwise assignment
  87         void operator=(const SutherlandHodgman&);
  88
  89
  90         //- Compute intersection between 2 line segments
  91         bool lineSegmentIntersection
  92         (
  93             const point2D& p1,
  94             const point2D& p2,
  95             const point2D& p3,
  96             const point2D& p4,
  97             point2D& intersectionPoint
  98         ) const;
  99
 100         //- Evaluate if point is visible from current clipping segment
 101         inline bool isPointVisibleFromCuttingSegment
 102         (
 103             const point2D& p
 104         ) const;
 105
 106         //- Compute intersection between clipping polygon current segment
 107         //  and the line formed by the point p1, p2
 108         inline bool clipSegment
 109         (
 110             const point2D& p1,
 111             const point2D& p2,
 112             point2D& intersectionPoint
 113         ) const;
 114
 115
 116 public:
 117
 118     // Constructors
 119
 120         //- Construct from component
 121         SutherlandHodgman
 122         (
 123             const List<point2D>& clippingPolygon,
 124             const List<point2D>& subjectPolygon,
 125             const scalar& intersectSegDistTol
 126         );
 127
 128
 129     // Destructor - default
 130
 131
 132     // Member Functions
 133
 134         // Implements the actual algorithm.
 135         List<point2D> evaluate();
 136 };
 137
 138
 139 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 140
 141 } // End namespace Foam
 142
 143 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 144
 145 #include "SutherlandHodgmanI.H"
 146
 147 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 148
 149 #endif
 150
 151 // ************************************************************************* //