vcl/inc/regband.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 INCLUDED_VCL_INC_REGBAND_HXX
  21 #define INCLUDED_VCL_INC_REGBAND_HXX
  22
  23 #include <tools/long.hxx>
  24
  25 /*
  26
  27 class ImplRegionBand
  28
  29 This class handles one y-band of the region. In this band may contain one
  30 or more separations in x-direction. The y-Band do not contain any
  31 separation after creation.
  32
  33 The separations are modified with basic clipping functions like Union and
  34 Intersection - the Class will process the clipping for the actual band.
  35
  36 */
  37
  38 // element for the list with x-separations
  39 struct ImplRegionBandSep
  40 {
  41     ImplRegionBandSep*          mpNextSep;
  42     tools::Long                        mnXLeft;
  43     tools::Long                        mnXRight;
  44     bool                        mbRemoved;
  45 };
  46
  47 enum class LineType { Ascending, Descending };
  48
  49 // element for the list with x-separations
  50 struct ImplRegionBandPoint
  51 {
  52     ImplRegionBandPoint*        mpNextBandPoint;
  53     tools::Long                        mnX;
  54     tools::Long                        mnLineId;
  55     bool                        mbEndPoint;
  56     LineType                    meLineType;
  57 };
  58
  59 class ImplRegionBand
  60 {
  61 public:
  62     ImplRegionBand*             mpNextBand;         // pointer to the next element of the list
  63     ImplRegionBand*             mpPrevBand;         // pointer to the previous element of the list (only used temporarily)
  64     ImplRegionBandSep*          mpFirstSep;         // root of the list with x-separations
  65     ImplRegionBandPoint*        mpFirstBandPoint;   // root of the list with lines
  66     tools::Long                        mnYTop;             // actual boundary of the band
  67     tools::Long                        mnYBottom;
  68
  69     bool                        mbTouched : 1;
  70
  71                                 // create y-band with boundaries
  72                                 ImplRegionBand( tools::Long nYTop, tools::Long nYBottom );
  73                                 /** copy y-band with all data
  74                                     @param theSourceBand
  75                                         The new ImplRegionBand object will
  76                                         be a copy of this band.
  77                                     @param bIgnorePoints
  78                                         When true (the default) the
  79                                         band points pointed to by
  80                                         mpFirstBandPoint are not copied.
  81                                         When false they are copied.
  82                                         You need the points when you are
  83                                         planning to call ProcessPoints()
  84                                         later on.
  85                                 */
  86                                 ImplRegionBand( const ImplRegionBand & theSourceBand,
  87                                                 const bool bIgnorePoints = true);
  88                                 ~ImplRegionBand();
  89
  90     tools::Long                        GetXLeftBoundary() const;
  91     tools::Long                        GetXRightBoundary() const;
  92
  93                                 // combine overlapping bands
  94     void                        OptimizeBand();
  95
  96                                 // generate separations from lines and process
  97                                 // union with existing separations
  98     void                        ProcessPoints();
  99                                 // insert point in the list for later processing
 100     bool                        InsertPoint( tools::Long nX, tools::Long nLineID,
 101                                              bool bEndPoint, LineType eLineType );
 102
 103     void                        Union( tools::Long nXLeft, tools::Long nXRight );
 104     void                        Intersect( tools::Long nXLeft, tools::Long nXRight );
 105     void                        Exclude( tools::Long nXLeft, tools::Long nXRight );
 106     void                        XOr( tools::Long nXLeft, tools::Long nXRight );
 107
 108     void                        MoveX( tools::Long nHorzMove );
 109     void                        ScaleX( double fHorzScale );
 110
 111     bool                        Contains( tools::Long nX );
 112
 113     bool                        IsEmpty() const { return ((!mpFirstSep) && (!mpFirstBandPoint)); }
 114
 115     bool                        operator==( const ImplRegionBand& rRegionBand ) const;
 116
 117     /** Split the called band at the given vertical coordinate.  After the
 118         split the called band will cover the upper part not including nY.
 119         The new band will cover the lower part including nY.
 120         @param nY
 121             The band is split at this y coordinate.  The new, lower band
 122             will include this very value.
 123         @return
 124             Returns the new, lower band.
 125     */
 126     ImplRegionBand*             SplitBand (const sal_Int32 nY);
 127 };
 128
 129 #endif // INCLUDED_VCL_INC_REGBAND_HXX
 130
 131 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */