aboutsummaryrefslogtreecommitdiff
path: root/engines/pegasus/hotspot.h
blob: aafb96cc191a4166833be982efb73e688567e1ff (plain)
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
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
/* ScummVM - Graphic Adventure Engine
 *
 * ScummVM is the legal property of its developers, whose names
 * are too numerous to list here. Please refer to the COPYRIGHT
 * file distributed with this source distribution.
 *
 * Additional copyright for this file:
 * Copyright (C) 1995-1997 Presto Studios, Inc.
 *
 * 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 Street, Fifth Floor, Boston, MA 02110-1301, USA.
 *
 */

#ifndef PEGASUS_HOTSPOT_H
#define PEGASUS_HOTSPOT_H

#include "common/list.h"
#include "common/rect.h"

#include "pegasus/constants.h"
#include "pegasus/types.h"
#include "pegasus/util.h"

/*

	Hot spots combine a pixel area, an ID value and an active flag.
	
	A point is considered in a hot spot if the point is in the hot spot's pixel area and
	the active flag is set.
	
	In addition, hot spots have a 32 bit word of bit flags for filtering use.

*/

namespace Common {
	class ReadStream;
}

namespace Pegasus {

// Our implementation of QuickDraw regions
class Region {
public:
	Region() {}
	Region(Common::ReadStream *stream);
	Region(const Common::Rect &rect);

	Common::Rect getBoundingBox() const { return _bounds; }

	bool pointInRegion(const Common::Point &point) const;

	void moveTo(tCoordType h, tCoordType v);
	void moveTo(const Common::Point &point);
	void translate(tCoordType h, tCoordType v);
	void translate(const Common::Point &point);
	void getCenter(tCoordType &h, tCoordType &v) const;
	void getCenter(Common::Point &point) const;

private:
	Common::Rect _bounds;

	struct Run {
		uint16 start, end;
	};

	class Vector : public Common::List<Run> {
	public:
		uint16 y;
	};

	Common::List<Vector> _vectors;
};

class Hotspot : public IDObject {
public:
	Hotspot(const tHotSpotID);
	virtual ~Hotspot();

	void setArea(const Region &region) { _spotArea = region; }
	void setArea(const Common::Rect &);
	void setArea(const tCoordType, const tCoordType, const tCoordType, const tCoordType);
	void getBoundingBox(Common::Rect &) const;
	void getArea(Region &) const;
	void getCenter(Common::Point&) const;
	void getCenter(tCoordType&, tCoordType&) const;
	
	void moveSpotTo(const tCoordType, const tCoordType);
	void moveSpotTo(const Common::Point);
	void moveSpot(const tCoordType, const tCoordType);
	void moveSpot(const Common::Point);
	
	bool pointInSpot(const Common::Point) const;
	
	void setActive();
	void setInactive();
	bool isSpotActive() const;
	
	tHotSpotFlags getHotspotFlags() const;
	void setHotspotFlags(const tHotSpotFlags);
	void setMaskedHotspotFlags(const tHotSpotFlags flags, const tHotSpotFlags mask);

protected:
	Region _spotArea;
	tHotSpotFlags _spotFlags;
	bool _spotActive;
};

class HotspotList : public Common::List<Hotspot *> {
public:
	HotspotList();
	virtual ~HotspotList();

	void deleteHotspots();

	Hotspot *findHotspot(const Common::Point);
	tHotSpotID findHotspotID(const Common::Point);
	Hotspot * findHotspotByID(const tHotSpotID);
	Hotspot * findHotspotByMask(const tHotSpotFlags);

	void activateMaskedHotspots(const tHotSpotFlags = kNoHotSpotFlags);
	void deactivateAllHotspots();
	void deactivateMaskedHotspots(const tHotSpotFlags);

	void activateOneHotspot(const tHotSpotID);
	void deactivateOneHotspot(const tHotSpotID);
	
	void removeOneHotspot(const tHotSpotID);
	void removeMaskedHotspots(const tHotSpotFlags = kNoHotSpotFlags);

	void setHotspotRect(const tHotSpotID, const Common::Rect&);
	void getHotspotRect(const tHotSpotID, Common::Rect&);
};

typedef HotspotList::iterator HotspotIterator;

// FIXME: Remove global construction
extern HotspotList g_allHotspots;

} // End of namespace Pegasus

#endif