/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: 2011-11-17 13:06:43 UTC
  • Revision ID: edam@waxworlds.org-20111117130643-0azy70bj8ueoq8cn
moved GPL to top-level dir

Show diffs side-by-side

added added

removed removed

Lines of Context:
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 = 0,
39
 
                MODE_BOTTOM = 64,
40
 
 
41
 
                // one of these to select size
42
 
                MODE_ONEQUARTER = 1,
43
 
                MODE_ONETHIRD = 2,
44
 
                MODE_HALF = 3,
45
 
                MODE_TWOTHIRDS = 4,
46
 
                MODE_THREEQUARTERS = 5,
47
 
                MODE_ALL = 6,
48
 
 
49
 
                // flag to turn on horizontal scrolling
50
 
                MODE_HSCROLL = 32,
51
 
 
52
 
                // text scale constants
53
 
                SCALE_VSMALL = 1,
54
 
                SCALE_SMALL = 2,
55
 
                SCALE_NORMAL = 3,
56
 
                SCALE_FAT = 4,
57
 
                SCALE_VFAT = 5,
58
 
        };
59
 
 
60
 
        /**
61
 
         * Reset internal state, for a new text display. This deactivates all
62
 
         * messages and they will need to be enabled again with set_up_message().
63
 
         */
64
 
        void reset();
65
 
 
66
 
        /**
67
 
         * Activate the display of a message and specify its display parameters.
68
 
         *
69
 
         * @param message_num the message to reset
70
 
         * @param mode the new mode for this message
71
 
         * @param scale text
72
 
         */
73
 
        void set_up_message( int message_num, char mode, char scale = SCALE_NORMAL );
74
 
 
75
 
        /**
76
 
         * After modifying a message buffer, call this to reset the internal state
77
 
         * of the text renderer with regard to this message.
78
 
         *
79
 
         * @param message_num the buffer number
80
 
         * @param pstring the PString that represents this message's buffer
81
 
         */
82
 
        void set_message_text( int message_num, PString &pstring );
83
 
 
84
 
        /**
85
 
         * Call at the start of each frame.
86
 
         */
87
 
        void draw_reset();
88
 
 
89
 
        /**
90
 
         * Call after drawing each frame
91
 
         */
92
 
        void post_draw();
93
 
 
94
 
        /**
95
 
         * Draw segment for the specified message number using whatever mode that
96
 
         * message is set to.
97
 
         *
98
 
         * @param segment to draw
99
 
         */
100
 
        void draw( int segment );
101
 
 
102
 
        /** internal message buffers */
103
 
        extern char _messages[ NUM_MESSAGE_BUFFERS ][ MESSAGE_LEN ];
104
 
};
105
 
 
106
 
 
107
 
#endif //_TEXT_H_