/// <summary>
/// Returns the text element (character) for the given unicode value taking into consideration the requested font style and weight.
/// Function searches the provided list of font assets, the list of font assets assigned as alternative typefaces to them as well as their fallbacks.
/// The font asset out parameter contains a reference to the font asset containing the character.
/// The typeface type indicates whether the returned font asset is the source font asset, an alternative typeface or fallback font asset.
/// </summary>
/// <param name="unicode">The unicode value of the requested character</param>
/// <param name="sourceFontAsset">The font asset originating the search query</param>
/// <param name="fontAssets">The list of font assets to search</param>
/// <param name="includeFallbacks">Determines if the fallback of each font assets on the list will be searched</param>
/// <param name="fontStyle">The font style</param>
/// <param name="fontWeight">The font weight</param>
/// <param name="isAlternativeTypeface">Determines if the OUT font asset is an alternative typeface or fallback font asset</param>
/// <returns></returns>
public static TMP_Character GetCharacterFromFontAssets(uint unicode, TMP_FontAsset sourceFontAsset, List <TMP_FontAsset> fontAssets, bool includeFallbacks, FontStyles fontStyle, FontWeight fontWeight, out bool isAlternativeTypeface)
{
isAlternativeTypeface = false;
// Make sure font asset list is valid
if (fontAssets == null || fontAssets.Count == 0)
{
return(null);
}
if (includeFallbacks)
{
if (k_SearchedAssets == null)
{
k_SearchedAssets = new HashSet <int>();
}
else
{
k_SearchedAssets.Clear();
}
}
int fontAssetCount = fontAssets.Count;
for (int i = 0; i < fontAssetCount; i++)
{
TMP_FontAsset fontAsset = fontAssets[i];
if (fontAsset == null)
{
continue;
}
// Add reference to this search query
sourceFontAsset.FallbackSearchQueryLookup.Add(fontAsset.instanceID);
TMP_Character character = GetCharacterFromFontAsset_Internal(unicode, fontAsset, includeFallbacks, fontStyle, fontWeight, out isAlternativeTypeface);
if (character != null)
{
return(character);
}
}
return(null);
}
/// <summary>
/// Returns the text element (character) for the given unicode value taking into consideration the requested font style and weight.
/// Function searches the provided list of font assets, the list of font assets assigned as alternative typefaces to them as well as their fallbacks.
/// The font asset out parameter contains a reference to the font asset containing the character.
/// The typeface type indicates whether the returned font asset is the source font asset, an alternative typeface or fallback font asset.
/// </summary>
/// <param name="unicode">The unicode value of the requested character</param>
/// <param name="fontAssets">The list of font assets to search</param>
/// <param name="includeFallbacks">Determines if the fallback of each font assets on the list will be searched</param>
/// <param name="fontStyle">The font style</param>
/// <param name="fontWeight">The font weight</param>
/// <param name="type">Determines if the OUT font asset is an alternative typeface or fallback font asset</param>
/// <param name="fontAsset">The font asset that contains the requested character</param>
/// <returns></returns>
public static TMP_Character GetCharacterFromFontAssets(uint unicode, List <TMP_FontAsset> fontAssets, bool includeFallbacks, FontStyles fontStyle, FontWeight fontWeight, out bool isAlternativeTypeface, out TMP_FontAsset fontAsset)
{
isAlternativeTypeface = false;
// Make sure font asset list is valid
if (fontAssets == null || fontAssets.Count == 0)
{
fontAsset = null;
return(null);
}
if (includeFallbacks)
{
if (k_SearchedFontAssets == null)
{
k_SearchedFontAssets = new List <int>();
}
else
{
k_SearchedFontAssets.Clear();
}
}
int fontAssetCount = fontAssets.Count;
for (int i = 0; i < fontAssetCount; i++)
{
if (fontAssets[i] == null)
{
continue;
}
TMP_Character characterData = GetCharacterFromFontAsset_Internal(unicode, fontAssets[i], includeFallbacks, fontStyle, fontWeight, out isAlternativeTypeface, out fontAsset);
if (characterData != null)
{
return(characterData);
}
}
fontAsset = null;
return(null);
}
/// <summary>
/// Internal function returning the text element character for the given unicode value taking into consideration the font style and weight.
/// Function searches the source font asset, list of font assets assigned as alternative typefaces and list of fallback font assets.
/// </summary>
private static TMP_Character GetCharacterFromFontAsset_Internal(uint unicode, TMP_FontAsset sourceFontAsset, bool includeFallbacks, FontStyles fontStyle, FontWeight fontWeight, out bool isAlternativeTypeface, out TMP_FontAsset fontAsset)
{
fontAsset = null;
isAlternativeTypeface = false;
TMP_Character characterData = null;
#region FONT WEIGHT AND FONT STYLE HANDLING
// Determine if a font weight or style is used. If so check if an alternative typeface is assigned for the given weight and / or style.
bool isItalic = (fontStyle & FontStyles.Italic) == FontStyles.Italic;
if (isItalic || fontWeight != FontWeight.Regular)
{
// Get reference to the font weight pairs of the given font asset.
TMP_FontWeightPair[] fontWeights = sourceFontAsset.fontWeightTable;
int fontWeightIndex = 4;
switch (fontWeight)
{
case FontWeight.Thin:
fontWeightIndex = 1;
break;
case FontWeight.ExtraLight:
fontWeightIndex = 2;
break;
case FontWeight.Light:
fontWeightIndex = 3;
break;
case FontWeight.Regular:
fontWeightIndex = 4;
break;
case FontWeight.Medium:
fontWeightIndex = 5;
break;
case FontWeight.SemiBold:
fontWeightIndex = 6;
break;
case FontWeight.Bold:
fontWeightIndex = 7;
break;
case FontWeight.Heavy:
fontWeightIndex = 8;
break;
case FontWeight.Black:
fontWeightIndex = 9;
break;
}
fontAsset = isItalic ? fontWeights[fontWeightIndex].italicTypeface : fontWeights[fontWeightIndex].regularTypeface;
if (fontAsset != null)
{
if (fontAsset.characterLookupTable.TryGetValue(unicode, out characterData))
{
isAlternativeTypeface = true;
return(characterData);
}
else if (fontAsset.atlasPopulationMode == AtlasPopulationMode.Dynamic)
{
if (fontAsset.TryAddCharacterInternal(unicode, out characterData))
{
isAlternativeTypeface = true;
return(characterData);
}
// Check if the source font file contains the requested character.
//if (TryGetCharacterFromFontFile(unicode, fontAsset, out characterData))
//{
// isAlternativeTypeface = true;
// return characterData;
//}
// If we find the requested character, we add it to the font asset character table
// and return its character data.
// We also add this character to the list of characters we will need to add to the font atlas.
// We assume the font atlas has room otherwise this font asset should not be marked as dynamic.
// Alternatively, we could also add multiple pages of font atlas textures (feature consideration).
}
// At this point, we were not able to find the requested character in the alternative typeface
// so we check the source font asset and its potential fallbacks.
}
}
#endregion
// Search the source font asset for the requested character.
if (sourceFontAsset.characterLookupTable.TryGetValue(unicode, out characterData))
{
// We were able to locate the requested character in the given font asset.
fontAsset = sourceFontAsset;
return(characterData);
}
else if (sourceFontAsset.atlasPopulationMode == AtlasPopulationMode.Dynamic)
{
if (sourceFontAsset.TryAddCharacterInternal(unicode, out characterData))
{
fontAsset = sourceFontAsset;
return(characterData);
}
//// Check if the source font file contains the requested character.
//if (TryGetCharacterFromFontFile(unicode, sourceFontAsset, out characterData))
//{
// fontAsset = sourceFontAsset;
// //fontAsset.AddCharacterToRasterList(unicode);
// return characterData;
//}
// If we find the requested character, we add it to the font asset character table
// and return its character data.
// We also add this character to the list of characters we will need to add to the font atlas.
// We assume the font atlas has room otherwise this font asset should not be marked as dynamic.
// Alternatively, we could also add multiple pages of font atlas textures (feature consideration)
}
// Search fallback font assets if we still don't have a valid character and include fallback is set to true.
if (characterData == null && includeFallbacks && sourceFontAsset.fallbackFontAssetTable != null)
{
// Get reference to the list of fallback font assets.
List <TMP_FontAsset> fallbackFontAssets = sourceFontAsset.fallbackFontAssetTable;
int fallbackCount = fallbackFontAssets.Count;
if (fallbackFontAssets != null && fallbackCount > 0)
{
for (int i = 0; i < fallbackCount && characterData == null; i++)
{
TMP_FontAsset temp = fallbackFontAssets[i];
if (temp == null)
{
continue;
}
int id = temp.GetInstanceID();
// Skip over the fallback font asset in the event it is null or if already searched.
if (k_SearchedFontAssets.Contains(id))
{
continue;
}
// Add to list of font assets already searched.
k_SearchedFontAssets.Add(id);
characterData = GetCharacterFromFontAsset_Internal(unicode, temp, includeFallbacks, fontStyle, fontWeight, out isAlternativeTypeface, out fontAsset);
if (characterData != null)
{
return(characterData);
}
}
}
}
return(null);
}
private static bool TryGetCharacterFromFontFile(uint unicode, TMP_FontAsset fontAsset, out TMP_Character character)
{
character = null;
// Initialize Font Engine library if not already initialized
if (k_IsFontEngineInitialized == false)
{
FontEngineError error = FontEngine.InitializeFontEngine();
if (error == 0)
{
k_IsFontEngineInitialized = true;
}
}
// Load the font face for the given font asset.
// TODO: Add manager to keep track of which font faces are currently loaded.
FontEngine.LoadFontFace(fontAsset.sourceFontFile, fontAsset.faceInfo.pointSize);
Glyph glyph = null;
uint glyphIndex = FontEngine.GetGlyphIndex(unicode);
// Check if glyph is already contained in the font asset as the same glyph might be referenced by multiple character.
if (fontAsset.glyphLookupTable.TryGetValue(glyphIndex, out glyph))
{
character = fontAsset.AddCharacter_Internal(unicode, glyph);
return(true);
}
GlyphLoadFlags glyphLoadFlags = ((GlyphRasterModes)fontAsset.atlasRenderMode & GlyphRasterModes.RASTER_MODE_HINTED) == GlyphRasterModes.RASTER_MODE_HINTED ? GlyphLoadFlags.LOAD_RENDER : GlyphLoadFlags.LOAD_RENDER | GlyphLoadFlags.LOAD_NO_HINTING;
if (FontEngine.TryGetGlyphWithUnicodeValue(unicode, glyphLoadFlags, out glyph))
{
// Add new character to font asset (if needed)
character = fontAsset.AddCharacter_Internal(unicode, glyph);
return(true);
}
return(false);
}
private static TMP_FontAsset SearchForCharacterInternal(List <TMP_FontAsset> fonts, uint unicode, out TMP_Character character)
{
character = null;
if (fonts != null && fonts.Count > 0)
{
for (int i = 0; i < fonts.Count; i++)
{
TMP_FontAsset fontAsset = SearchForCharacterInternal(fonts[i], unicode, out character);
if (fontAsset != null)
{
return(fontAsset);
}
}
}
return(null);
}
private static TMP_FontAsset SearchForCharacterInternal(TMP_FontAsset font, uint unicode, out TMP_Character character)
{
character = null;
if (font == null)
{
return(null);
}
if (font.characterLookupTable.TryGetValue(unicode, out character))
{
return(font);
}
else if (font.fallbackFontAssetTable != null && font.fallbackFontAssetTable.Count > 0)
{
for (int i = 0; i < font.fallbackFontAssetTable.Count && character == null; i++)
{
TMP_FontAsset temp = font.fallbackFontAssetTable[i];
if (temp == null)
{
continue;
}
int id = temp.GetInstanceID();
// Skip over the fallback font asset in the event it is null or if already searched.
if (k_searchedFontAssets.Contains(id))
{
continue;
}
// Add to list of font assets already searched.
k_searchedFontAssets.Add(id);
temp = SearchForCharacterInternal(temp, unicode, out character);
if (temp != null)
{
return(temp);
}
}
}
return(null);
}
/// <summary>
/// Search through the given list of fonts and their possible fallbacks for the specified character.
/// </summary>
/// <param name="fonts"></param>
/// <param name="unicode"></param>
/// <param name="character"></param>
/// <returns></returns>
public static TMP_FontAsset SearchForCharacter(List <TMP_FontAsset> fonts, uint unicode, out TMP_Character character)
{
return(SearchForCharacterInternal(fonts, unicode, out character));
}
/// <summary>
/// Search through the given font and its fallbacks for the specified character.
/// </summary>
/// <param name="font">The font asset to search for the given character.</param>
/// <param name="unicode">The character to find.</param>
/// <param name="character">out parameter containing the glyph for the specified character (if found).</param>
/// <returns></returns>
public static TMP_FontAsset SearchForCharacter(TMP_FontAsset font, uint unicode, out TMP_Character character)
{
if (k_searchedFontAssets == null)
{
k_searchedFontAssets = new List <int>();
}
k_searchedFontAssets.Clear();
return(SearchForCharacterInternal(font, unicode, out character));
}
