FontData.cs 5.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199
  1. using System;
  2. using UnityEngine.Serialization;
  3. namespace UnityEngine.UI
  4. {
  5. [Serializable]
  6. /// <summary>
  7. /// Struct for storing Text generation settings.
  8. /// </summary>
  9. public class FontData : ISerializationCallbackReceiver
  10. {
  11. [SerializeField]
  12. [FormerlySerializedAs("font")]
  13. private Font m_Font;
  14. [SerializeField]
  15. [FormerlySerializedAs("fontSize")]
  16. private int m_FontSize;
  17. [SerializeField]
  18. [FormerlySerializedAs("fontStyle")]
  19. private FontStyle m_FontStyle;
  20. [SerializeField]
  21. private bool m_BestFit;
  22. [SerializeField]
  23. private int m_MinSize;
  24. [SerializeField]
  25. private int m_MaxSize;
  26. [SerializeField]
  27. [FormerlySerializedAs("alignment")]
  28. private TextAnchor m_Alignment;
  29. [SerializeField]
  30. private bool m_AlignByGeometry;
  31. [SerializeField]
  32. [FormerlySerializedAs("richText")]
  33. private bool m_RichText;
  34. [SerializeField]
  35. private HorizontalWrapMode m_HorizontalOverflow;
  36. [SerializeField]
  37. private VerticalWrapMode m_VerticalOverflow;
  38. [SerializeField]
  39. private float m_LineSpacing;
  40. /// <summary>
  41. /// Get a font data with sensible defaults.
  42. /// </summary>
  43. public static FontData defaultFontData
  44. {
  45. get
  46. {
  47. var fontData = new FontData
  48. {
  49. m_FontSize = 14,
  50. m_LineSpacing = 1f,
  51. m_FontStyle = FontStyle.Normal,
  52. m_BestFit = false,
  53. m_MinSize = 10,
  54. m_MaxSize = 40,
  55. m_Alignment = TextAnchor.UpperLeft,
  56. m_HorizontalOverflow = HorizontalWrapMode.Wrap,
  57. m_VerticalOverflow = VerticalWrapMode.Truncate,
  58. m_RichText = true,
  59. m_AlignByGeometry = false
  60. };
  61. return fontData;
  62. }
  63. }
  64. /// <summary>
  65. /// The Font to use for this generated Text object.
  66. /// </summary>
  67. public Font font
  68. {
  69. get { return m_Font; }
  70. set { m_Font = value; }
  71. }
  72. /// <summary>
  73. /// The Font size to use for this generated Text object.
  74. /// </summary>
  75. public int fontSize
  76. {
  77. get { return m_FontSize; }
  78. set { m_FontSize = value; }
  79. }
  80. /// <summary>
  81. /// The font style to use for this generated Text object.
  82. /// </summary>
  83. public FontStyle fontStyle
  84. {
  85. get { return m_FontStyle; }
  86. set { m_FontStyle = value; }
  87. }
  88. /// <summary>
  89. /// Is best fit used for this generated Text object.
  90. /// </summary>
  91. public bool bestFit
  92. {
  93. get { return m_BestFit; }
  94. set { m_BestFit = value; }
  95. }
  96. /// <summary>
  97. /// The min size for this generated Text object.
  98. /// </summary>
  99. public int minSize
  100. {
  101. get { return m_MinSize; }
  102. set { m_MinSize = value; }
  103. }
  104. /// <summary>
  105. /// The max size for this generated Text object.
  106. /// </summary>
  107. public int maxSize
  108. {
  109. get { return m_MaxSize; }
  110. set { m_MaxSize = value; }
  111. }
  112. /// <summary>
  113. /// How is the text aligned for this generated Text object.
  114. /// </summary>
  115. public TextAnchor alignment
  116. {
  117. get { return m_Alignment; }
  118. set { m_Alignment = value; }
  119. }
  120. /// <summary>
  121. /// Use the extents of glyph geometry to perform horizontal alignment rather than glyph metrics.
  122. /// </summary>
  123. /// <remarks>
  124. /// This can result in better fitting left and right alignment, but may result in incorrect positioning when attempting to overlay multiple fonts (such as a specialized outline font) on top of each other.
  125. /// </remarks>
  126. public bool alignByGeometry
  127. {
  128. get { return m_AlignByGeometry; }
  129. set { m_AlignByGeometry = value; }
  130. }
  131. /// <summary>
  132. /// Should rich text be used for this generated Text object.
  133. /// </summary>
  134. public bool richText
  135. {
  136. get { return m_RichText; }
  137. set { m_RichText = value; }
  138. }
  139. /// <summary>
  140. /// The horizontal overflow policy for this generated Text object.
  141. /// </summary>
  142. public HorizontalWrapMode horizontalOverflow
  143. {
  144. get { return m_HorizontalOverflow; }
  145. set { m_HorizontalOverflow = value; }
  146. }
  147. /// <summary>
  148. /// The vertical overflow policy for this generated Text object.
  149. /// </summary>
  150. public VerticalWrapMode verticalOverflow
  151. {
  152. get { return m_VerticalOverflow; }
  153. set { m_VerticalOverflow = value; }
  154. }
  155. /// <summary>
  156. /// The line spaceing for this generated Text object.
  157. /// </summary>
  158. public float lineSpacing
  159. {
  160. get { return m_LineSpacing; }
  161. set { m_LineSpacing = value; }
  162. }
  163. void ISerializationCallbackReceiver.OnBeforeSerialize()
  164. {}
  165. void ISerializationCallbackReceiver.OnAfterDeserialize()
  166. {
  167. m_FontSize = Mathf.Clamp(m_FontSize, 0, 300);
  168. m_MinSize = Mathf.Clamp(m_MinSize, 0, m_FontSize);
  169. m_MaxSize = Mathf.Clamp(m_MaxSize, m_FontSize, 300);
  170. }
  171. }
  172. }