Ready for pr

Author: Joseph Spencer

Makefile

@@ -23,15 +23,15 @@ USE_PACKAGE:=0
 IS_LIBRARY:=1
 # TODO: CHANGE THIS!
 LIBNAME:=screenlib
-VERSION:=1.0.0
+VERSION:=1.0.1
 # EXCLUDE_SRC_FROM_LIB= $(SRCDIR)/unpublishedfile.c
 # this line excludes opcontrol.c and similar files
 EXCLUDE_SRC_FROM_LIB+=$(foreach file, $(SRCDIR)/opcontrol $(SRCDIR)/initialize $(SRCDIR)/autonomous,$(foreach cext,$(CEXTS),$(file).$(cext)) $(foreach cxxext,$(CXXEXTS),$(file).$(cxxext)))
 
 # files that get distributed to every user (beyond your source archive) - add
 # whatever files you want here. This line is configured to add all header files
 # that are in the the include directory get exported
-TEMPLATE_FILES=$(INCDIR)/**/*.h $(INCDIR)/**/*.hpp
+TEMPLATE_FILES=$(INCDIR)/screen/**/*.h $(INCDIR)/screen/**/*.hpp
 
 .DEFAULT_GOAL=quick
 

README.md

@@ -55,13 +55,12 @@ Alternatively, macros can be used for more verbose code; here is the equivalent
 `field.draw(screen::cubeGroup::right4, CUBE_HIGHEST + CUBE_2LOWEST);`
 
 `CUBE_HIGHEST` represents the highest cube in the stack, followed by `CUBE_2HIGHEST` (the 2nd highest), followed by `CUBE_2LOWEST` (the 2nd lowest), and finally `CUBE_LOWEST`  
-As the 4 cube stacks on the left and right are in the same order but slightly different positions, the corresponding cubes are represented the same (purple to purple, orange to orange, green to green)
 
 `CUBE_FAR` and `CUBE_NEAR` are for the cube sectors farLeft and farRight
 
 `CUBE_TOP_NEAR`, `CUBE_FAR_LEFT`, `CUBE_NEAR_LEFT`, `CUBE_FAR_RIGHT`, and `CUBE_NEAR_RIGHT` are used for the five cube stack on the near side
 
-and finally, all macros starting with `TOWER_CUBE_` refer to the cubes around a tower
+and finally, all macros starting with `TOWER_CUBE_` refer to the cubes around a tower  
 
 Scored Cubes
 ------------
@@ -70,6 +69,12 @@ Scored cubes are drawn along with where they are, either in a tower or a scoring
 a third parameter is used to display "stack height", a number printed on top to describe how many cubes are in the stack.  
 Note: use `screen::color::none` to abstain from printing a scored cube in that position
 
+Other
+-----
+The field can be repositioned with `setX`, `setY`, or `setPos`.  
+and can be resized using `setSideLength`  
+when changing size, if you are unsatisfied with the numbers printed on the cubes, you can modify the `NumberConfig`, which is given as the 4th parameter in the constructor. More information is available in [field.hpp](./include/field.hpp)  
+
 Example
 -------
 This directory (specifically [opcontrol.cpp](./src/opcontrol.cpp)) is a usage example (it produces the image at the top of this page)
