ScummVM API documentation
compass.h
1/* ScummVM - Graphic Adventure Engine
2 *
3 * ScummVM is the legal property of its developers, whose names
4 * are too numerous to list here. Please refer to the COPYRIGHT
5 * file distributed with this source distribution.
6 *
7 * Additional copyright for this file:
8 * Copyright (C) 1995-1997 Presto Studios, Inc.
9 *
10 * This program is free software: you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * 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 General Public License for more details.
19 *
20 * You should have received a copy of the GNU General Public License
21 * along with this program. If not, see <http://www.gnu.org/licenses/>.
22 *
23 */
24
25#ifndef PEGASUS_COMPASS_H
26#define PEGASUS_COMPASS_H
27
28#include "pegasus/fader.h"
29#include "pegasus/surface.h"
30
31namespace Pegasus {
32
33// Compass is defined with 0 as north, 90 east, 180 south, 270 west.
34// Clockwise rotation increases the angle, counterclockwise rotation decreases the angle.
35
36class Compass : public FaderAnimation {
37public:
38 Compass();
39 ~Compass() override;
40
41 void initCompass();
42 void deallocateCompass();
43 bool isCompassValid() const { return _compassImage.isSurfaceValid(); }
44
45 void setFaderValue(const int32) override;
46
47protected:
48 void draw(const Common::Rect &) override;
49
50 Frame _compassImage;
51};
52
53extern Compass *g_compass;
54
55} // End of namespace Pegasus
56
57#endif
Definition: compass.h:36
Definition: fader.h:99
Definition: surface.h:105
Definition: rect.h:536