aboutsummaryrefslogtreecommitdiff
path: root/engines/sword25/gfx/animationresource.h
blob: f37931b9d95e407b660068c3a69980bdb1383dbc (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
/* ScummVM - Graphic Adventure Engine
 *
 * ScummVM is the legal property of its developers, whose names
 * are too numerous to list here. Please refer to the COPYRIGHT
 * file distributed with this source distribution.
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.

 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.

 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 *
 * $URL$
 * $Id$
 *
 */

/* 
 * This code is based on Broken Sword 2.5 engine
 *
 * Copyright (c) Malte Thiesen, Daniel Queteschiner and Michael Elsdoerfer
 *
 * Licensed under GNU GPL v2
 *
 */

#ifndef SWORD25_ANIMATIONRESOURCE_H
#define SWORD25_ANIMATIONRESOURCE_H

// -----------------------------------------------------------------------------
// Includes
// -----------------------------------------------------------------------------

#include "sword25/kernel/common.h"
#include "sword25/kernel/resource.h"
#include "sword25/gfx/animationdescription.h"
#include "sword25/gfx/animation.h"

#include "sword25/kernel/memlog_off.h"
#include <vector>
#include "sword25/kernel/memlog_on.h"

namespace Sword25 {

// -----------------------------------------------------------------------------
// Forward Declarations
// -----------------------------------------------------------------------------

class BS_Kernel;
class BS_PackageManager;
class TiXmlElement;

// -----------------------------------------------------------------------------
// Class Definition
// -----------------------------------------------------------------------------

class BS_AnimationResource : public BS_Resource, public BS_AnimationDescription
{
public:
	BS_AnimationResource(const Common::String & FileName);
	virtual ~BS_AnimationResource();

	virtual const Frame &	GetFrame(unsigned int Index) const { BS_ASSERT(Index < m_Frames.size()); return m_Frames[Index]; }
	virtual unsigned int	GetFrameCount() const { return m_Frames.size(); }
	virtual void			Unlock() { Release(); }

	BS_Animation::ANIMATION_TYPES	GetAnimationType() const { return m_AnimationType; }
	int								GetFPS() const { return m_FPS; }
	int								GetMillisPerFrame() const { return m_MillisPerFrame; }
	bool							IsScalingAllowed() const { return m_ScalingAllowed; }
	bool							IsAlphaAllowed() const { return m_AlphaAllowed; }
	bool							IsColorModulationAllowed() const { return m_ColorModulationAllowed; }
	bool							IsValid() const { return m_Valid; }

private:
	bool							m_Valid;

	std::vector<Frame>				m_Frames;

	//@{
	/** @name Dokument-Parser Methoden */

	bool ParseAnimationTag(TiXmlElement& AnimationTag, int& FPS, BS_Animation::ANIMATION_TYPES & AnimationType);
	bool ParseFrameTag(TiXmlElement& FrameTag, Frame& Frame, BS_PackageManager& PackageManager);

	//@}

	bool ComputeFeatures();
	bool PrecacheAllFrames() const;
};

} // End of namespace Sword25

#endif