@@ -78,4 +83,4 @@ Acknowledgements
 ================
 smallfont.c is converted version of the digits 0-9 from [Synchronizer NBP Font](https://www.fontspace.com/total-fontgeek-dtf-ltd/synchronizer-nbp) by total FontGeek DTF, Ltd. all credit regarding the font to them.
 
-Thanks to Hotel from the PROS team, Salmon from Okapilib, and Theo from 7842F, for giving some advice on improving the code here
+Thanks to Potatehoes from 914M for beta testing, as well as Hotel from the PROS team, Salmon from Okapilib, and Theo from 7842F, for giving some advice on improving the code here

include/screen/field.hpp

@@ -46,8 +46,7 @@
  *
  * CUBE_HIGHEST represents the highest cube in the stack, followed by CUBE_2HIGHEST (the 2nd
  * highest), followed by CUBE_2LOWEST (the 2nd lowest), and finally CUBE_LOWEST As the 4 cube stacks
- * on the left and right are in the same order but slightly different positions, the corresponding
- * cubes are represented the same (purple to purple, orange to orange, green to green)
+ * on the left and right are in the same order but slightly different positions
  *
  * CUBE_FAR and CUBE_NEAR are for the cube Groups farLeft and farRight
  *
@@ -69,14 +68,31 @@ namespace screen {
 
 class Field {
  public:
+
+   /**
+    * A struct that controls the drawing of numbers on cubes (which represent height)
+    *
+    * deltaX how far to move the number horizontally from default
+    * deltaY how far to move the number vertically from default
+    * fontStyle which style to use; can be used to change the font, color, etc. of the number
+   */
+   struct NumberConfig{
+     int deltaX, deltaY;
+     lv_style_t* fontStyle;
+   };
+
   /**
    * Field generator for the screen
    *
    * @param parent LVGL object to place upon
    * @param ilength the side length of the field (in both directions)
    * @param iautoInit print colored tiles / taped lines immediately, and after each clean
+   * @param iconfig a configuration for the numbers on the cubes,
+   *    use deltaX and deltaY to adjust the position of the number, and set a different
+   *    style using fontStyle
    */
-  Field(lv_obj_t *parent, double ilength = 240, bool iautoInit = true);
+  Field(lv_obj_t *parent, double ilength = 240, bool iautoInit = true,
+        NumberConfig iconfig = {1, -1, &littleWhiteText});
   ~Field();
 
   /**
@@ -90,15 +106,15 @@ class Field {
    * @param x new x-value of the distance from the leftmost side of the screen
    *    (screen is 480 pixels wide)
    */
-  void setX(uint8_t x);
+  void setX(int x);
 
   /**
    * Set new y position of the field on the screen
    *
    * @param y new y-value of the distance from the top side of the field
    *    (screen is 240 pixels tall)
    */
-  void setY(uint8_t y);
+  void setY(int y);
 
   /**
    * Set new position of the field on the screen
@@ -110,7 +126,7 @@ class Field {
    * @param y new y-value of the distance from the top side of the field
    *    (screen is 240 pixels tall)
    */
-  void setPos(uint8_t x, uint8_t y);
+  void setPos(int x, int y);
 
   /**
    * Set the new width and height of the field
@@ -210,7 +226,7 @@ class Field {
   void drawCube(std::pair<uint8_t, uint8_t> pos, color color, uint8_t stackHeight, bool targeted);
 
   static void drawCube(lv_obj_t *parent, std::pair<uint8_t, uint8_t> pos, double scalar, color color,
-                       uint8_t stackHeight, bool targeted);
+                       uint8_t stackHeight, NumberConfig config, bool targeted);
 
   int scale(int original);
 
@@ -229,6 +245,8 @@ class Field {
   std::vector<cubeGroup> cubesToDraw;
   std::vector<tower> towersToDraw;
   std::vector<scoringZone> zonesToDraw;
+
+  NumberConfig config;
 };
 
 }  // namespace screen

src/opcontrol.cpp

@@ -11,8 +11,6 @@ void opcontrol()
 
   screen::Field field(scr);
 
-  field.setSideLength(400);
-
   // two stacks use an array of colors
   // draw a purple stack with height 1 and an orange stack with height 3 in the far red zone
   field.draw(screen::scoringZone::farRed, {screen::color::purple, screen::color::orange},

src/screen/field.cpp

@@ -2,13 +2,14 @@
 
 namespace screen {
 
-Field::Field(lv_obj_t *parent, const double ilength, const bool iautoInit)
-    : scalar(ilength / 240), autoInit(iautoInit), wallDrawn(false),
-      allianceTowerContents(color::none, color::none)
+Field::Field(lv_obj_t *parent, const double ilength, const bool iautoInit,
+             const NumberConfig iconfig):
+             scalar(ilength / 240), autoInit(iautoInit), config(iconfig),
+             wallDrawn(false), allianceTowerContents(color::none, color::none)
 {
   obj = lv_obj_create(parent, NULL);
   lv_obj_set_style(obj, &fieldStyle);
-  lv_obj_set_size(obj, scale(240), scale(240));
+  lv_obj_set_size(obj, ilength, ilength);
   lv_obj_set_pos(obj, 120, 0);
 
   resetVectors();
@@ -38,25 +39,25 @@ void Field::clean()
   }
 }
 
-void Field::setX(uint8_t x)
+void Field::setX(int x)
 {
   lv_obj_set_x(obj, x);
 }
 
-void Field::setY(uint8_t y)
+void Field::setY(int y)
 {
   lv_obj_set_y(obj, y);
 }
 
-void Field::setPos(uint8_t x, uint8_t y)
+void Field::setPos(int x, int y)
 {
   lv_obj_set_pos(obj, x, y);
 }
 
 void Field::setSideLength(uint ilength){
   scalar = ilength / 240.0;
-  clean();
   lv_obj_set_size(obj, ilength, ilength);
+  clean();
 }
 
 void Field::draw(const cubeGroup pos, const uint8_t presence)
@@ -227,7 +228,7 @@ void Field::draw(const tower pos, const color contents, const uint8_t cubePresen
       lv_obj_set_style(tower, &neutralTower);
       lv_obj_set_pos(tower, scale(32), scale(112));
 
-      drawCube(tower, {3, 3}, scalar, contents, 1, true);
+      drawCube(tower, {3, 3}, scalar, contents, 1, config, true);
 
       if (cubePresence & 0b11111000) {
         drawCube({35, 101}, color::purple, 1, targeted);
@@ -243,7 +244,7 @@ void Field::draw(const tower pos, const color contents, const uint8_t cubePresen
       lv_obj_set_style(tower, &neutralTower);
       lv_obj_set_pos(tower, scale(192), scale(112));
 
-      drawCube(tower, {3, 3}, scalar, contents, 1, true);
+      drawCube(tower, {3, 3}, scalar, contents, 1, config, true);
 
       if (cubePresence & 0b11111000) {
         drawCube({195, 101}, color::purple, 1, targeted);
@@ -259,7 +260,7 @@ void Field::draw(const tower pos, const color contents, const uint8_t cubePresen
       lv_obj_set_style(tower, &neutralTower);
       lv_obj_set_pos(tower, scale(112), scale(112));
 
-      drawCube(tower, {3, 3}, scalar, contents, 1, true);
+      drawCube(tower, {3, 3}, scalar, contents, 1, config, true);
       if (cubePresence & 0b11111000) {
         drawCube({115, 101}, color::purple, 1, targeted);
       }
@@ -277,7 +278,7 @@ void Field::draw(const tower pos, const color contents, const uint8_t cubePresen
       lv_obj_set_style(tower, &neutralTower);
       lv_obj_set_pos(tower, scale(112), scale(52));
 
-      drawCube(tower, {3, 3}, scalar, contents, 1, true);
+      drawCube(tower, {3, 3}, scalar, contents, 1, config, true);
       if (cubePresence & 0b11111000) {
         drawCube({115, 41}, color::purple, 1, targeted);
       }
@@ -295,7 +296,7 @@ void Field::draw(const tower pos, const color contents, const uint8_t cubePresen
       lv_obj_set_style(tower, &neutralTower);
       lv_obj_set_pos(tower, scale(112), scale(172));
 
-      drawCube(tower, {3, 3}, scalar, contents, 1, true);
+      drawCube(tower, {3, 3}, scalar, contents, 1, config, true);
       if (cubePresence & 0b11111000) {
         drawCube({115, 161}, color::purple, 1, targeted);
       }
@@ -313,13 +314,13 @@ void Field::draw(const tower pos, const color contents, const uint8_t cubePresen
       lv_obj_set_style(tower, &redTower);
       lv_obj_set_pos(tower, scale(54), scale(228));
 
-      drawCube(tower, {3, 3}, scalar, contents, 1, true);
+      drawCube(tower, {3, 3}, scalar, contents, 1, config, true);
       break;
     case tower::blue:
       lv_obj_set_style(tower, &blueTower);
       lv_obj_set_pos(tower, scale(174), scale(228));
 
-      drawCube(tower, {3, 3}, scalar, contents, 1, true);
+      drawCube(tower, {3, 3}, scalar, contents, 1, config, true);
       break;
   }
 }
@@ -350,8 +351,8 @@ void Field::draw(const scoringZone pos, const std::pair<color, color> contents,
       lv_obj_set_pos(zone, 0, 0);
 
       if (targeted) {
-        drawCube(zone, {4, 5}, scalar, contents.first, stackHeight.first, false);
-        drawCube(zone, {15, 5}, scalar, contents.second, stackHeight.second, false);
+        drawCube(zone, {4, 5}, scalar, contents.first, stackHeight.first, config, false);
+        drawCube(zone, {15, 5}, scalar, contents.second, stackHeight.second, config, false);
       }
       break;
     case scoringZone::farBlue:
@@ -360,8 +361,8 @@ void Field::draw(const scoringZone pos, const std::pair<color, color> contents,
       lv_obj_set_pos(zone, scale(211), 0);
 
       if (targeted) {
-        drawCube(zone, {15, 5}, scalar, contents.first, stackHeight.first, false);
-        drawCube(zone, {4, 5}, scalar, contents.second, stackHeight.second, false);
+        drawCube(zone, {15, 5}, scalar, contents.first, stackHeight.first, config, false);
+        drawCube(zone, {4, 5}, scalar, contents.second, stackHeight.second, config, false);
       }
       break;
     case scoringZone::nearRed:
@@ -370,7 +371,7 @@ void Field::draw(const scoringZone pos, const std::pair<color, color> contents,
       lv_obj_set_pos(zone, 0, scale(220));
 
       if (targeted) {
-        drawCube(zone, {5, 5}, scalar, contents.first, stackHeight.first, false);
+        drawCube(zone, {5, 5}, scalar, contents.first, stackHeight.first, config, false);
       }
       break;
     case scoringZone::nearBlue:
@@ -379,7 +380,7 @@ void Field::draw(const scoringZone pos, const std::pair<color, color> contents,
       lv_obj_set_pos(zone, scale(220), scale(220));
 
       if (targeted) {
-        drawCube(zone, {5, 5}, scalar, contents.first, stackHeight.first, false);
+        drawCube(zone, {5, 5}, scalar, contents.first, stackHeight.first, config, false);
       }
       break;
   }
@@ -488,11 +489,12 @@ void Field::finishDrawing()
 void Field::drawCube(const std::pair<uint8_t, uint8_t> pos, const color color,
                      const uint8_t stackHeight, const bool targeted)
 {
-  drawCube(obj, pos, scalar, color, stackHeight, targeted);
+  drawCube(obj, pos, scalar, color, stackHeight, config, targeted);
 }
 
 void Field::drawCube(lv_obj_t *parent, const std::pair<uint8_t, uint8_t> pos, double scalar,
-                     const color color, const uint8_t stackHeight, const bool targeted)
+                     const color color, const uint8_t stackHeight, const NumberConfig config,
+                     const bool targeted)
 {
   if (color == color::none)
     return;
@@ -508,10 +510,10 @@ void Field::drawCube(lv_obj_t *parent, const std::pair<uint8_t, uint8_t> pos, do
 
   if (stackHeight > 1) {
     lv_obj_t *cubeLabel = lv_label_create(cube, NULL);
-    lv_label_set_style(cubeLabel, &littleWhiteText);
-    lv_obj_align(cubeLabel, NULL, LV_ALIGN_CENTER, -1, -1);
+    lv_label_set_style(cubeLabel, config.fontStyle);
+    lv_obj_align(cubeLabel, NULL, LV_ALIGN_CENTER, config.deltaX, config.deltaY);
     lv_label_set_align(cubeLabel, LV_LABEL_ALIGN_CENTER);
-    lv_label_set_text(cubeLabel, (" " + std::to_string(stackHeight)).c_str());
+    lv_label_set_text(cubeLabel, std::to_string(stackHeight).c_str());
   }
 }