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
|
/* 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.
*
* 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/>.
*
*/
#ifndef ULTIMA_SHARED_GFX_VISUAL_ITEM_H
#define ULTIMA_SHARED_GFX_VISUAL_ITEM_H
#include "graphics/managed_surface.h"
#include "ultima/shared/core/named_item.h"
#include "ultima/shared/gfx/screen.h"
#include "ultima/shared/gfx/visual_surface.h"
namespace Ultima {
namespace Shared {
namespace Gfx {
class Popup;
/**
* Acts as the base class for all classes that have a visual representation on the screen
*/
class VisualItem : public NamedItem {
friend class VisualSurface;
DECLARE_MESSAGE_MAP;
bool ShowMsg(CShowMsg *msg);
bool HideMsg(CHideMsg *msg);
private:
/**
* Common initialization method used by the constructors
*/
void init(TreeItem *parent = nullptr);
protected:
Rect _bounds;
bool _isDirty;
public:
CLASSDEF;
VisualItem(TreeItem *parent = nullptr) { init(parent); }
VisualItem(const Rect &r, TreeItem *parent = nullptr) : _bounds(r) { init(parent); }
VisualItem(const Common::String &name, TreeItem *parent = nullptr) : NamedItem(name) { init(parent); }
VisualItem(const Common::String &name, const Rect &r, TreeItem *parent = nullptr) : NamedItem(name),
_bounds(r) { init(parent); }
~VisualItem() override {
}
/**
* Draws the visual item on the screen
*/
virtual void draw() {
_isDirty = false;
}
/**
* Gets a managed surface representing the portion of the screen defined by _bounds.
* This allows drawing to be done without worrying about offsets or clipping
*/
VisualSurface getSurface();
/**
* Gets the bounds for the item
*/
const Rect &getBounds() { return _bounds; }
/**
* Sets the bounds for the item
* @remarks Does not erase the item if it's already been drawn
*/
void setBounds(const Rect &r);
/**
* Set the position for the item
* @remarks Does not erase the item if it's already been drawn
*/
void setPosition(const Point &pt);
/**
* Flags the item as being changed, requiring a redraw
*/
virtual void setDirty(bool dirty = true);
/**
* Clears the dirty flag
*/
void clearDirty() { setDirty(false); }
/**
* Returns true if the item is dirty, requiring a redraw
*/
virtual bool isDirty() const { return _isDirty; }
/**
* Helper function to switch to a different visual item
*/
void setView(const Common::String &viewName);
/**
* Helper function to switch to an on-screen popup
*/
void setPopup(Gfx::Popup *popup);
/**
* Helper function to switch the item to be the current view
*/
void setView();
};
} // End of namespace Gfx
} // End of namespace Shared
} // End of namespace Ultima
#endif
|
