include/basegfx/polygon/b2dpolygonclipper.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef _BGFX_POLYPOLYGON_B2DPOLYGONCLIPPER_HXX
  21 #define _BGFX_POLYPOLYGON_B2DPOLYGONCLIPPER_HXX
  22
  23 #include <basegfx/polygon/b2dpolypolygon.hxx>
  24 #include <basegfx/polygon/b2dpolygon.hxx>
  25 #include <basegfx/basegfxdllapi.h>
  26
  27 //////////////////////////////////////////////////////////////////////////////
  28
  29 namespace basegfx
  30 {
  31     // predefinitions
  32     class B2DRange;
  33
  34     namespace tools
  35     {
  36         // This method clips the given PolyPolygon against a horizontal or vertical axis (parallell to X or Y axis). The axis is
  37         // defined by bParallelToXAxis (true -> it's parallel to the X-Axis of the coordinate system, else to the Y-Axis) and the
  38         // fValueOnOtherAxis (gives the translation to the coordinate system axis). For example, when You want to define
  39         // a clip axis parallel to X.Axis and 100 above it, use bParallelToXAxis = true and fValueOnOtherAxis = 100.
  40         // The value bAboveAxis defines on which side the return value will be (true -> above X, right of Y).
  41         // The switch bStroke decides if the polygon is interpreted as area (false) or strokes (true).
  42         BASEGFX_DLLPUBLIC B2DPolyPolygon clipPolyPolygonOnParallelAxis(const B2DPolyPolygon& rCandidate, bool bParallelToXAxis, bool bAboveAxis, double fValueOnOtherAxis, bool bStroke);
  43         BASEGFX_DLLPUBLIC B2DPolyPolygon clipPolygonOnParallelAxis(const B2DPolygon& rCandidate, bool bParallelToXAxis, bool bAboveAxis, double fValueOnOtherAxis, bool bStroke);
  44
  45         // Clip the given PolyPolygon against the given range. bInside defines if the result will contain the
  46         // parts which are contained in the range or vice versa.
  47         // The switch bStroke decides if the polygon is interpreted as area (false) or strokes (true).
  48         BASEGFX_DLLPUBLIC B2DPolyPolygon clipPolyPolygonOnRange(const B2DPolyPolygon& rCandidate, const B2DRange& rRange, bool bInside, bool bStroke);
  49         BASEGFX_DLLPUBLIC B2DPolyPolygon clipPolygonOnRange(const B2DPolygon& rCandidate, const B2DRange& rRange, bool bInside, bool bStroke);
  50
  51         // Clip given PolyPolygon against given clipping polygon.
  52         // The switch bStroke decides if the polygon is interpreted as area (false) or strokes (true).
  53         // With stroke polygons, You get all line snippets inside rCip.
  54         // With filled polygons, You get all PolyPolygon parts which were inside rClip.
  55         // The switch bInside decides if the parts inside the clip polygon or outside shall be created.
  56         // The clip polygon is always assumed closed, even when it's isClosed() is false.
  57         BASEGFX_DLLPUBLIC B2DPolyPolygon clipPolyPolygonOnPolyPolygon(const B2DPolyPolygon& rCandidate, const B2DPolyPolygon& rClip, bool bInside, bool bStroke);
  58         BASEGFX_DLLPUBLIC B2DPolyPolygon clipPolygonOnPolyPolygon(const B2DPolygon& rCandidate, const B2DPolyPolygon& rClip, bool bInside, bool bStroke);
  59
  60         // clip the given polygon against the given range. the resulting polygon will always contain
  61         // the inside parts which will always be interpreted as areas. the incoming polygon is expected
  62         // to be a simple triangle list. the result is also a simple triangle list.
  63         BASEGFX_DLLPUBLIC B2DPolygon clipTriangleListOnRange( const B2DPolygon& rCandidate, const B2DRange& rRange );
  64
  65     } // end of namespace tools
  66 } // end of namespace basegfx
  67
  68 #endif /* _BGFX_POLYPOLYGON_B2DPOLYGONCLIPPER_HXX */
  69
  70 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */