/elec/propeller-clock

To get this branch, use:
bzr branch http://bzr.ed.am/elec/propeller-clock

« back to all changes in this revision

Viewing changes to src/text.h

  • Committer: edam
  • Date: 2012-02-29 21:56:32 UTC
  • Revision ID: edam@waxworlds.org-20120229215632-kypb9491vx7bicef
moved some stuf round, created a re-usable pool of message buffers, genericised "modes" for messages

Show diffs side-by-side

added added

removed removed

src/text.h
 
1
/*
 
2
 * text.h
 
3
 *
 
4
 * Copyright (C) 2011 Tim Marston <tim@ed.am> and Dan Marston.
 
5
 *
 
6
 * This file is part of propeller-clock (hereafter referred to as "this
 
7
 * program"). See http://ed.am/dev/software/arduino/propeller-clock for more
 
8
 * information.
 
9
 *
 
10
 * This program is free software: you can redistribute it and/or modify
 
11
 * it under the terms of the GNU Lesser General Public License as published
 
12
 * by the Free Software Foundation, either version 3 of the License, or
 
13
 * (at your option) any later version.
 
14
 *
 
15
 * This program is distributed in the hope that it will be useful,
 
16
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 
17
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
18
 * GNU Lesser General Public License for more details.
 
19
 *
 
20
 * You should have received a copy of the GNU Lesser General Public License
 
21
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
22
 */
 
23
#ifndef _TEXT_H_
 
24
#define _TEXT_H_
 
25
 
 
26
 
 
27
#include <PString.h>
 
28
 
 
29
 
 
30
#define NUM_MESSAGE_BUFFERS 4
 
31
#define MESSAGE_LEN 32
 
32
 
 
33
 
 
34
namespace Text
 
35
{
 
36
        enum {
 
37
                // one of these to select face
 
38
                MODE_TOP = 1,
 
39
                MODE_BOTTOM = 0,
 
40
 
 
41
                // one of these to select size
 
42
                MODE_ONEQUARTER = 0,
 
43
                MODE_ONETHIRD = 4,
 
44
                MODE_HALF = 8,
 
45
                MODE_TWOTHIRDS = 12,
 
46
                MODE_THREEQUARTERS = 16,
 
47
                MODE_ALL = 20,
 
48
 
 
49
                // flag to turn on horizontal scrolling
 
50
                MODE_HSCROLL = 32,
 
51
        };
 
52
 
 
53
        /**
 
54
         * After modifying a message buffer, call this to reset the internal state
 
55
         * of the text renderer with regard to this message.
 
56
         *
 
57
         * @param message_num the buffer number
 
58
         * @param pstring the PString that represents this message's buffer
 
59
         */
 
60
        void set_message( int message_num, PString &pstring );
 
61
 
 
62
        /**
 
63
         * Set the mode for a particular message, and reset the internal state
 
64
         * relating to this message's mode.
 
65
         *
 
66
         * @param mode the new mode for this message
 
67
         */
 
68
        void set_message_mode( int message_num, char mode );
 
69
 
 
70
        /**
 
71
         * Reset internal state, for a new text display.
 
72
         */
 
73
        void reset();
 
74
 
 
75
        /**
 
76
         * Call at the start of each frame.
 
77
         */
 
78
        void draw_reset();
 
79
 
 
80
        /**
 
81
         * Draw segment for the specified message number using whatever mode that
 
82
         * message is set to.
 
83
         *
 
84
         * @param message_num the message buffer number
 
85
         * @param segment to draw
 
86
         */
 
87
        void draw( int message_num, int segment );
 
88
 
 
89
        /** internal message buffers */
 
90
        extern char _messages[ NUM_MESSAGE_BUFFERS ][ MESSAGE_LEN ];
 
91
};
 
92
 
 
93
 
 
94
#endif //_TEXT_H_