aboutsummaryrefslogtreecommitdiff
path: root/engines/sword25/gfx/animationtemplate.h
blob: e39fb648808a2552350e5f5724b2a715623f37f1 (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
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
/* 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_ANIMATION_TEMPLATE_H
#define SWORD25_ANIMATION_TEMPLATE_H

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

#include "sword25/kernel/common.h"
#include "sword25/kernel/persistable.h"
#include "sword25/gfx/animationdescription.h"

namespace Sword25 {

// -----------------------------------------------------------------------------
// Forward declarations
// -----------------------------------------------------------------------------

class AnimationResource;

// -----------------------------------------------------------------------------
// Klassendefinition
// -----------------------------------------------------------------------------

class AnimationTemplate : public AnimationDescription {
public:
	static uint Create(const Common::String &SourceAnimation);
	static uint Create(const AnimationTemplate &Other);
	static uint Create(InputPersistenceBlock &Reader, uint Handle);
	AnimationTemplate *ResolveHandle(uint Handle) const;

private:
	AnimationTemplate(const Common::String &SourceAnimation);
	AnimationTemplate(const AnimationTemplate &Other);
	AnimationTemplate(InputPersistenceBlock &Reader, uint Handle);

public:
	~AnimationTemplate();

	virtual const Frame    &getFrame(uint Index) const {
		BS_ASSERT(Index < _frames.size());
		return _frames[Index];
	}
	virtual uint    getFrameCount() const {
		return _frames.size();
	}
	virtual void            unlock() {
		delete this;
	}

	bool isValid() const {
		return _valid;
	}

	/**
	    @brief F�gt einen neuen Frame zur Animation hinzu.

	    Der Frame wird an das Ende der Animation angeh�ngt.

	    @param Index der Index des Frames in der Quellanimation
	*/
	void AddFrame(int Index);

	/**
	    @brief �ndert einen bereits in der Animation vorhandenen Frame.
	    @param DestIndex der Index des Frames der �berschrieben werden soll
	    @param SrcIndex der Index des einzuf�genden Frames in der Quellanimation
	*/
	void SetFrame(int DestIndex, int SrcIndex);

	/**
	    @brief Setzt den Animationstyp.
	    @param Type der Typ der Animation. Muss aus den enum BS_Animation::ANIMATION_TYPES sein.
	*/
	void SetAnimationType(Animation::ANIMATION_TYPES Type) {
		_animationType = Type;
	}

	/**
	    @brief Setzt die Abspielgeschwindigkeit.
	    @param FPS die Abspielgeschwindigkeit in Frames pro Sekunde.
	*/
	void SetFPS(int FPS);

	virtual bool persist(OutputPersistenceBlock &writer);
	virtual bool unpersist(InputPersistenceBlock &reader);

private:
	Common::Array<Frame>  _frames;
	AnimationResource    *_sourceAnimationPtr;
	bool                  _valid;

	AnimationResource *RequestSourceAnimation(const Common::String &SourceAnimation) const;
	bool ValidateSourceIndex(uint Index) const;
	bool ValidateDestIndex(uint Index) const;
};

} // End of namespace Sword25

#endif