ScummVM API documentation
animationdescription.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/*
23 * This code is based on Broken Sword 2.5 engine
24 *
25 * Copyright (c) Malte Thiesen, Daniel Queteschiner and Michael Elsdoerfer
26 *
27 * Licensed under GNU GPL v2
28 *
29 */
30
31#ifndef SWORD25_ANIMATIONDESCRIPTION_H
32#define SWORD25_ANIMATIONDESCRIPTION_H
33
34#include "sword25/kernel/common.h"
35#include "sword25/kernel/persistable.h"
36#include "sword25/gfx/animation.h"
37
38namespace Sword25 {
39
41protected:
43 _animationType(Animation::AT_LOOP),
44 _FPS(10),
45 _millisPerFrame(0),
46 _scalingAllowed(true),
47 _alphaAllowed(true),
48 _colorModulationAllowed(true)
49 {}
50
51public:
52 struct Frame {
53 // Die Hotspot-Angabe bezieht sich auf das ungeflippte Bild!!
54 int32 hotspotX;
55 int32 hotspotY;
56 bool flipV;
57 bool flipH;
58 Common::String fileName;
59 Common::String action;
60 };
61
62 virtual const Frame &getFrame(uint index) const = 0;
63 virtual uint getFrameCount() const = 0;
64 virtual void unlock() = 0;
65
66 Animation::ANIMATION_TYPES getAnimationType() const {
67 return _animationType;
68 }
69 int getFPS() const {
70 return _FPS;
71 }
72 int getMillisPerFrame() const {
73 return _millisPerFrame;
74 }
75 bool isScalingAllowed() const {
76 return _scalingAllowed;
77 }
78 bool isAlphaAllowed() const {
79 return _alphaAllowed;
80 }
81 bool isColorModulationAllowed() const {
82 return _colorModulationAllowed;
83 }
84
85 bool persist(OutputPersistenceBlock &writer) override;
86 bool unpersist(InputPersistenceBlock &reader) override;
87
88protected:
89 Animation::ANIMATION_TYPES _animationType;
90 int32 _FPS;
91 int32 _millisPerFrame;
92 bool _scalingAllowed;
93 bool _alphaAllowed;
94 bool _colorModulationAllowed;
95};
96
97} // End of namespace Sword25
98
99#endif
Definition: str.h:59
Definition: animationdescription.h:40
Definition: persistable.h:39
Definition: console.h:27
Definition: animationdescription.h:52