ScummVM API documentation
shape_viewer_gump.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  * This program is free software: you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License as published by
9  * the Free Software Foundation, either version 3 of the License, or
10  * (at your option) any later version.
11  *
12  * This program is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program. If not, see <http://www.gnu.org/licenses/>.
19  *
20  */
21 
22 #ifndef ULTIMA8_GUMPS_SHAPEVIEWERGUMP_H
23 #define ULTIMA8_GUMPS_SHAPEVIEWERGUMP_H
24 
25 #include "ultima/ultima8/gumps/modal_gump.h"
26 #include "ultima/ultima8/misc/classtype.h"
27 
28 namespace Ultima {
29 namespace Ultima8 {
30 
31 class ShapeArchive;
32 
36 class ShapeViewerGump : public ModalGump {
37 public:
39  Common::String _name;
40  ShapeArchive *_archive;
41  DisposeAfterUse::Flag _disposeAfterUse;
42 
43  ShapeArchiveEntry(const char *name, ShapeArchive *archive, DisposeAfterUse::Flag disposeAfterUse = DisposeAfterUse::NO)
44  : _name(name), _archive(archive), _disposeAfterUse(disposeAfterUse) {}
45  };
46 
47  ENABLE_RUNTIME_CLASSTYPE()
48 
50  ShapeViewerGump(int x, int y, int width, int height,
52  uint32 flags = FLAG_PREVENT_SAVE, int32 layer = LAYER_MODAL);
53  ~ShapeViewerGump() override;
54 
55  void PaintThis(RenderSurface *, int32 lerp_factor, bool scaled) override;
56 
57  bool OnKeyDown(int key, int mod) override;
58 
59  // Init the gump, call after construction
60  void InitGump(Gump *newparent, bool take_focus = true) override;
61 
62  static void U8ShapeViewer();
63 
64  bool loadData(Common::ReadStream *rs);
65  void saveData(Common::WriteStream *ws) override;
66 
67 protected:
69  unsigned int _curArchive;
70  uint32 _curShape;
71  uint32 _curFrame;
72 
73  uint32 _background;
74 
76  uint32 _fontNo;
77 
78  bool _showGrid;
79  bool _mirrored;
80 
81  int32 _shapeW, _shapeH, _shapeX, _shapeY;
82 };
83 
84 } // End of namespace Ultima8
85 } // End of namespace Ultima
86 
87 #endif
Definition: shape_archive.h:34
Definition: str.h:59
Definition: shape_viewer_gump.h:38
Definition: stream.h:77
Definition: array.h:52
void PaintThis(RenderSurface *, int32 lerp_factor, bool scaled) override
Overloadable method to Paint just this Gump (RenderSurface is relative to this)
void InitGump(Gump *newparent, bool take_focus=true) override
Definition: shape_viewer_gump.h:36
Definition: modal_gump.h:34
Definition: render_surface.h:37
Definition: gump.h:46
Definition: detection.h:27
uint32 _fontNo
The font used in the shape viewer.
Definition: shape_viewer_gump.h:76
Definition: stream.h:385