ScummVM API documentation
movie_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_MOVIEGUMP_H
23#define ULTIMA8_GUMPS_MOVIEGUMP_H
24
25#include "common/str.h"
26#include "ultima/ultima8/gumps/modal_gump.h"
27#include "ultima/ultima8/usecode/intrinsics.h"
28#include "ultima/ultima8/misc/classtype.h"
29
30namespace Ultima {
31namespace Ultima8 {
32
33class RawArchive;
34class MoviePlayer;
35
36class MovieGump : public ModalGump {
37public:
38 ENABLE_RUNTIME_CLASSTYPE()
39
40 MovieGump();
41 MovieGump(int width, int height, Common::SeekableReadStream *rs,
42 bool introMusicHack = false, bool noScale = false,
43 const byte *overridePal = nullptr,
44 uint32 flags = FLAG_PREVENT_SAVE, int32 layer = LAYER_MODAL);
45 ~MovieGump() override;
46
47 void InitGump(Gump *newparent, bool take_focus = true) override;
48
49 void Close(bool no_del = false) override;
50
51 void run() override;
52
53 void PaintThis(RenderSurface *, int32 lerp_factor, bool scaled) override;
54
55 bool OnKeyDown(int key, int mod) override;
56
57 static ProcId U8MovieViewer(Common::SeekableReadStream *rs, bool fade, bool introMusicHack, bool noScale);
58 static MovieGump *CruMovieViewer(const Common::String fname, int x, int y, const byte *pal, Gump *parent, uint16 frameshape);
59
60 bool loadData(Common::ReadStream *rs);
61 void saveData(Common::WriteStream *ws) override;
62
63 INTRINSIC(I_playMovieOverlay);
64 INTRINSIC(I_playMovieCutscene);
65 INTRINSIC(I_playMovieCutsceneAlt);
66 INTRINSIC(I_playMovieCutsceneRegret);
67
68protected:
69 MoviePlayer *_player;
70
73
76
79
82
85
88
91
92};
93
94} // End of namespace Ultima8
95} // End of namespace Ultima
96
97#endif
Definition: stream.h:385
Definition: stream.h:745
Definition: str.h:59
Definition: stream.h:77
Definition: gump.h:46
Definition: modal_gump.h:34
Definition: movie_gump.h:36
void run() override
Run the gump.
void loadSubtitles(Common::SeekableReadStream *rs)
Load subtitles with format detection.
void ClearPlayerOffset()
Update the offset of the player if a shape has been set.
Common::HashMap< int, Common::String > _subtitles
Subtitles, by frame number. Only used for Crusader movies.
Definition: movie_gump.h:84
void loadTXTSubs(Common::SeekableReadStream *rs)
Load subtitles from a txt file (No Remorse format)
void PaintThis(RenderSurface *, int32 lerp_factor, bool scaled) override
Overloadable method to Paint just this Gump (RenderSurface is relative to this)
void loadIFFSubs(Common::SeekableReadStream *rs)
Load subtitles from a iff file (No Regret format)
void InitGump(Gump *newparent, bool take_focus=true) override
void Close(bool no_del=false) override
int _lastFrameNo
Last frame that was displayed, so we can catch up subtitles.
Definition: movie_gump.h:90
uint16 _subtitleWidget
Last widget used for displaying subtitles.
Definition: movie_gump.h:87
Definition: movie_player.h:30
Definition: render_surface.h:37