Differential D16833 Diff 45340 libs/ui/tool/kis_tool_utils.h

Changeset View

Standalone View

View Options

libs/ui/tool/kis_tool_utils.h

Context not available.
23#include <kis_types.h> 23​#include <kis_types.h>
24#include <kritaui_export.h> 24​#include <kritaui_export.h>
25 25​
26class QPoint; 26​class KisCanvas2;
27​class KoCanvasResourceProvider;
27class KoColor; 28​class KoColor;
29​class QPoint;
30​
31​namespace KisToolUtils { // General tool utilities...
32​/**
33​ * Recursively search a node with a non-transparent pixel
34​ */
35​KisNodeSP KRITAUI_EXPORT findNode(KisNodeSP node, const QPoint &point, bool wholeGroup, bool editableOnly = true);
36​
37​/**
38​ * return true if success
39​ * Clears the image. Selection is optional, use 0 to clear everything.
40​ */
41​bool KRITAUI_EXPORT clearImage(KisImageSP image, KisNodeSP node, KisSelectionSP selection);
42​}
28 43​
29namespace KisToolUtils { 44​//=============================================================================
45​
46​namespace KisPickerUtils { // Color picker utilities...
47​enum SamplingSource {
48​ MERGED_VISIBLE,
49​ CURRENT_LAYER
50​};
51​
52​enum UpdateTarget {
53​ FOREGROUND,
54​ BACKGROUND,
55​ BOTH,
56​ SHIFT, // Shift FG to BG and update FG.
57​ ALTERNATE
58​};
30 59​
31struct KRITAUI_EXPORT ColorPickerConfig { 60​struct KRITAUI_EXPORT ColorPickerConfig {
32 ColorPickerConfig(); 61​ ColorPickerConfig();
33 62​
34 bool toForegroundColor; 63​ SamplingSource source;
35 bool updateColor; 64​ int resampleRateMS;
36 bool addPalette; 65​ bool update;
37 bool normaliseValues; 66​ UpdateTarget target;
38 bool sampleMerged; ​
39 int radius; 67​ int radius;
40 int blend; 68​ int mix;
69​ bool addToPalette;
70​ bool snapToPalette;
71​ bool normalizeColorData;
41 72​
42 void save(bool defaultActivation = true) const; 73​ void save(bool defaultActivation = true) const;
43 void load(bool defaultActivation = true); 74​ void load(bool defaultActivation = true);
Context not available.
51 * out_color - Output parameter returning newly picked color. 82​ * out_color - Output parameter returning newly picked color.
52 * dev - Paint device to pick from. 83​ * dev - Paint device to pick from.
53 * pos - Position to pick from. 84​ * pos - Position to pick from.
54 * blendColor - Optional color to be blended with. 85​ * mixColor - Optional color to be mixed with.
55 * radius - Picking area radius in pixels. 86​ * radius - Picking area radius in pixels.
56 * blend - Blend percentage. 100% all picked, 0% all blendColor. 87​ * mix - Mix percentage. 100% all picked, 0% all mixColor.
57 * pure - Whether to bypass radius, blending, and active layer settings for pure picking. 88​ * pure - Whether to bypass radius, mixing, and active layer settings for pure picking.
58 * 89​ *
59 * RETURN - Returns TRUE whenever a valid color is picked. 90​ * RETURN - Returns TRUE whenever a valid color is picked.
60 */ 91​ */
61bool KRITAUI_EXPORT pickColor(KoColor &out_color, KisPaintDeviceSP dev, const QPoint &pos, 92​bool KRITAUI_EXPORT pickColor(KoColor &out_color, KisPaintDeviceSP sourceDevice, KisCanvas2 *canvas, const QPoint &pos,
62 KoColor const *const blendColor = nullptr, int radius = 1, 93​ KoColor const *const mixColor = nullptr, int radius = 1, int mix = 100, bool pure = false);
63 int blend = 100, bool pure = false); ​
64 94​
65/** 95​void sampleRadius(KoColor &out_color, const KisPaintDeviceSP device, const QPoint position, const int radius);
66 * Recursively search a node with a non-transparent pixel ​
67 */ ​
68KisNodeSP KRITAUI_EXPORT findNode(KisNodeSP node, const QPoint &point, bool wholeGroup, bool editableOnly = true); ​
69 96​
70/** 97​void KRITAUI_EXPORT submitColor(KoCanvasResourceProvider &resourceProvider, UpdateTarget target, KoColor &color);
71 * return true if success ​
72 * Clears the image. Selection is optional, use 0 to clear everything. ​
73 */ ​
74bool KRITAUI_EXPORT clearImage(KisImageSP image, KisNodeSP node, KisSelectionSP selection); ​
75} 98​}
76 99​
77#endif // KIS_TOOL_UTILS_H 100​#endif // KIS_TOOL_UTILS_H
Context not available.