ScummVM API documentation
Animation.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 * Copyright (C) 2006-2010 - Frictional Games
24 *
25 * This file is part of HPL1 Engine.
26 */
27
28#ifndef HPL_ANIMATION_H
29#define HPL_ANIMATION_H
30
31#include "common/array.h"
32#include "hpl1/engine/graphics/GraphicsTypes.h"
33#include "hpl1/engine/math/MathTypes.h"
34#include "hpl1/engine/resources/ResourceBase.h"
35#include "hpl1/engine/system/SystemTypes.h"
36
37namespace hpl {
38
39class cAnimationTrack;
40
41typedef Common::Array<cAnimationTrack *> tAnimationTrackVec;
42typedef tAnimationTrackVec::iterator tAnimationTrackVecIt;
43
44class cAnimation : public iResourceBase {
45public:
46 cAnimation(const tString &asName, const tString &asFile);
48
49 float GetLength();
50 void SetLength(float afTime);
51
52 cAnimationTrack *CreateTrack(const tString &asName, tAnimTransformFlag aFlags);
53 cAnimationTrack *GetTrack(int alIndex);
54 cAnimationTrack *GetTrackByName(const tString &asName);
55 void ResizeTracks(int alNum);
56 int GetTrackNum();
57
58 const char *GetAnimationName() { return msAnimName.c_str(); }
59 void SetAnimationName(const tString &asName) { msAnimName = asName; }
60
61 tString &GetFileName() { return msFileName; }
62
63 // Resources implementation
64 bool reload() { return false; }
65 void unload() {}
66 void destroy() {}
67
68private:
69 tString msAnimName;
70 tString msFileName;
71
72 float mfLength;
73
74 tAnimationTrackVec mvTracks;
75};
76
77} // namespace hpl
78
79#endif // HPL_ANIMATION_H
cAnimationTrack * * iterator
Definition: array.h:54
Definition: str.h:59
Definition: Animation.h:44
bool reload()
Definition: Animation.h:64
void destroy()
Definition: Animation.h:66
void unload()
Definition: Animation.h:65
Definition: AnimationTrack.h:40
Definition: ResourceBase.h:36