File indexing completed on 2025-01-26 04:05:50

 /*
  *  SPDX-FileCopyrightText: 2009 Boudewijn Rempt <boud@valdyas.org>
  *
  *  SPDX-License-Identifier: GPL-2.0-or-later
  */
 
 /**
   @mainpage Brush Engine API
 
 All brush engines in Krita are plugins. The classes in this directory define
 the way brush engines are to be implemented. Brush engines are also known as paintops.
 
 KisPaintInformation         Information about the painting stroke
 KisPaintOp                  Base class for brush engines: paints dots, lines and beziers. A new
                             paintop is created for every stroke.
 KisPaintOpFactory           Creates a paintop and a paintop widget
 KisPaintOpPreset            A KoResource that defines a set of parameters for a paintop. A KisPaintopPreset
                             contains a KisPaintopSettings widget.
 KisPaintOpRegistry          Contains the list of all brush engine plugins
 KisPaintOpSettings          A KisPropertiesConfiguration subclass that stores the settings for a paintop
 KisPaintOpConfigWidget    A KisConfigWidget that knows how to display and edit the KisPaintopSettings
 
 These classes are used in the Krita core to handle painting: a further set
 of utility classes for brush engine implementers is available in
 krita/plugins/paintops/libpaintop.
 
 
 The flow of action is as follows:
 
 <ul>
 
 <li>The resource system loads all paintop presets
 
 <li>The user selects a particular resource in the gui
 
 <li>The system displays the appropriate widget in the gui and fills it
 with the KisPaintopSettings::KisPropertiesConfiguration that defines
 the resource. The user can edit the settings, but they are not
 automatically saved
 
 <li>On mousedown, the paintop factory creates a paintop with a clone
 of the specified settings (for now, we also need to pass the widget to
 the settings class, for historical reasons)
 
 <li>When painting, KisPaintInformation is passed to the paintop
 
 <li>The paintop paints the lines
 
 <li>On mouse-up, the paintop is destroyed
 
 </ul>
 */
 
 #ifndef BRUSHENGINE
 #define BRUSHENGINE
 // Let's keep kRaZy happy
 #endif