kolourpaint/imagelib/kpFloodFill.h

   1
   2 /*
   3    Copyright (c) 2003-2007 Clarence Dang <dang@kde.org>
   4    All rights reserved.
   5
   6    Redistribution and use in source and binary forms, with or without
   7    modification, are permitted provided that the following conditions
   8    are met:
   9
  10    1. Redistributions of source code must retain the above copyright
  11       notice, this list of conditions and the following disclaimer.
  12    2. Redistributions in binary form must reproduce the above copyright
  13       notice, this list of conditions and the following disclaimer in the
  14       documentation and/or other materials provided with the distribution.
  15
  16    THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  17    IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  18    OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  19    IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  20    INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  21    NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  22    DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  23    THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  24    (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  25    THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  26 */
  27
  28
  29 #ifndef KP_FLOOD_FILL_H
  30 #define KP_FLOOD_FILL_H
  31
  32
  33 #include <kpCommandSize.h>
  34 #include <kpImage.h>
  35
  36
  37 class kpColor;
  38 class kpFillLine;
  39
  40
  41 struct kpFloodFillPrivate;
  42
  43 class kpFloodFill
  44 {
  45 public:
  46     kpFloodFill (kpImage *image, int x, int y,
  47                  const kpColor &color,
  48                  int processedColorSimilarity);
  49     ~kpFloodFill ();
  50
  51
  52     //
  53     // Spits back constructor arguments.
  54     //
  55
  56 public:
  57     kpColor color () const;
  58     int processedColorSimilarity () const;
  59
  60
  61 public:
  62     // Used for calculating the size of a command in the command history.
  63     kpCommandSize::SizeType size () const;
  64
  65
  66     //
  67     // Step 1: Determines the colour that will be changed to color().
  68     //
  69     //         Very fast.
  70     //
  71
  72 public:
  73     void prepareColorToChange ();
  74
  75     // (may invoke prepareColorToChange()).
  76     kpColor colorToChange ();
  77
  78
  79     //
  80     // Step 2: Determines the scanlines / pixels that will be changed to color().
  81     //
  82     //         The slowest part of the whole fill operation.
  83     //
  84     //         Before calling a Step 2 function, you don't have to (but you can)
  85     //         call any of the functions in Step 1.
  86     //
  87
  88 private:
  89     kpColor pixelColor (int x, int y, bool *beenHere = 0) const;
  90     bool shouldGoTo (int x, int y) const;
  91
  92     // Finds the minimum x value at a certain line to be filled.
  93     int findMinX (int y, int x) const;
  94
  95     // Finds the maximum x value at a certain line to be filled.
  96     int findMaxX (int y, int x) const;
  97
  98     void addLine (int y, int x1, int x2);
  99     void findAndAddLines (const kpFillLine &fillLine, int dy);
 100
 101 public:
 102     // (may invoke Step 1's prepareColorToChange())
 103     void prepare ();
 104
 105     // (may invoke prepare())
 106     QRect boundingRect ();
 107
 108
 109     //
 110     // Step 3: Draws the lines identified in Step 2 in color().
 111     //
 112     //         Between the speeds of Step 2 and Step 1.
 113     //
 114     //         Before calling a Step 3 function, you don't have to (but you can)
 115     //         call any of the functions in Step 1 or 2.
 116     //
 117
 118 public:
 119     // (may invoke Step 2's prepare())
 120     void fill ();
 121
 122
 123 private:
 124     kpFloodFillPrivate * const d;
 125 };
 126
 127
 128 #endif  // KP_FLOOD_FILL_H