/
clskyplane.h
70 lines (58 loc) · 1.95 KB
/
clskyplane.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
/** @file clskyplane.h Client-side world map sky plane.
* @ingroup world
*
* @authors Copyright © 2016 Daniel Swanson <danij@dengine.net>
*
* @par License
* GPL: http://www.gnu.org/licenses/gpl.html
*
* <small>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 2 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, write to the Free
* Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
* 02110-1301 USA</small>
*/
#ifndef DENG_CLIENT_WORLD_CLSKYPLANE_H
#define DENG_CLIENT_WORLD_CLSKYPLANE_H
#include <de/Observers>
namespace world {
/**
*
*/
class ClSkyPlane
{
public:
/// Notified whenever a @em height change occurs.
DENG2_DEFINE_AUDIENCE2(HeightChange, void clSkyPlaneHeightChanged(ClSkyPlane &skyPlane))
ClSkyPlane(bool isCeiling = false, de::ddouble defaultHeight = 0);
/**
* Returns @c true if this sky plane is configured as the "ceiling".
*
* @see isFloor()
*/
bool isCeiling() const;
/**
* Returns @c true if this sky plane is configured as the "ceiling".
*
* @see isCeiling()
*/
bool isFloor() const;
/**
* Returns the current height of the sky plane.
*/
de::ddouble height() const;
/**
* Change the height of the sky plane to @a newHeight. The HeightChange audience will
* be notified if a change occurs.
*/
void setHeight(de::ddouble newHeight);
private:
DENG2_PRIVATE(d)
};
} // namespace world
#endif // DENG_CLIENT_WORLD_CLSKYPLANE_H