summaryrefslogtreecommitdiffstats
path: root/src/state.h
blob: cd4cef64965444c3bbb73acd2559c3610aa1a9e9 (plain) (blame)
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
/**
 * Copyright © 2016  Mattias Andrée <maandree@member.fsf.org>
 * 
 * This program 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/>.
 */



/**
 * The times of the day, by degree of darkness.
 */
enum darkness {
	/**
	 * Not calculated yet.
	 */
 	UNKNOWN = -1,

	/**
	 * Hopefully, it is bright outside.
	 */
	DAYTIME = 0,

	/**
	 * The sky is golden. The golden "hour".
	 * Also known as BMCT (dawn) or EECT (dusk).
	 */
	CIVIL_TWILIGHT = 1,

	/**
	 * The sky is pink and blue.
	 */
	NAUTICAL_TWILIGHT = 2,

	/**
	 * The sky is medium dark blue.
	 */
	ASTRONOMICAL_TWILIGHT = 3,

	/**
	 * The sky is really dark blue.
	 */
	NIGHT = 4
};



/**
 * Is it daytime, night, perhaps some kind of twilight?
 * 
 * @param    elevation  The Sun's apparent elevation.
 * @return              The time of the day.
 */
enum darkness get_darkness(double elevation);