File: SpriteFont.cs

package info (click to toggle)
monogame 2.5.1%2Bdfsg-3
  • links: PTS, VCS
  • area: main
  • in suites: wheezy
  • size: 6,044 kB
  • sloc: cs: 65,996; xml: 591; makefile: 22; ansic: 8
file content (422 lines) | stat: -rw-r--r-- 13,356 bytes parent folder | download | duplicates (2)
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
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
#region License
/*
Microsoft Public License (Ms-PL)
MonoGame - Copyright  2009-2012 The MonoGame Team

All rights reserved.

This license governs use of the accompanying software. If you use the software,
you accept this license. If you do not accept the license, do not use the
software.

1. Definitions

The terms "reproduce," "reproduction," "derivative works," and "distribution"
have the same meaning here as under U.S. copyright law.

A "contribution" is the original software, or any additions or changes to the
software.

A "contributor" is any person that distributes its contribution under this
license.

"Licensed patents" are a contributor's patent claims that read directly on its
contribution.

2. Grant of Rights

(A) Copyright Grant- Subject to the terms of this license, including the
license conditions and limitations in section 3, each contributor grants you a
non-exclusive, worldwide, royalty-free copyright license to reproduce its
contribution, prepare derivative works of its contribution, and distribute its
contribution or any derivative works that you create.

(B) Patent Grant- Subject to the terms of this license, including the license
conditions and limitations in section 3, each contributor grants you a
non-exclusive, worldwide, royalty-free license under its licensed patents to
make, have made, use, sell, offer for sale, import, and/or otherwise dispose of
its contribution in the software or derivative works of the contribution in the
software.

3. Conditions and Limitations

(A) No Trademark License- This license does not grant you rights to use any
contributors' name, logo, or trademarks.

(B) If you bring a patent claim against any contributor over patents that you
claim are infringed by the software, your patent license from such contributor
to the software ends automatically.

(C) If you distribute any portion of the software, you must retain all
copyright, patent, trademark, and attribution notices that are present in the
software.

(D) If you distribute any portion of the software in source code form, you may
do so only under this license by including a complete copy of this license with
your distribution. If you distribute any portion of the software in compiled or
object code form, you may only do so under a license that complies with this
license.

(E) The software is licensed "as-is." You bear the risk of using it. The
contributors give no express warranties, guarantees or conditions. You may have
additional consumer rights under your local laws which this license cannot
change. To the extent permitted under your local laws, the contributors exclude
the implied warranties of merchantability, fitness for a particular purpose and
non-infringement.
*/
#endregion License

// Original code from SilverSprite Project
using System;
using System.Collections.Generic;
using System.Collections.ObjectModel;
using System.Text;

namespace Microsoft.Xna.Framework.Graphics {
	public sealed class SpriteFont {
		static class Errors {
			public const string TextContainsUnresolvableCharacters =
				"Text contains characters that cannot be resolved by this SpriteFont.";
		}

		[ThreadStatic]
		private static Typesetter PerThreadTypesetter;

		private Dictionary<char, Glyph> _glyphs;
		private Texture2D _texture;

		internal SpriteFont (
			Texture2D texture, List<Rectangle> glyphBounds, List<Rectangle> cropping, List<char> characters,
			int lineSpacing, float spacing, List<Vector3> kerning, char? defaultCharacter)
		{
			_characters = new ReadOnlyCollection<char> (characters.ToArray ());
			_texture = texture;
			LineSpacing = lineSpacing;
			Spacing = spacing;
			DefaultCharacter = defaultCharacter;

			_glyphs = new Dictionary<char, Glyph> (characters.Count);
			for (int i = 0; i < characters.Count; i++) {
				Glyph glyph = new Glyph {
					BoundsInTexture = glyphBounds [i],
					Cropping = cropping [i],
					Kerning = kerning [i],
					Character = characters [i]
				};
				_glyphs.Add (glyph.Character, glyph);
			}
		}

		private ReadOnlyCollection<char> _characters;
		/// <summary>
		/// Gets a collection of the characters in the font.
		/// </summary>
		public ReadOnlyCollection<char> Characters { get { return _characters; } }

		/// <summary>
		/// Gets or sets the character that will be substituted when a
		/// given character is not included in the font.
		/// </summary>
		public char? DefaultCharacter { get; set; }

		/// <summary>
		/// Gets or sets the line spacing (the distance from baseline
		/// to baseline) of the font.
		/// </summary>
		public int LineSpacing { get; set; }

		/// <summary>
		/// Gets or sets the spacing (tracking) between characters in
		/// the font.
		/// </summary>
		public float Spacing { get; set; }

