-
Notifications
You must be signed in to change notification settings - Fork 10
/
MatrixSnake.h
170 lines (142 loc) · 6.66 KB
/
MatrixSnake.h
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
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
/*
* MatrixSnake.h
*
* SUMMARY
* You need to install "Adafruit NeoPixel" library under "Tools -> Manage Libraries..." or "Ctrl+Shift+I" -> use "neoPixel" as filter string
* Extension are made to include more patterns and combined patterns and patterns for 8x8 NeoPixel matrix.
*
* Copyright (C) 2018-2022 Armin Joachimsmeyer
* armin.joachimsmeyer@gmail.com
*
* This file is part of NeoPatterns https://github.com/ArminJo/NeoPatterns.
*
* NeoPatterns 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 3 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, see <http://www.gnu.org/licenses/gpl.html>.
*
*/
/* Class inheritance diagram
* ,o--> MatrixNeoPixel \
* MatrixSnake --> MatrixNeoPatterns < o--> NeoPixel --> Adafruit_NeoPixel
* `o--> NeoPatterns /
*/
#ifndef _MATRIX_SNAKE_H
#define _MATRIX_SNAKE_H
#if defined(ENABLE_PATTERNS_FOR_SNAKE_AUTORUN)
#define ENABLE_MATRIX_PATTERN_MOVE // required for SnakeAutorunCompleteHandler() to move the score out.
#endif
#if defined(ENABLE_PATTERNS_FOR_MATRIX_AND_SNAKE_DEMO_HANDLER)
#define ENABLE_MATRIX_PATTERN_TICKER
#define ENABLE_MATRIX_PATTERN_MOVING_PICTURE
#define ENABLE_PATTERN_PROCESS_SELECTIVE
#define ENABLE_MATRIX_PATTERN_MOVE
#define ENABLE_MATRIX_PATTERN_FIRE
#define ENABLE_MATRIX_PATTERN_SNOW
#endif
#include "MatrixNeoPatterns.h"
//#define SNAKE_ALLOW_SERIAL_CONTROL // Accepts snake direction commands over the serial line
#define SPECIAL_PATTERN_SNAKE (LAST_MATRIX_NEO_PATTERN + 1)
#define APPLE_COLOR COLOR32_RED
#define MILLIS_FOR_BUTTON_DEBOUNCING 100
#define FLAG_SNAKE_USE_4_BUTTONS 0x01 // will be set if PinOfUpButton != 0 and up or down button was at least pressed once
#define FLAG_SNAKE_AUTORUN 0x02 // autorun mode - will be set if no left buttons is defined
#define FLAG_SNAKE_SHOW_LENGTH_SCORE 0x20 // signal number shown -> enables delay
#define FLAG_SNAKE_SHOW_END 0x40 // signal end of snake shown -> enables delay
#define SHOW_END_INTERVAL_MILLIS 3000
#define SHOW_NUMBER_INTERVAL_MILLIS 2000
#define TIME_TO_SWITCH_TO_AUTO_MODE_MILLIS 7000
//#define TIME_TO_SWITCH_TO_AUTO_MODE_MILLIS 2000
// stores a 2d position TopLeft coordinates are 0,0
struct position {
uint8_t x;
uint8_t y;
};
// stores the initial shape of the snake. SnakeInitialPixels[0] is head of snake
position const SnakeInitialPixels[] = { { 4, 4 }, { 5, 4 }, { 6, 4 }, { 6, 5 } };
// extension of NeoPattern Class approximately 85 byte / object
class MatrixSnake: public MatrixNeoPatterns {
public:
MatrixSnake();
MatrixSnake(uint8_t aColumns, uint8_t aRows, uint8_t aPin, uint8_t aMatrixGeometry, uint8_t aTypeOfPixel,
void (*aPatternCompletionCallback)(NeoPatterns*)=NULL);
bool init(uint8_t aColumns, uint8_t aRows, uint8_t aPin, uint8_t aMatrixGeometry, uint8_t aTypeOfPixel,
void (*aPatternCompletionCallback)(NeoPatterns*)=NULL);
bool Snake(uint16_t aIntervalMillis, color32_t aColor, uint8_t aPinOfRightButton = 0, uint8_t aPinOfLeftButton = 0,
uint8_t aPinOfUpButton = 0, uint8_t aPinOfDownButton = 0);
bool update();
bool update(uint8_t aBrightness);
bool updateOrRedraw(bool aDoRedrawIfNoUpdate);
bool updateOrRedraw(bool aDoRedrawIfNoUpdate, uint8_t aBrightness);
void SnakeUpdate(bool aDoUpdate = true);
void SnakeStop();
void SnakeInputHandler();
void SnakeEndHandler();
void showScore();
void newApple();
void drawApple();
void drawSnake();
void resetAndClearAndShowSnakeAndNewApple();
void rotateRight();
void rotateLeft();
//
bool isPositionInArea(position aPositionToCheck);
uint16_t getIndexOfPositionInSnake(uint8_t aPositionToCheckX, uint8_t aPositionToCheckY);
uint16_t getIndexOfPositionInSnake(position aPositionToCheck);
uint16_t getIndexOfPositionInSnakeTail(position aPositionToCheck);
uint16_t checkDirection(uint8_t aDirectionToCheck);
//
bool computeNewHeadPosition(uint8_t aActualDirection, position *aSnakeNewHeadPosition);
bool moveSnakeAndCheckApple(position tSnakeNewHeadPosition);
#if defined(LOCAL_TRACE)
void printSnakePosition(position aSnakePosition);
#endif
/*
* internal auto solver functions
*/
uint8_t findNextDir();
uint8_t runAndCheckIfAppleCanBeReached();
uint8_t builtinGetNextSnakeDirection();
// The pixel positions of the Snake. Only the positions up until snake_length - 1 are displayed
// SnakePixelList[0] is head of snake
position *SnakePixelList;
uint16_t SnakeLength; // current length of snake
#define AUTOSOLVER_CLOCKWISE_FLAG 0x01 // if set choose directions from 3 to 0
uint8_t SnakeAutoSolverMode; // The mode for findNextDir()
// the apple the snake chases after
position Apple;
uint16_t HighScore;
/*
* Snake input stuff
*/
uint8_t PinOfRightButton; // if not set (==0), snake runs in autorun mode
uint8_t PinOfLeftButton;
uint8_t PinOfUpButton;
uint8_t PinOfDownButton;
uint8_t DirectionOfLastButtonPressed; // for debouncing
uint32_t MillisOfLastButtonChange; // for debouncing in 2 button mode
private:
};
uint8_t computeDirection(position aStartPosition, position aEndPosition);
extern const char sDefaultTickerText[] PROGMEM; // = "I love Neopixel"
extern const char *sTickerTextPtr; // = sDefaultTickerText;
void setMatrixAndSnakePatternsDemoHandlerTickerText(const __FlashStringHelper *aTextForTicker);
void setMatrixAndSnakePatternsDemoHandlerTickerText(const char *aTextForTicker);
#if defined(ENABLE_MATRIX_PATTERN_TICKER) && defined(ENABLE_MATRIX_PATTERN_MOVING_PICTURE) && defined(ENABLE_PATTERN_PROCESS_SELECTIVE) \
&& defined(ENABLE_MATRIX_PATTERN_MOVE) && defined(ENABLE_MATRIX_PATTERN_FIRE) && defined(ENABLE_MATRIX_PATTERN_SNOW)
void MatrixAndSnakePatternsDemoHandler(NeoPatterns *aLedsPtr);
#endif
uint8_t getNextSnakeDirection(MatrixSnake *aSnake);
#if defined(ENABLE_MATRIX_PATTERN_MOVE)
bool initSnakeAutorun(MatrixSnake *aLedsPtr, uint16_t aIntervalMillis, color32_t aColor, uint16_t aRepetitions = 1);
void SnakeAutorunCompleteHandler(NeoPatterns *aLedsPtr);
#endif
#endif // _MATRIX_SNAKE_H