No Description
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

TMP_SubMeshUI.cs 28KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831
  1. using UnityEngine;
  2. using UnityEngine.Rendering;
  3. using UnityEngine.UI;
  4. using System.Collections;
  5. using System.Collections.Generic;
  6. using Object = UnityEngine.Object;
  7. #pragma warning disable 0414 // Disabled a few warnings related to serialized variables not used in this script but used in the editor.
  8. namespace TMPro
  9. {
  10. [ExecuteAlways]
  11. [RequireComponent(typeof(CanvasRenderer))]
  12. public class TMP_SubMeshUI : MaskableGraphic
  13. {
  14. /// <summary>
  15. /// The TMP Font Asset assigned to this sub text object.
  16. /// </summary>
  17. public TMP_FontAsset fontAsset
  18. {
  19. get { return m_fontAsset; }
  20. set { m_fontAsset = value; }
  21. }
  22. [SerializeField]
  23. private TMP_FontAsset m_fontAsset;
  24. /// <summary>
  25. /// The TMP Sprite Asset assigned to this sub text object.
  26. /// </summary>
  27. public TMP_SpriteAsset spriteAsset
  28. {
  29. get { return m_spriteAsset; }
  30. set { m_spriteAsset = value; }
  31. }
  32. [SerializeField]
  33. private TMP_SpriteAsset m_spriteAsset;
  34. /// <summary>
  35. ///
  36. /// </summary>
  37. public override Texture mainTexture
  38. {
  39. get
  40. {
  41. if (this.sharedMaterial != null)
  42. return this.sharedMaterial.GetTexture(ShaderUtilities.ID_MainTex);
  43. return null;
  44. }
  45. }
  46. /// <summary>
  47. /// The material to be assigned to this object. Returns an instance of the material.
  48. /// </summary>
  49. public override Material material
  50. {
  51. // Return a new Instance of the Material if none exists. Otherwise return the current Material Instance.
  52. get { return GetMaterial(m_sharedMaterial); }
  53. // Assign new font material
  54. set
  55. {
  56. if (m_sharedMaterial != null && m_sharedMaterial.GetInstanceID() == value.GetInstanceID())
  57. return;
  58. m_sharedMaterial = m_material = value;
  59. m_padding = GetPaddingForMaterial();
  60. SetVerticesDirty();
  61. SetMaterialDirty();
  62. }
  63. }
  64. [SerializeField]
  65. private Material m_material;
  66. /// <summary>
  67. /// The material to be assigned to this text object.
  68. /// </summary>
  69. public Material sharedMaterial
  70. {
  71. get { return m_sharedMaterial; }
  72. set { SetSharedMaterial(value); }
  73. }
  74. [SerializeField]
  75. private Material m_sharedMaterial;
  76. /// <summary>
  77. ///
  78. /// </summary>
  79. public Material fallbackMaterial
  80. {
  81. get { return m_fallbackMaterial; }
  82. set
  83. {
  84. if (m_fallbackMaterial == value) return;
  85. if (m_fallbackMaterial != null && m_fallbackMaterial != value)
  86. TMP_MaterialManager.ReleaseFallbackMaterial(m_fallbackMaterial);
  87. m_fallbackMaterial = value;
  88. TMP_MaterialManager.AddFallbackMaterialReference(m_fallbackMaterial);
  89. SetSharedMaterial(m_fallbackMaterial);
  90. }
  91. }
  92. private Material m_fallbackMaterial;
  93. /// <summary>
  94. /// The source material used by the fallback font
  95. /// </summary>
  96. public Material fallbackSourceMaterial
  97. {
  98. get { return m_fallbackSourceMaterial; }
  99. set { m_fallbackSourceMaterial = value; }
  100. }
  101. private Material m_fallbackSourceMaterial;
  102. /// <summary>
  103. /// Get the material that will be used for rendering.
  104. /// </summary>
  105. public override Material materialForRendering
  106. {
  107. get
  108. {
  109. return TMP_MaterialManager.GetMaterialForRendering(this, m_sharedMaterial);
  110. }
  111. }
  112. /// <summary>
  113. /// Is the text object using the default font asset material.
  114. /// </summary>
  115. public bool isDefaultMaterial
  116. {
  117. get { return m_isDefaultMaterial; }
  118. set { m_isDefaultMaterial = value; }
  119. }
  120. [SerializeField]
  121. private bool m_isDefaultMaterial;
  122. /// <summary>
  123. /// Padding value resulting for the property settings on the material.
  124. /// </summary>
  125. public float padding
  126. {
  127. get { return m_padding; }
  128. set { m_padding = value; }
  129. }
  130. [SerializeField]
  131. private float m_padding;
  132. /// <summary>
  133. /// The Mesh of this text sub object.
  134. /// </summary>
  135. public Mesh mesh
  136. {
  137. get
  138. {
  139. if (m_mesh == null)
  140. {
  141. m_mesh = new Mesh();
  142. m_mesh.hideFlags = HideFlags.HideAndDontSave;
  143. }
  144. return m_mesh;
  145. }
  146. set { m_mesh = value; }
  147. }
  148. private Mesh m_mesh;
  149. /// <summary>
  150. /// Reference to the parent Text Component.
  151. /// </summary>
  152. public TMP_Text textComponent
  153. {
  154. get
  155. {
  156. if (m_TextComponent == null)
  157. m_TextComponent = GetComponentInParent<TextMeshProUGUI>();
  158. return m_TextComponent;
  159. }
  160. }
  161. [SerializeField]
  162. private TextMeshProUGUI m_TextComponent;
  163. [System.NonSerialized]
  164. private bool m_isRegisteredForEvents;
  165. private bool m_materialDirty;
  166. [SerializeField]
  167. private int m_materialReferenceIndex;
  168. /// <summary>
  169. /// Function to add a new sub text object.
  170. /// </summary>
  171. /// <param name="textComponent"></param>
  172. /// <param name="materialReference"></param>
  173. /// <returns></returns>
  174. public static TMP_SubMeshUI AddSubTextObject(TextMeshProUGUI textComponent, MaterialReference materialReference)
  175. {
  176. GameObject go = new GameObject();
  177. go.hideFlags = TMP_Settings.hideSubTextObjects ? HideFlags.HideAndDontSave : HideFlags.DontSave;
  178. go.transform.SetParent(textComponent.transform, false);
  179. go.transform.SetAsFirstSibling();
  180. go.layer = textComponent.gameObject.layer;
  181. #if UNITY_EDITOR
  182. go.name = materialReference.material == null ? "TMP SubMesh" : "TMP SubMesh [" + materialReference.material.name + "]";
  183. #endif
  184. RectTransform rectTransform = go.AddComponent<RectTransform>();
  185. rectTransform.anchorMin = Vector2.zero;
  186. rectTransform.anchorMax = Vector2.one;
  187. rectTransform.sizeDelta = Vector2.zero;
  188. rectTransform.pivot = textComponent.rectTransform.pivot;
  189. LayoutElement layoutElement = go.AddComponent<LayoutElement>();
  190. layoutElement.ignoreLayout = true;
  191. TMP_SubMeshUI subMesh = go.AddComponent<TMP_SubMeshUI>();
  192. subMesh.m_TextComponent = textComponent;
  193. subMesh.m_materialReferenceIndex = materialReference.index;
  194. subMesh.m_fontAsset = materialReference.fontAsset;
  195. subMesh.m_spriteAsset = materialReference.spriteAsset;
  196. subMesh.m_isDefaultMaterial = materialReference.isDefaultMaterial;
  197. subMesh.maskable = textComponent.maskable;
  198. subMesh.SetSharedMaterial(materialReference.material);
  199. return subMesh;
  200. }
  201. /// <summary>
  202. ///
  203. /// </summary>
  204. protected override void OnEnable()
  205. {
  206. //Debug.Log("*** SubObject OnEnable() ***");
  207. // Register Callbacks for various events.
  208. if (!m_isRegisteredForEvents)
  209. {
  210. #if UNITY_EDITOR
  211. TMPro_EventManager.MATERIAL_PROPERTY_EVENT.Add(ON_MATERIAL_PROPERTY_CHANGED);
  212. TMPro_EventManager.FONT_PROPERTY_EVENT.Add(ON_FONT_PROPERTY_CHANGED);
  213. //TMPro_EventManager.TEXTMESHPRO_PROPERTY_EVENT.Add(ON_TEXTMESHPRO_PROPERTY_CHANGED);
  214. TMPro_EventManager.DRAG_AND_DROP_MATERIAL_EVENT.Add(ON_DRAG_AND_DROP_MATERIAL);
  215. //TMPro_EventManager.TEXT_STYLE_PROPERTY_EVENT.Add(ON_TEXT_STYLE_CHANGED);
  216. TMPro_EventManager.SPRITE_ASSET_PROPERTY_EVENT.Add(ON_SPRITE_ASSET_PROPERTY_CHANGED);
  217. //TMPro_EventManager.TMP_SETTINGS_PROPERTY_EVENT.Add(ON_TMP_SETTINGS_CHANGED);
  218. #endif
  219. m_isRegisteredForEvents = true;
  220. }
  221. // Update HideFlags on previously created sub text objects.
  222. if (hideFlags != HideFlags.DontSave)
  223. hideFlags = HideFlags.DontSave;
  224. m_ShouldRecalculateStencil = true;
  225. RecalculateClipping();
  226. RecalculateMasking();
  227. //SetAllDirty();
  228. }
  229. protected override void OnDisable()
  230. {
  231. //Debug.Log("*** SubObject OnDisable() ***");
  232. base.OnDisable();
  233. // if (m_MaskMaterial != null)
  234. // {
  235. // TMP_MaterialManager.ReleaseStencilMaterial(m_MaskMaterial);
  236. // m_MaskMaterial = null;
  237. // }
  238. if (m_fallbackMaterial != null)
  239. {
  240. TMP_MaterialManager.ReleaseFallbackMaterial(m_fallbackMaterial);
  241. m_fallbackMaterial = null;
  242. }
  243. }
  244. protected override void OnDestroy()
  245. {
  246. //Debug.Log("*** OnDestroy() ***");
  247. // Destroy Mesh
  248. if (m_mesh != null) DestroyImmediate(m_mesh);
  249. if (m_MaskMaterial != null)
  250. TMP_MaterialManager.ReleaseStencilMaterial(m_MaskMaterial);
  251. if (m_fallbackMaterial != null)
  252. {
  253. TMP_MaterialManager.ReleaseFallbackMaterial(m_fallbackMaterial);
  254. m_fallbackMaterial = null;
  255. }
  256. #if UNITY_EDITOR
  257. // Unregister the event this object was listening to
  258. TMPro_EventManager.MATERIAL_PROPERTY_EVENT.Remove(ON_MATERIAL_PROPERTY_CHANGED);
  259. TMPro_EventManager.FONT_PROPERTY_EVENT.Remove(ON_FONT_PROPERTY_CHANGED);
  260. //TMPro_EventManager.TEXTMESHPRO_PROPERTY_EVENT.Remove(ON_TEXTMESHPRO_PROPERTY_CHANGED);
  261. TMPro_EventManager.DRAG_AND_DROP_MATERIAL_EVENT.Remove(ON_DRAG_AND_DROP_MATERIAL);
  262. //TMPro_EventManager.TEXT_STYLE_PROPERTY_EVENT.Remove(ON_TEXT_STYLE_CHANGED);
  263. TMPro_EventManager.SPRITE_ASSET_PROPERTY_EVENT.Remove(ON_SPRITE_ASSET_PROPERTY_CHANGED);
  264. //TMPro_EventManager.TMP_SETTINGS_PROPERTY_EVENT.Remove(ON_TMP_SETTINGS_CHANGED);
  265. #endif
  266. m_isRegisteredForEvents = false;
  267. RecalculateClipping();
  268. // Notify parent text object
  269. if (m_TextComponent != null)
  270. {
  271. m_TextComponent.havePropertiesChanged = true;
  272. m_TextComponent.SetAllDirty();
  273. }
  274. }
  275. #if UNITY_EDITOR
  276. // Event received when custom material editor properties are changed.
  277. void ON_MATERIAL_PROPERTY_CHANGED(bool isChanged, Material mat)
  278. {
  279. //Debug.Log("*** ON_MATERIAL_PROPERTY_CHANGED ***");
  280. if (m_sharedMaterial == null)
  281. return;
  282. int targetMaterialID = mat.GetInstanceID();
  283. int sharedMaterialID = m_sharedMaterial.GetInstanceID();
  284. int maskingMaterialID = m_MaskMaterial == null ? 0 : m_MaskMaterial.GetInstanceID();
  285. int fallbackSourceMaterialID = m_fallbackSourceMaterial == null ? 0 : m_fallbackSourceMaterial.GetInstanceID();
  286. // Sync culling with parent text object
  287. bool hasCullModeProperty = m_sharedMaterial.HasProperty(ShaderUtilities.ShaderTag_CullMode);
  288. float cullMode = 0;
  289. if (hasCullModeProperty)
  290. {
  291. cullMode = textComponent.fontSharedMaterial.GetFloat(ShaderUtilities.ShaderTag_CullMode);
  292. m_sharedMaterial.SetFloat(ShaderUtilities.ShaderTag_CullMode, cullMode);
  293. }
  294. // Filter events and return if the affected material is not this object's material.
  295. if (m_fallbackMaterial != null && fallbackSourceMaterialID == targetMaterialID && TMP_Settings.matchMaterialPreset)
  296. {
  297. TMP_MaterialManager.CopyMaterialPresetProperties(mat, m_fallbackMaterial);
  298. // Re-sync culling with parent text object
  299. m_fallbackMaterial.SetFloat(ShaderUtilities.ShaderTag_CullMode, cullMode);
  300. }
  301. // Make sure material properties are synchronized between the assigned material and masking material.
  302. if (m_MaskMaterial != null)
  303. {
  304. UnityEditor.Undo.RecordObject(m_MaskMaterial, "Material Property Changes");
  305. UnityEditor.Undo.RecordObject(m_sharedMaterial, "Material Property Changes");
  306. if (targetMaterialID == sharedMaterialID)
  307. {
  308. //Debug.Log("Copy base material properties to masking material if not null.");
  309. float stencilID = m_MaskMaterial.GetFloat(ShaderUtilities.ID_StencilID);
  310. float stencilComp = m_MaskMaterial.GetFloat(ShaderUtilities.ID_StencilComp);
  311. m_MaskMaterial.CopyPropertiesFromMaterial(mat);
  312. m_MaskMaterial.shaderKeywords = mat.shaderKeywords;
  313. m_MaskMaterial.SetFloat(ShaderUtilities.ID_StencilID, stencilID);
  314. m_MaskMaterial.SetFloat(ShaderUtilities.ID_StencilComp, stencilComp);
  315. }
  316. else if (targetMaterialID == maskingMaterialID)
  317. {
  318. // Update the padding
  319. GetPaddingForMaterial(mat);
  320. m_sharedMaterial.CopyPropertiesFromMaterial(mat);
  321. m_sharedMaterial.shaderKeywords = mat.shaderKeywords;
  322. m_sharedMaterial.SetFloat(ShaderUtilities.ID_StencilID, 0);
  323. m_sharedMaterial.SetFloat(ShaderUtilities.ID_StencilComp, 8);
  324. }
  325. else if (fallbackSourceMaterialID == targetMaterialID)
  326. {
  327. float stencilID = m_MaskMaterial.GetFloat(ShaderUtilities.ID_StencilID);
  328. float stencilComp = m_MaskMaterial.GetFloat(ShaderUtilities.ID_StencilComp);
  329. m_MaskMaterial.CopyPropertiesFromMaterial(m_fallbackMaterial);
  330. m_MaskMaterial.shaderKeywords = m_fallbackMaterial.shaderKeywords;
  331. m_MaskMaterial.SetFloat(ShaderUtilities.ID_StencilID, stencilID);
  332. m_MaskMaterial.SetFloat(ShaderUtilities.ID_StencilComp, stencilComp);
  333. }
  334. // Re-sync culling with parent text object
  335. if (hasCullModeProperty)
  336. m_MaskMaterial.SetFloat(ShaderUtilities.ShaderTag_CullMode, cullMode);
  337. }
  338. m_padding = GetPaddingForMaterial();
  339. SetVerticesDirty();
  340. m_ShouldRecalculateStencil = true;
  341. RecalculateClipping();
  342. RecalculateMasking();
  343. }
  344. // Event to Track Material Changed resulting from Drag-n-drop.
  345. void ON_DRAG_AND_DROP_MATERIAL(GameObject obj, Material currentMaterial, Material newMaterial)
  346. {
  347. // Check if event applies to this current object
  348. if (obj == gameObject || UnityEditor.PrefabUtility.GetCorrespondingObjectFromSource(gameObject) == obj)
  349. {
  350. if (!m_isDefaultMaterial) return;
  351. // Make sure we have a valid reference to the renderer.
  352. //if (m_canvasRenderer == null) m_canvasRenderer = GetComponent<CanvasRenderer>();
  353. UnityEditor.Undo.RecordObject(this, "Material Assignment");
  354. UnityEditor.Undo.RecordObject(canvasRenderer, "Material Assignment");
  355. SetSharedMaterial(newMaterial);
  356. m_TextComponent.havePropertiesChanged = true;
  357. }
  358. }
  359. // Event received when font asset properties are changed in Font Inspector
  360. void ON_SPRITE_ASSET_PROPERTY_CHANGED(bool isChanged, UnityEngine.Object obj)
  361. {
  362. //if (spriteSheet != null && (obj as TMP_SpriteAsset == m_spriteAsset || obj as Texture2D == m_spriteAsset.spriteSheet))
  363. //{
  364. if (m_TextComponent != null)
  365. {
  366. m_TextComponent.havePropertiesChanged = true;
  367. //m_TextComponent.SetVerticesDirty();
  368. }
  369. //}
  370. }
  371. // Event received when font asset properties are changed in Font Inspector
  372. void ON_FONT_PROPERTY_CHANGED(bool isChanged, Object fontAsset)
  373. {
  374. if (m_fontAsset != null && fontAsset != null && fontAsset.GetInstanceID() == m_fontAsset.GetInstanceID())
  375. {
  376. // Copy Normal and Bold Weight
  377. if (m_fallbackMaterial != null)
  378. {
  379. if (TMP_Settings.matchMaterialPreset)
  380. {
  381. TMP_MaterialManager.ReleaseFallbackMaterial(m_fallbackMaterial);
  382. TMP_MaterialManager.CleanupFallbackMaterials();
  383. }
  384. }
  385. }
  386. }
  387. /// <summary>
  388. /// Event received when the TMP Settings are changed.
  389. /// </summary>
  390. void ON_TMP_SETTINGS_CHANGED()
  391. {
  392. //Debug.Log("TMP Setting have changed.");
  393. //SetVerticesDirty();
  394. //SetMaterialDirty();
  395. }
  396. #endif
  397. /// <summary>
  398. ///
  399. /// </summary>
  400. protected override void OnTransformParentChanged()
  401. {
  402. if (!this.IsActive())
  403. return;
  404. m_ShouldRecalculateStencil = true;
  405. RecalculateClipping();
  406. RecalculateMasking();
  407. }
  408. /// <summary>
  409. /// Function returning the modified material for masking if necessary.
  410. /// </summary>
  411. /// <param name="baseMaterial"></param>
  412. /// <returns></returns>
  413. public override Material GetModifiedMaterial(Material baseMaterial)
  414. {
  415. Material mat = baseMaterial;
  416. if (m_ShouldRecalculateStencil)
  417. {
  418. var rootCanvas = MaskUtilities.FindRootSortOverrideCanvas(transform);
  419. m_StencilValue = maskable ? MaskUtilities.GetStencilDepth(transform, rootCanvas) : 0;
  420. m_ShouldRecalculateStencil = false;
  421. }
  422. if (m_StencilValue > 0)
  423. {
  424. var maskMat = StencilMaterial.Add(mat, (1 << m_StencilValue) - 1, StencilOp.Keep, CompareFunction.Equal, ColorWriteMask.All, (1 << m_StencilValue) - 1, 0);
  425. StencilMaterial.Remove(m_MaskMaterial);
  426. m_MaskMaterial = maskMat;
  427. mat = m_MaskMaterial;
  428. }
  429. return mat;
  430. }
  431. /// <summary>
  432. /// Function called when the padding value for the material needs to be re-calculated.
  433. /// </summary>
  434. /// <returns></returns>
  435. public float GetPaddingForMaterial()
  436. {
  437. float padding = ShaderUtilities.GetPadding(m_sharedMaterial, m_TextComponent.extraPadding, m_TextComponent.isUsingBold);
  438. return padding;
  439. }
  440. /// <summary>
  441. /// Function called when the padding value for the material needs to be re-calculated.
  442. /// </summary>
  443. /// <returns></returns>
  444. public float GetPaddingForMaterial(Material mat)
  445. {
  446. float padding = ShaderUtilities.GetPadding(mat, m_TextComponent.extraPadding, m_TextComponent.isUsingBold);
  447. return padding;
  448. }
  449. /// <summary>
  450. ///
  451. /// </summary>
  452. /// <param name="isExtraPadding"></param>
  453. /// <param name="isBold"></param>
  454. public void UpdateMeshPadding(bool isExtraPadding, bool isUsingBold)
  455. {
  456. m_padding = ShaderUtilities.GetPadding(m_sharedMaterial, isExtraPadding, isUsingBold);
  457. }
  458. /// <summary>
  459. ///
  460. /// </summary>
  461. public override void SetAllDirty()
  462. {
  463. //SetLayoutDirty();
  464. //SetVerticesDirty();
  465. //SetMaterialDirty();
  466. }
  467. /// <summary>
  468. ///
  469. /// </summary>
  470. public override void SetVerticesDirty()
  471. {
  472. // Do nothing as updates of the text are driven by the parent text component
  473. }
  474. /// <summary>
  475. ///
  476. /// </summary>
  477. public override void SetLayoutDirty()
  478. {
  479. }
  480. /// <summary>
  481. ///
  482. /// </summary>
  483. public override void SetMaterialDirty()
  484. {
  485. m_materialDirty = true;
  486. UpdateMaterial();
  487. if (m_OnDirtyMaterialCallback != null)
  488. m_OnDirtyMaterialCallback();
  489. }
  490. /// <summary>
  491. ///
  492. /// </summary>
  493. public void SetPivotDirty()
  494. {
  495. if (!this.IsActive())
  496. return;
  497. this.rectTransform.pivot = m_TextComponent.rectTransform.pivot;
  498. }
  499. Transform GetRootCanvasTransform()
  500. {
  501. if (m_RootCanvasTransform == null)
  502. m_RootCanvasTransform = m_TextComponent.canvas.rootCanvas.transform;
  503. return m_RootCanvasTransform;
  504. }
  505. private Transform m_RootCanvasTransform;
  506. /// <summary>
  507. /// Override Cull function as this is handled by the parent text object.
  508. /// </summary>
  509. /// <param name="clipRect"></param>
  510. /// <param name="validRect"></param>
  511. public override void Cull(Rect clipRect, bool validRect)
  512. {
  513. // Do nothing as this functionality is handled by the parent text object.
  514. }
  515. /// <summary>
  516. ///
  517. /// </summary>
  518. protected override void UpdateGeometry()
  519. {
  520. // Need to override to prevent Unity from changing the geometry of the object.
  521. //Debug.Log("UpdateGeometry()");
  522. }
  523. /// <summary>
  524. ///
  525. /// </summary>
  526. /// <param name="update"></param>
  527. public override void Rebuild(CanvasUpdate update)
  528. {
  529. if (update == CanvasUpdate.PreRender)
  530. {
  531. if (!m_materialDirty) return;
  532. UpdateMaterial();
  533. m_materialDirty = false;
  534. }
  535. }
  536. /// <summary>
  537. /// Function to update the material from the parent text object.
  538. /// </summary>
  539. public void RefreshMaterial()
  540. {
  541. UpdateMaterial();
  542. }
  543. /// <summary>
  544. ///
  545. /// </summary>
  546. protected override void UpdateMaterial()
  547. {
  548. //Debug.Log("*** STO-UI - UpdateMaterial() *** FRAME (" + Time.frameCount + ")");
  549. if (m_sharedMaterial == null)
  550. return;
  551. //if (canvasRenderer == null) m_canvasRenderer = this.canvasRenderer;
  552. // Special handling to keep the Culling of the material in sync with parent text object
  553. if (m_sharedMaterial.HasProperty(ShaderUtilities.ShaderTag_CullMode) && textComponent.fontSharedMaterial != null)
  554. {
  555. float cullMode = textComponent.fontSharedMaterial.GetFloat(ShaderUtilities.ShaderTag_CullMode);
  556. m_sharedMaterial.SetFloat(ShaderUtilities.ShaderTag_CullMode, cullMode);
  557. }
  558. canvasRenderer.materialCount = 1;
  559. canvasRenderer.SetMaterial(materialForRendering, 0);
  560. //canvasRenderer.SetTexture(materialForRendering.mainTexture);
  561. #if UNITY_EDITOR
  562. if (m_sharedMaterial != null && gameObject.name != "TMP SubMeshUI [" + m_sharedMaterial.name + "]")
  563. gameObject.name = "TMP SubMeshUI [" + m_sharedMaterial.name + "]";
  564. #endif
  565. }
  566. // IClippable implementation
  567. /// <summary>
  568. /// Method called when the state of a parent changes.
  569. /// </summary>
  570. public override void RecalculateClipping()
  571. {
  572. //Debug.Log("*** RecalculateClipping() ***");
  573. base.RecalculateClipping();
  574. }
  575. /// <summary>
  576. ///
  577. /// </summary>
  578. // public override void RecalculateMasking()
  579. // {
  580. // //Debug.Log("RecalculateMasking()");
  581. //
  582. // this.m_ShouldRecalculateStencil = true;
  583. // SetMaterialDirty();
  584. // }
  585. /// <summary>
  586. /// Method which returns an instance of the shared material
  587. /// </summary>
  588. /// <returns></returns>
  589. Material GetMaterial()
  590. {
  591. // Make sure we have a valid reference to the renderer.
  592. //if (m_renderer == null) m_renderer = GetComponent<Renderer>();
  593. //if (m_material == null || m_isNewSharedMaterial)
  594. //{
  595. // m_renderer.material = m_sharedMaterial;
  596. // m_material = m_renderer.material;
  597. // m_sharedMaterial = m_material;
  598. // m_padding = ShaderUtilities.GetPadding(m_sharedMaterial, m_TextMeshPro.extraPadding, false);
  599. // m_isNewSharedMaterial = false;
  600. //}
  601. return m_sharedMaterial;
  602. }
  603. // Function called internally when a new material is assigned via the fontMaterial property.
  604. Material GetMaterial(Material mat)
  605. {
  606. // Check in case Object is disabled. If so, we don't have a valid reference to the Renderer.
  607. // This can occur when the Duplicate Material Context menu is used on an inactive object.
  608. //if (m_renderer == null)
  609. // m_renderer = GetComponent<Renderer>();
  610. // Create Instance Material only if the new material is not the same instance previously used.
  611. if (m_material == null || m_material.GetInstanceID() != mat.GetInstanceID())
  612. m_material = CreateMaterialInstance(mat);
  613. m_sharedMaterial = m_material;
  614. // Compute and Set new padding values for this new material.
  615. m_padding = GetPaddingForMaterial();
  616. SetVerticesDirty();
  617. SetMaterialDirty();
  618. return m_sharedMaterial;
  619. }
  620. /// <summary>
  621. /// Method used to create an instance of the material
  622. /// </summary>
  623. /// <param name="source"></param>
  624. /// <returns></returns>
  625. Material CreateMaterialInstance(Material source)
  626. {
  627. Material mat = new Material(source);
  628. mat.shaderKeywords = source.shaderKeywords;
  629. mat.name += " (Instance)";
  630. return mat;
  631. }
  632. /// <summary>
  633. /// Method returning the shared material assigned to the text object.
  634. /// </summary>
  635. /// <returns></returns>
  636. Material GetSharedMaterial()
  637. {
  638. //if (canvasRenderer == null)
  639. // canvasRenderer = GetComponent<CanvasRenderer>();
  640. return canvasRenderer.GetMaterial();
  641. }
  642. /// <summary>
  643. /// Method to set the shared material.
  644. /// </summary>
  645. /// <param name="mat"></param>
  646. void SetSharedMaterial(Material mat)
  647. {
  648. //Debug.Log("*** SetSharedMaterial UI() *** FRAME (" + Time.frameCount + ")");
  649. // Assign new material.
  650. m_sharedMaterial = mat;
  651. m_Material = m_sharedMaterial;
  652. //m_isDefaultMaterial = false;
  653. //if (mat.GetInstanceID() == m_fontAsset.material.GetInstanceID())
  654. // m_isDefaultMaterial = true;
  655. // Compute and Set new padding values for this new material.
  656. m_padding = GetPaddingForMaterial();
  657. //SetVerticesDirty();
  658. SetMaterialDirty();
  659. #if UNITY_EDITOR
  660. //if (m_sharedMaterial != null)
  661. // gameObject.name = "TMP SubMesh [" + m_sharedMaterial.name + "]";
  662. #endif
  663. }
  664. }
  665. }