TMP_Settings.cs
17.2 KB
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
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
using UnityEngine;
using System.Collections;
using System.Collections.Generic;
#pragma warning disable 0649 // Disabled warnings related to serialized fields not assigned in this script but used in the editor.
namespace TMPro
{
/// <summary>
/// Scaling options for the sprites
/// </summary>
//public enum SpriteRelativeScaling
//{
// RelativeToPrimary = 0x1,
// RelativeToCurrent = 0x2,
//}
[System.Serializable][ExcludeFromPresetAttribute]
public class TMP_Settings : ScriptableObject
{
private static TMP_Settings s_Instance;
/// <summary>
/// Returns the release version of the product.
/// </summary>
public static string version
{
get { return "1.4.0"; }
}
/// <summary>
/// Controls if Word Wrapping will be enabled on newly created text objects by default.
/// </summary>
public static bool enableWordWrapping
{
get { return instance.m_enableWordWrapping; }
}
[SerializeField]
private bool m_enableWordWrapping;
/// <summary>
/// Controls if Kerning is enabled on newly created text objects by default.
/// </summary>
public static bool enableKerning
{
get { return instance.m_enableKerning; }
}
[SerializeField]
private bool m_enableKerning;
/// <summary>
/// Controls if Extra Padding is enabled on newly created text objects by default.
/// </summary>
public static bool enableExtraPadding
{
get { return instance.m_enableExtraPadding; }
}
[SerializeField]
private bool m_enableExtraPadding;
/// <summary>
/// Controls if TintAllSprites is enabled on newly created text objects by default.
/// </summary>
public static bool enableTintAllSprites
{
get { return instance.m_enableTintAllSprites; }
}
[SerializeField]
private bool m_enableTintAllSprites;
/// <summary>
/// Controls if Escape Characters will be parsed in the Text Input Box on newly created text objects.
/// </summary>
public static bool enableParseEscapeCharacters
{
get { return instance.m_enableParseEscapeCharacters; }
}
[SerializeField]
private bool m_enableParseEscapeCharacters;
/// <summary>
/// Controls if Raycast Target is enabled by default on newly created text objects.
/// </summary>
public static bool enableRaycastTarget
{
get { return instance.m_EnableRaycastTarget; }
}
[SerializeField]
private bool m_EnableRaycastTarget = true;
/// <summary>
/// Determines if OpenType Font Features should be retrieved at runtime from the source font file.
/// </summary>
public static bool getFontFeaturesAtRuntime
{
get { return instance.m_GetFontFeaturesAtRuntime; }
}
[SerializeField]
private bool m_GetFontFeaturesAtRuntime = true;
/// <summary>
/// The character that will be used as a replacement for missing glyphs in a font asset.
/// </summary>
public static int missingGlyphCharacter
{
get { return instance.m_missingGlyphCharacter; }
set { instance.m_missingGlyphCharacter = value; }
}
[SerializeField]
private int m_missingGlyphCharacter;
/// <summary>
/// Controls the display of warning message in the console.
/// </summary>
public static bool warningsDisabled
{
get { return instance.m_warningsDisabled; }
}
[SerializeField]
private bool m_warningsDisabled;
/// <summary>
/// Returns the Default Font Asset to be used by newly created text objects.
/// </summary>
public static TMP_FontAsset defaultFontAsset
{
get { return instance.m_defaultFontAsset; }
}
[SerializeField]
private TMP_FontAsset m_defaultFontAsset;
/// <summary>
/// The relative path to a Resources folder in the project.
/// </summary>
public static string defaultFontAssetPath
{
get { return instance.m_defaultFontAssetPath; }
}
[SerializeField]
private string m_defaultFontAssetPath;
/// <summary>
/// The Default Point Size of newly created text objects.
/// </summary>
public static float defaultFontSize
{
get { return instance.m_defaultFontSize; }
}
[SerializeField]
private float m_defaultFontSize;
/// <summary>
/// The multiplier used to computer the default Min point size when Text Auto Sizing is used.
/// </summary>
public static float defaultTextAutoSizingMinRatio
{
get { return instance.m_defaultAutoSizeMinRatio; }
}
[SerializeField]
private float m_defaultAutoSizeMinRatio;
/// <summary>
/// The multiplier used to computer the default Max point size when Text Auto Sizing is used.
/// </summary>
public static float defaultTextAutoSizingMaxRatio
{
get { return instance.m_defaultAutoSizeMaxRatio; }
}
[SerializeField]
private float m_defaultAutoSizeMaxRatio;
/// <summary>
/// The Default Size of the Text Container of a TextMeshPro object.
/// </summary>
public static Vector2 defaultTextMeshProTextContainerSize
{
get { return instance.m_defaultTextMeshProTextContainerSize; }
}
[SerializeField]
private Vector2 m_defaultTextMeshProTextContainerSize;
/// <summary>
/// The Default Width of the Text Container of a TextMeshProUI object.
/// </summary>
public static Vector2 defaultTextMeshProUITextContainerSize
{
get { return instance.m_defaultTextMeshProUITextContainerSize; }
}
[SerializeField]
private Vector2 m_defaultTextMeshProUITextContainerSize;
/// <summary>
/// Set the size of the text container of newly created text objects to match the size of the text.
/// </summary>
public static bool autoSizeTextContainer
{
get { return instance.m_autoSizeTextContainer; }
}
[SerializeField]
private bool m_autoSizeTextContainer;
/// <summary>
/// Disables InternalUpdate() calls when true. This can improve performance when the scale of the text object is static.
/// </summary>
public static bool isTextObjectScaleStatic
{
get { return instance.m_IsTextObjectScaleStatic; }
set { instance.m_IsTextObjectScaleStatic = value; }
}
[SerializeField]
private bool m_IsTextObjectScaleStatic;
/// <summary>
/// Returns the list of Fallback Fonts defined in the TMP Settings file.
/// </summary>
public static List<TMP_FontAsset> fallbackFontAssets
{
get { return instance.m_fallbackFontAssets; }
}
[SerializeField]
private List<TMP_FontAsset> m_fallbackFontAssets;
/// <summary>
/// Controls whether or not TMP will create a matching material preset or use the default material of the fallback font asset.
/// </summary>
public static bool matchMaterialPreset
{
get { return instance.m_matchMaterialPreset; }
}
[SerializeField]
private bool m_matchMaterialPreset;
/// <summary>
/// The Default Sprite Asset to be used by default.
/// </summary>
public static TMP_SpriteAsset defaultSpriteAsset
{
get { return instance.m_defaultSpriteAsset; }
}
[SerializeField]
private TMP_SpriteAsset m_defaultSpriteAsset;
/// <summary>
/// The relative path to a Resources folder in the project.
/// </summary>
public static string defaultSpriteAssetPath
{
get { return instance.m_defaultSpriteAssetPath; }
}
[SerializeField]
private string m_defaultSpriteAssetPath;
/// <summary>
/// Determines if Emoji support is enabled in the Input Field TouchScreenKeyboard.
/// </summary>
public static bool enableEmojiSupport
{
get { return instance.m_enableEmojiSupport; }
set { instance.m_enableEmojiSupport = value; }
}
[SerializeField]
private bool m_enableEmojiSupport;
/// <summary>
/// The unicode value of the sprite that will be used when the requested sprite is missing from the sprite asset and potential fallbacks.
/// </summary>
public static uint missingCharacterSpriteUnicode
{
get { return instance.m_MissingCharacterSpriteUnicode; }
set { instance.m_MissingCharacterSpriteUnicode = value; }
}
[SerializeField]
private uint m_MissingCharacterSpriteUnicode;
/// <summary>
/// Determines if sprites will be scaled relative to the primary font asset assigned to the text object or relative to the current font asset.
/// </summary>
//public static SpriteRelativeScaling spriteRelativeScaling
//{
// get { return instance.m_SpriteRelativeScaling; }
// set { instance.m_SpriteRelativeScaling = value; }
//}
//[SerializeField]
//private SpriteRelativeScaling m_SpriteRelativeScaling = SpriteRelativeScaling.RelativeToCurrent;
/// <summary>
/// The relative path to a Resources folder in the project that contains Color Gradient Presets.
/// </summary>
public static string defaultColorGradientPresetsPath
{
get { return instance.m_defaultColorGradientPresetsPath; }
}
[SerializeField]
private string m_defaultColorGradientPresetsPath;
/// <summary>
/// The Default Style Sheet used by the text objects.
/// </summary>
public static TMP_StyleSheet defaultStyleSheet
{
get { return instance.m_defaultStyleSheet; }
}
[SerializeField]
private TMP_StyleSheet m_defaultStyleSheet;
/// <summary>
/// The relative path to a Resources folder in the project that contains the TMP Style Sheets.
/// </summary>
public static string styleSheetsResourcePath
{
get { return instance.m_StyleSheetsResourcePath; }
}
[SerializeField]
private string m_StyleSheetsResourcePath;
/// <summary>
/// Text file that contains the leading characters used for line breaking for Asian languages.
/// </summary>
public static TextAsset leadingCharacters
{
get { return instance.m_leadingCharacters; }
}
[SerializeField]
private TextAsset m_leadingCharacters;
/// <summary>
/// Text file that contains the following characters used for line breaking for Asian languages.
/// </summary>
public static TextAsset followingCharacters
{
get { return instance.m_followingCharacters; }
}
[SerializeField]
private TextAsset m_followingCharacters;
/// <summary>
///
/// </summary>
public static LineBreakingTable linebreakingRules
{
get
{
if (instance.m_linebreakingRules == null)
LoadLinebreakingRules();
return instance.m_linebreakingRules;
}
}
[SerializeField]
private LineBreakingTable m_linebreakingRules;
// TODO : Potential new feature to explore where multiple font assets share the same atlas texture.
//internal static TMP_DynamicAtlasTextureGroup managedAtlasTextures
//{
// get
// {
// if (instance.m_DynamicAtlasTextureGroup == null)
// {
// instance.m_DynamicAtlasTextureGroup = TMP_DynamicAtlasTextureGroup.CreateDynamicAtlasTextureGroup();
// }
// return instance.m_DynamicAtlasTextureGroup;
// }
//}
//[SerializeField]
//private TMP_DynamicAtlasTextureGroup m_DynamicAtlasTextureGroup;
/// <summary>
/// Determines if Modern or Traditional line breaking rules should be used for Korean text.
/// </summary>
public static bool useModernHangulLineBreakingRules
{
get { return instance.m_UseModernHangulLineBreakingRules; }
set { instance.m_UseModernHangulLineBreakingRules = value; }
}
[SerializeField]
private bool m_UseModernHangulLineBreakingRules;
/// <summary>
/// Get a singleton instance of the settings class.
/// </summary>
public static TMP_Settings instance
{
get
{
if (TMP_Settings.s_Instance == null)
{
TMP_Settings.s_Instance = Resources.Load<TMP_Settings>("TMP Settings");
#if UNITY_EDITOR
// Make sure TextMesh Pro UPM packages resources have been added to the user project
if (TMP_Settings.s_Instance == null)
{
// Open TMP Resources Importer
TMP_PackageResourceImporterWindow.ShowPackageImporterWindow();
}
#endif
}
return TMP_Settings.s_Instance;
}
}
/// <summary>
/// Static Function to load the TMP Settings file.
/// </summary>
/// <returns></returns>
public static TMP_Settings LoadDefaultSettings()
{
if (s_Instance == null)
{
// Load settings from TMP_Settings file
TMP_Settings settings = Resources.Load<TMP_Settings>("TMP Settings");
if (settings != null)
s_Instance = settings;
}
return s_Instance;
}
/// <summary>
/// Returns the Sprite Asset defined in the TMP Settings file.
/// </summary>
/// <returns></returns>
public static TMP_Settings GetSettings()
{
if (TMP_Settings.instance == null) return null;
return TMP_Settings.instance;
}
/// <summary>
/// Returns the Font Asset defined in the TMP Settings file.
/// </summary>
/// <returns></returns>
public static TMP_FontAsset GetFontAsset()
{
if (TMP_Settings.instance == null) return null;
return TMP_Settings.instance.m_defaultFontAsset;
}
/// <summary>
/// Returns the Sprite Asset defined in the TMP Settings file.
/// </summary>
/// <returns></returns>
public static TMP_SpriteAsset GetSpriteAsset()
{
if (TMP_Settings.instance == null) return null;
return TMP_Settings.instance.m_defaultSpriteAsset;
}
/// <summary>
/// Returns the Style Sheet defined in the TMP Settings file.
/// </summary>
/// <returns></returns>
public static TMP_StyleSheet GetStyleSheet()
{
if (TMP_Settings.instance == null) return null;
return TMP_Settings.instance.m_defaultStyleSheet;
}
public static void LoadLinebreakingRules()
{
//Debug.Log("Loading Line Breaking Rules for Asian Languages.");
if (TMP_Settings.instance == null) return;
if (s_Instance.m_linebreakingRules == null)
s_Instance.m_linebreakingRules = new LineBreakingTable();
s_Instance.m_linebreakingRules.leadingCharacters = GetCharacters(s_Instance.m_leadingCharacters);
s_Instance.m_linebreakingRules.followingCharacters = GetCharacters(s_Instance.m_followingCharacters);
}
/// <summary>
/// Get the characters from the line breaking files
/// </summary>
/// <param name="file"></param>
/// <returns></returns>
private static Dictionary<int, char> GetCharacters(TextAsset file)
{
Dictionary<int, char> dict = new Dictionary<int, char>();
string text = file.text;
for (int i = 0; i < text.Length; i++)
{
char c = text[i];
// Check to make sure we don't include duplicates
if (dict.ContainsKey((int)c) == false)
{
dict.Add((int)c, c);
//Debug.Log("Adding [" + (int)c + "] to dictionary.");
}
//else
// Debug.Log("Character [" + text[i] + "] is a duplicate.");
}
return dict;
}
public class LineBreakingTable
{
public Dictionary<int, char> leadingCharacters;
public Dictionary<int, char> followingCharacters;
}
}
}