Finish rebranding of Krita as Chalk

git-svn-id: svn://anonsvn.kde.org/home/kde/branches/trinity/applications/koffice@1238363 283d02a7-25f6-0310-bc7c-ecb5cbfe19da

1 files changed, 78 insertions, 0 deletions

diff --git a/chalk/core/kis_substrate.h b/chalk/core/kis_substrate.h
new file mode 100644
index 00000000..274f2680
--- /dev/null
+++ b/chalk/core/kis_substrate.h
@@ -0,0 +1,78 @@
+/*
+ * Copyright (c) 2006 Boudewijn Rempt ([email protected])
+ *
+ *  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 <tqrect.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?
+    TQ_UINT8 r;           //.Red component of reflectivity
+    TQ_UINT8 g;           // Green component of reflectivity
+    TQ_UINT8 b;           // Blue component of reflectivity
+    TQ_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 TQRect & 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 TQRect & 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