		/// <summary>
		/// Returns the size of a string when rendered in this font.
		/// </summary>
		/// <param name="text">The text to measure.</param>
		/// <returns>The size, in pixels, of 'text' when rendered in
		/// this font.</returns>
		public Vector2 MeasureString (string text)
		{
			var source = new CharacterSource (text);
			Vector2 size;
			MeasureString (ref source, out size);
			return size;
		}

		/// <summary>
		/// Returns the size of the contents of a StringBuilder when
		/// rendered in this font.
		/// </summary>
		/// <param name="text">The text to measure.</param>
		/// <returns>The size, in pixels, of 'text' when rendered in
		/// this font.</returns>
		public Vector2 MeasureString (StringBuilder text)
		{
			var source = new CharacterSource (text);
			Vector2 size;
			MeasureString (ref source, out size);
			return size;
		}

		private void MeasureString (ref CharacterSource text, out Vector2 size)
		{
			if (text.Length == 0) {
				size = Vector2.Zero;
				return;
			}

			PerThreadTypesetter.Reset (this);
			for (int i = 0; i < text.Length; ++i)
				PerThreadTypesetter.Input (text [i]);
			PerThreadTypesetter.GetSize (out size);
		}

		internal void DrawInto (
			SpriteBatch spriteBatch, string text, Vector2 position, Color color,
			float rotation, Vector2 origin, Vector2 scale, SpriteEffects effect, float depth)
		{
			var source = new CharacterSource (text);
			DrawInto (spriteBatch, ref source, position, color, rotation, origin, scale, effect, depth);
		}

		internal void DrawInto (
			SpriteBatch spriteBatch, StringBuilder text, Vector2 position, Color color,
			float rotation, Vector2 origin, Vector2 scale, SpriteEffects effect, float depth)
		{
			var source = new CharacterSource (text);
			DrawInto (spriteBatch, ref source, position, color, rotation, origin, scale, effect, depth);
		}

		private void DrawInto (
			SpriteBatch spriteBatch, ref CharacterSource text, Vector2 position, Color color,
			float rotation, Vector2 origin, Vector2 scale, SpriteEffects effect, float depth)
		{
			Matrix transformation;
			CreateTransformationFromDrawParameters (
				ref text, position, rotation, origin, scale, effect, out transformation);

			var flippedVert = (effect & SpriteEffects.FlipVertically) == SpriteEffects.FlipVertically;
			var flippedHorz = (effect & SpriteEffects.FlipHorizontally) == SpriteEffects.FlipHorizontally;

			PerThreadTypesetter.Reset (this);
			for (int i = 0; i < text.Length; ++i) {
				PerThreadTypesetter.Input (text [i]);
				if (!PerThreadTypesetter.HasCurrentGlyph)
					continue;

				var p = PerThreadTypesetter.Offset;

				if (flippedHorz)
					p.X += PerThreadTypesetter.CurrentGlyph.BoundsInTexture.Width;
				p.X += PerThreadTypesetter.CurrentGlyph.Cropping.X;

				if (flippedVert)
					p.Y += PerThreadTypesetter.CurrentGlyph.BoundsInTexture.Height - LineSpacing;
				p.Y += PerThreadTypesetter.CurrentGlyph.Cropping.Y;

				Vector2.Transform (ref p, ref transformation, out p);
				spriteBatch.Draw (
					_texture, p, PerThreadTypesetter.CurrentGlyph.BoundsInTexture,
					color, rotation, Vector2.Zero, scale, effect, depth);
			}
		}

		private void CreateTransformationFromDrawParameters (
			ref CharacterSource text, Vector2 position, float rotation, Vector2 origin, Vector2 scale,
			SpriteEffects effect, out Matrix transformation)
		{
			Vector2 flipAdjustment = Vector2.Zero;
			if ((effect & (SpriteEffects.FlipHorizontally | SpriteEffects.FlipVertically)) != 0) {
				Vector2 size;
				MeasureString (ref text, out size);

				if ((effect & SpriteEffects.FlipHorizontally) == SpriteEffects.FlipHorizontally) {
					origin.X *= -1;
					scale.X *= -1;
					flipAdjustment.X = -size.X;
				}

				if ((effect & SpriteEffects.FlipVertically) == SpriteEffects.FlipVertically) {
					origin.Y *= -1;
					scale.Y *= -1;
					flipAdjustment.Y = LineSpacing - size.Y;
				}
			}

			Matrix temp;
			Matrix.CreateTranslation (-origin.X, -origin.Y, 0f, out transformation);
			Matrix.CreateScale (scale.X, scale.Y, 1f, out temp);
			Matrix.Multiply (ref transformation, ref temp, out transformation);

			Matrix.CreateTranslation (flipAdjustment.X, flipAdjustment.Y, 0, out temp);
			Matrix.Multiply (ref temp, ref transformation, out transformation);

			Matrix.CreateRotationZ (rotation, out temp);
			Matrix.Multiply (ref transformation, ref temp, out transformation);

			Matrix.CreateTranslation (position.X, position.Y, 0f, out temp);
			Matrix.Multiply (ref transformation, ref temp, out transformation);
		}

