ScummVM API documentation
action_overlay_player.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 HOLLYWOOD_MONSTERS_SCENES_PLAYABLE_ACTION_OVERLAY_PLAYER_H
23#define HOLLYWOOD_MONSTERS_SCENES_PLAYABLE_ACTION_OVERLAY_PLAYER_H
24
25#include "common/types.h"
26
27#include "hollywood/monsters/scenes/animation_layers.h"
28
29namespace Hollywood {
30
38public:
40
41 void reset();
42 bool beginActorReplacement(uint newChunkIndex, uint newDescriptorCount,
43 const byte *frameMap, uint frameMapSize,
44 SceneAnimationStratum drawStratum = kSceneAnimationActorReplacement,
45 bool restoreBackground = false) {
46 return begin(newChunkIndex, newDescriptorCount, frameMap, frameMapSize,
47 drawStratum, true, restoreBackground);
48 }
49 void setFrame(uint frame);
50 void finish(bool previousHideActiveActor);
51 bool isVisible() const { return _layer.visible; }
52 bool replacesActor() const { return isVisible() && _hideActiveActor; }
53
55 SceneAnimationStratum _stratum;
56 bool _hideActiveActor;
57 bool _restoreBackgroundBeforeDraw;
58
59private:
60 friend class PlayableScene;
61 bool begin(uint newChunkIndex, uint newDescriptorCount, const byte *frameMap,
62 uint frameMapSize, SceneAnimationStratum stratum, bool hideActiveActor,
63 bool restoreBackground);
64};
65
66} // End of namespace Hollywood
67
68#endif // HOLLYWOOD_MONSTERS_SCENES_PLAYABLE_ACTION_OVERLAY_PLAYER_H
Definition: action_overlay_player.h:37
Definition: playable_scene.h:84
Definition: animation_layers.h:33