#127 move the calibrator into the library for common use.

Author: dave

examples/esp32Amplifier/TouchCalibrator.h

@@ -19,8 +19,8 @@
 #include <tcMenuVersion.h>
 #include "AmplifierController.h"
 #include "app_icondata.h"
-#include "TouchCalibrator.h"
 #include "TestingDialogController.h"
+#include <extras/DrawableTouchCalibrator.h>
 
 const char pgmVersionHeader[] PROGMEM = "tcMenu Version";
 
@@ -56,7 +56,7 @@ void setup() {
     controller.initialise();
     touchScreen.calibrateMinMaxValues(0.250F, 0.890F, 0.09F, 0.88F);
 
-    renderer.setCustomDrawingHandler(new TouchScreenCalibrator(&touchScreen));
+    renderer.setCustomDrawingHandler(new tcextras::TouchScreenCalibrator(&touchScreen, &renderer));
 
     // first we get the graphics factory
     auto & factory = renderer.getGraphicsPropertiesFactory();

examples/esp32Amplifier/esp32Amplifier_main.cpp

@@ -0,0 +1,69 @@
+/*
+ * Copyright (c) 2018 https://www.thecoderscorner.com (Nutricherry LTD).
+ * This product is licensed under an Apache license, see the LICENSE file in the top-level directory.
+ */
+
+#include "DrawableTouchCalibrator.h"
+#include <BaseDialog.h>
+
+using namespace tcextras;
+using namespace tcgfx;
+
+#define TOUCH_BLACK RGB(0,0,0)
+#define TOUCH_ORANGE RGB(255, 69, 0)
+#define TOUCH_YELLOW RGB(255, 255, 0)
+
+void TouchScreenCalibrator::started(BaseMenuRenderer *currentRenderer) {
+    if (currentRenderer->getRendererType() != RENDER_TYPE_CONFIGURABLE) {
+        giveItBack();
+    }
+    drawable = renderer->getDeviceDrawable();
+    drawable->startDraw();
+    drawable->setDrawColor(TOUCH_BLACK);
+    drawable->drawBox(Coord(0, 0), drawable->getDisplayDimensions(), true);
+    drawable->endDraw();
+    takeOverCount = 0;
+}
+
+void TouchScreenCalibrator::renderLoop(unsigned int currentValue, RenderPressMode userClick) {
+
+    // If the dialog is in use then we leave this loop immediately to give it priority.
+    // As of 2.1 onwards this behaviour is up to you, you can choose to have higher priority than dialogs.
+    if (renderer->getDialog() != nullptr && renderer->getDialog()->isInUse()) {
+        giveItBack();
+        return;
+    }
+
+    drawable->startDraw();
+    drawable->setDrawColor(TOUCH_BLACK);
+    drawable->drawCircle(Coord(oldX, oldY), 10, true);
+
+    drawable->drawBox(Coord(0, 0), Coord(drawable->getDisplayDimensions().x, 45), true);
+    drawable->setColors(TOUCH_ORANGE, TOUCH_BLACK);
+    drawable->drawText(Coord(0, 2), nullptr, 0, "Calibrate screen");
+
+    char sz[40];
+    strcpy(sz, "x: ");
+    fastftoa(sz, touchScreen->getLastX(), 3, sizeof sz);
+    strcat(sz, ", y: ");
+    fastftoa(sz, touchScreen->getLastY(), 3, sizeof sz);
+    strcat(sz, ", z: ");
+    fastltoa(sz, touchScreen->getLastTouchState(), 1, NOT_PADDED, sizeof sz);
+
+    drawable->setColors(TOUCH_YELLOW, TOUCH_BLACK);
+    drawable->drawText(Coord(0, 22), nullptr, 0, sz);
+
+    oldX = int(touchScreen->getLastX() * (float) drawable->getDisplayDimensions().x);
+    oldY = int(touchScreen->getLastY() * (float) drawable->getDisplayDimensions().y);
+    drawable->setDrawColor(TOUCH_YELLOW);
+    drawable->drawCircle(Coord(oldX, oldY), 10, true);
+
+    if (oldX < 40 && oldY < 40 && touchScreen->getLastTouchState() == iotouch::HELD) {
+        giveItBack();
+    }
+}
+
+void TouchScreenCalibrator::giveItBack() {
+    renderer->giveBackDisplay();
+    if(calibrationCompletedHandler) calibrationCompletedHandler();
+}

src/extras/DrawableTouchCalibrator.cpp

@@ -0,0 +1,53 @@
+/*
+ * Copyright (c) 2018 https://www.thecoderscorner.com (Nutricherry LTD).
+ * This product is licensed under an Apache license, see the LICENSE file in the top-level directory.
+ */
+
+#ifndef TCMENU_DRAWABLETOUCHCALIBRATOR_H
+#define TCMENU_DRAWABLETOUCHCALIBRATOR_H
+
+#include <PlatformDetermination.h>
+#include "../graphics/GraphicsDeviceRenderer.h"
+#include "../graphics/MenuTouchScreenEncoder.h"
+
+namespace tcextras {
+
+    /**
+     * This class implements custom drawing so that it can take over the display and render a basic touch screen
+     * calibration UI. It presents the position of the cursor using the current rotation so that it is easy to
+     * provide a touch calibrator object.
+     *
+     * To use this class:
+     * 1. Either using new or globally create an instance of this class.
+     * 2. renderer.setCustomDrawingHandler(touchCalibrator);
+     * 3. renderer.takeOverDisplay();
+     */
+    class TouchScreenCalibrator : public CustomDrawing {
+    private:
+        tcgfx::DeviceDrawable *drawable;
+        tcgfx::MenuTouchScreenManager *touchScreen;
+        tcgfx::GraphicsDeviceRenderer* renderer;
+        int oldX = 0, oldY = 0;
+        unsigned int takeOverCount = 0;
+        TimerFn calibrationCompletedHandler;
+    public:
+        explicit TouchScreenCalibrator(tcgfx::MenuTouchScreenManager *touchScreen, tcgfx::GraphicsDeviceRenderer* renderer)
+                : drawable(nullptr), touchScreen(touchScreen), renderer(renderer), calibrationCompletedHandler(nullptr) {}
+
+        void setCalibrationCompletedHandler(TimerFn calibrationFinished) {
+            calibrationCompletedHandler = calibrationFinished;
+        }
+
+        void reset() override {
+            renderer->takeOverDisplay();
+        }
+
+        void started(BaseMenuRenderer *currentRenderer) override;
+
+        void renderLoop(unsigned int currentValue, RenderPressMode userClick) override;
+
+        void giveItBack();
+    };
+} // namespace tcextras
+
+#endif // TCMENU_DRAWABLETOUCHCALIBRATOR_H