		private bool ResolveGlyphWithFallback (char c, out Glyph glyph)
		{
			if (_glyphs.TryGetValue (c, out glyph))
				return true;

			if (DefaultCharacter.HasValue && _glyphs.TryGetValue (DefaultCharacter.Value, out glyph))
				return true;

			glyph = Glyph.Empty;
			return false;
		}

		struct CharacterSource {
			private readonly string _string;
			private readonly StringBuilder _builder;

			public CharacterSource (string s)
			{
				_string = s;
				_builder = null;
				Length = s.Length;
			}

			public CharacterSource (StringBuilder builder)
			{
				_builder = builder;
				_string = null;
				Length = _builder.Length;
			}

			public readonly int Length;
			public char this [int index] {
				get {
					if (_string != null)
						return _string [index];
					return _builder [index];
				}
			}
		}

		struct Glyph {
			public char Character;
			public Rectangle BoundsInTexture;
			public Rectangle Cropping;
			public Vector3 Kerning;

			private static readonly Glyph _empty = new Glyph ();
			public static Glyph Empty { get { return _empty; } }

			public float LeftSideBearing { get { return Kerning.X; } }
			public float RightSideBearing { get { return Kerning.Z; } }
			public float Width { get { return Kerning.Y; } }
			public float WidthIncludingBearings {
				get { return Kerning.X + Kerning.Y + Kerning.Z; }
			}

			public override string ToString ()
			{
				return string.Format (
					"CharacterIndex={0}, Glyph={1}, Cropping={2}, Kerning={3}",
					Character, BoundsInTexture, Cropping, Kerning);
			}
		}

		struct Typesetter {
			private SpriteFont _font;
			private float _width;
			private float _finalLineHeight;
			private int _fullLineCount;

			public bool HasCurrentGlyph;
			public Glyph CurrentGlyph;
			public Vector2 Offset;

			public void GetSize (out Vector2 size)
			{
				size.X = _width;
				size.Y = _fullLineCount * _font.LineSpacing + _finalLineHeight;
			}

			public void Reset (SpriteFont font)
			{
				_font = font;
				Offset.X = 0;
				Offset.Y = 0;
				_width = 0;
				_finalLineHeight = font.LineSpacing;
				_fullLineCount = 0;
				HasCurrentGlyph = false;
			}

			public void Input (char c)
			{
				if (c == '\r') {
					HasCurrentGlyph = false;
					return;
				}

				if (c == '\n') {
					_fullLineCount++;
					_finalLineHeight = _font.LineSpacing;
					HasCurrentGlyph = false;

					Offset.X = 0;
					Offset.Y = _font.LineSpacing * _fullLineCount;
					return;
				}

				if (HasCurrentGlyph)
					Offset.X += _font.Spacing + CurrentGlyph.WidthIncludingBearings;

				HasCurrentGlyph = _font.ResolveGlyphWithFallback (c, out CurrentGlyph);
				if (!HasCurrentGlyph)
					throw new ArgumentException (
						Errors.TextContainsUnresolvableCharacters, "text");

				UpdateWidth ();
				UpdateCurrentLineHeight ();
			}

			private void UpdateWidth ()
			{
				float proposedWidth = Offset.X + CurrentGlyph.WidthIncludingBearings;
				if (proposedWidth > _width)
					_width = proposedWidth;
			}

			private void UpdateCurrentLineHeight ()
			{
				if (CurrentGlyph.Cropping.Height > _finalLineHeight)
					_finalLineHeight = CurrentGlyph.Cropping.Height;
			}
		}

		#region Deprecated

		[Obsolete ("AssetName does not seem to be in use.", true)]
		internal string AssetName;

		[Obsolete ("SpriteFont.FontSize does not exist in XNA and is deprecated.")]
		public double FontSize
		{
			get { return 11; }
		}

		[Obsolete ("SpriteFont.Bold does not exist in XNA and is deprecated.")]
		public bool Bold
		{
			get { return false; }
		}

		[Obsolete ("SpriteFont.Italic does not exist in XNA and is deprecated.")]
		public bool Italic
		{
			get { return false; }
		}

		#endregion Deprecated
	}
}