aboutsummaryrefslogtreecommitdiff
path: root/engines/sword25/gfx/fontresource.h
blob: d26c79c5755b016fe9b2a5fe7db21cb296b99abc (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
134
/* 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_FONTRESOURCE_H
#define SWORD25_FONTRESOURCE_H

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

#include "sword25/kernel/common.h"
#include "sword25/kernel/resource.h"
#include "sword25/math/rect.h"

class TiXmlDocument;
class TiXmlElement;

namespace Sword25 {

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

class BS_Kernel;

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

class BS_FontResource : public BS_Resource {
public:
	/**
	    @brief Erzeugt eine neues Exemplar von BS_FontResource
	    @param pKernel ein Pointer auf den Kernel
	    @param FileName der Dateiname der zu ladenen Resource
	    @remark Wenn der Konstruktor erfolgreich ausgef�hrt werden konnte gibt die Methode IsValid true zur�ck.
	*/
	BS_FontResource(BS_Kernel *pKernel, const Common::String &FileName);

	/**
	    @brief Gibt true zur�ck, wenn das Objekt korrekt initialisiert wurde.

	    Diese Methode kann dazu benutzt werden um festzustellen, ob der Konstruktor erfolgreich ausgef�hrt wurde.
	*/
	bool    IsValid() const {
		return _Valid;
	}

	/**
	    @brief Gibt die Zeilenh�he des Fonts in Pixeln zur�ck.

	    Die Zeilenh�he ist der Wert, der zur Y-Koordinate addiert wird, wenn ein Zeilenumbruch auftritt.
	*/
	int     GetLineHeight() const {
		return _LineHeight;
	}

	/**
	    @brief Gibt den Buchstabenabstand der Fonts in Pixeln zur�ck.

	    Der Buchstabenabstand ist der Wert, der zwischen zwei Buchstaben freigelassen wird.
	*/
	int     GetGapWidth() const {
		return _GapWidth;
	}

	/**
	    @brief Gibt das Bounding-Rect eines Zeichens auf der Charactermap zur�ck.
	    @param Character der ASCII-Code des Zeichens
	    @return Das Bounding-Rect des �bergebenen Zeichens auf der Charactermap.
	*/
	const BS_Rect &GetCharacterRect(int Character) const {
		BS_ASSERT(Character >= 0 && Character < 256);
		return _CharacterRects[Character];
	}

	/**
	    @brief Gibt den Dateinamen der Charactermap zur�ck.
	*/
	const Common::String &GetCharactermapFileName() const {
		return _BitmapFileName;
	}

private:
	BS_Kernel *_pKernel;
	bool        _Valid;
	Common::String  _BitmapFileName;
	int         _LineHeight;
	int         _GapWidth;
	BS_Rect     _CharacterRects[256];

	// -----------------------------------------------------------------------------
	// Hilfsmethoden
	// -----------------------------------------------------------------------------

	bool _ParseXMLDocument(const Common::String &FileName, TiXmlDocument &Doc) const;
	bool _ParseFontTag(TiXmlElement &Tag, Common::String &BitmapFileName, int &LineHeight, int &GapWidth) const;
	bool _ParseCharacterTag(TiXmlElement &Tag, int &Code, BS_Rect &Rect) const;
};

} // End of namespace Sword25

#endif