1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
|
/*
* Copyright (c) 2006 Boudewijn Rempt (boud@valdyas.org)
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
#ifndef KIS_SUBSTRATE_H
#define KIS_SUBSTRATE_H
#include <qrect.h>
#include <ksharedptr.h>
class KisImage;
/// All values are normalized to a range between 0 and 1.
/// XXX: Do we need more?
struct KisSubstratePixel {
float height; // absolute height of the current position
float smoothness; // determines how easily the painting tool "slips" over the surface
float absorbency; // determines how much wetness the substrate can absorb. XXX: How about speed of absorbing?
float density; // XXX?
Q_UINT8 r; //.Red component of reflectivity
Q_UINT8 g; // Green component of reflectivity
Q_UINT8 b; // Blue component of reflectivity
Q_UINT8 alpha; // For composition with the background
};
/**
* This abstract class defines the properties of a substrate -- that is, the simulation
* of the paper or canvas for natural media.
*
* Subclass this interface to define a specific type of substrate: repeating,
* or full-size, with specific and cool ways of generating the surface, or
* maybe based on scans of real substrates.
*/
class KisSubstrate : public KShared {
public:
KisSubstrate(KisImage * /*img*/) : KShared() {};
virtual ~KisSubstrate() {};
/**
* Copy the pixel values in the specified rect into an array of Substrate.
* Make sure the array is big enough!
*/
virtual void getPixels(KisSubstratePixel * substrate, const QRect & rc) const = 0;
/**
* Copy the specified rect of substrate pixels onto the substrate. Make sure
* the array is big enough.
*/
virtual void writePixels(const KisSubstratePixel * substrate, const QRect & rc) = 0;
/**
* Read the value at the specified position into the given substrate pixel.
*/
virtual void getPixel(KisSubstratePixel * ksp, int x, int y) const = 0;
/**
* Copy the value of the given substrate pixel to the specified location.
*/
virtual void writePixel(const KisSubstratePixel & ksp, int x, int y) = 0;
};
#endif
|
