Created
January 20, 2016 14:03
-
-
Save tommycutter/8294f95906d1e1db5f94 to your computer and use it in GitHub Desktop.
Letter Spacing Component for Unity 5_3
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| using UnityEngine; | |
| using System.Collections; | |
| using System.Collections.Generic; | |
| /* | |
| http://forum.unity3d.com/threads/adjustable-character-spacing-free-script.288277/ | |
| Unity 5.1 and 5.2.2+ compatible | |
| Produces an simple tracking/letter-spacing effect on UI Text components. | |
| Set the spacing parameter to adjust letter spacing. | |
| Negative values cuddle the text up tighter than normal. Go too far and it'll look odd. | |
| Positive values spread the text out more than normal. This will NOT respect the text area you've defined. | |
| Zero spacing will present the font with no changes. | |
| Relies on counting off characters in your Text compoennt's text property and | |
| matching those against the quads passed in via the verts array. This is really | |
| rather primative, but I can't see any better way at the moment. It means that | |
| all sorts of things can break the effect... | |
| This component should be placed higher in component list than any other vertex | |
| modifiers that alter the total number of verticies. Eg, place this ABOVE Shadow | |
| or Outline effects. If you don't, the outline/shadow won't match the position | |
| of the letters properly. If you place the outline/shadow effect second however, | |
| it will just work on the altered vertices from this component, and function | |
| as expected. | |
| This component works best if you don't allow text to automatically wrap. It also | |
| blows up outside of the given text area. Basically, it's a cheap and dirty effect, | |
| not a clever text layout engine. It can't affect how Unity chooses to break up | |
| your lines. If you manually use line breaks however, it should detect those and | |
| function more or less as you'd expect. | |
| The spacing parameter is measured in pixels multiplied by the font size. This was | |
| chosen such that when you adjust the font size, it does not change the visual spacing | |
| that you've dialed in. There's also a scale factor of 1/100 in this number to | |
| bring it into a comfortable adjustable range. There's no limit on this parameter, | |
| but obviously some values will look quite strange. | |
| This component doesn't really work with Rich Text. You don't need to remember to | |
| turn off Rich Text via the checkbox, but because it can't see what makes a | |
| printable character and what doesn't, it will typically miscount characters when you | |
| use HTML-like tags in your text. Try it out, you'll see what I mean. It doesn't | |
| break down entirely, but it doesn't really do what you'd want either. | |
| */ | |
| namespace UnityEngine.UI | |
| { | |
| [AddComponentMenu("UI/Effects/Letter Spacing", 14)] | |
| #if UNITY_5_3 | |
| public class LetterSpacing : BaseMeshEffect | |
| #else | |
| public class LetterSpacing : BaseVertexEffect | |
| #endif | |
| { | |
| [SerializeField] | |
| private float m_spacing = 0f; | |
| protected LetterSpacing() { } | |
| #if UNITY_EDITOR | |
| protected override void OnValidate() | |
| { | |
| spacing = m_spacing; | |
| base.OnValidate(); | |
| } | |
| #endif | |
| public float spacing | |
| { | |
| get { return m_spacing; } | |
| set | |
| { | |
| if (m_spacing == value) return; | |
| m_spacing = value; | |
| if (graphic != null) graphic.SetVerticesDirty(); | |
| } | |
| } | |
| #if UNITY_5_3 | |
| /** | |
| * Note: Unity 5.2.1 ModifyMesh(Mesh mesh) used VertexHelper.FillMesh(mesh); | |
| * For performance reasons, ModifyMesh(VertexHelper vh) was introduced | |
| * @see http://forum.unity3d.com/threads/unity-5-2-ui-performance-seems-much-worse.353650/ | |
| */ | |
| public override void ModifyMesh(VertexHelper vh) | |
| { | |
| if (!this.IsActive()) | |
| return; | |
| List<UIVertex> list = new List<UIVertex>(); | |
| vh.GetUIVertexStream(list); | |
| ModifyVertices(list); | |
| vh.Clear(); | |
| vh.AddUIVertexTriangleStream(list); | |
| } | |
| public void ModifyVertices(List<UIVertex> verts) | |
| { | |
| if (!IsActive()) return; | |
| Text text = GetComponent<Text>(); | |
| if (text == null) | |
| { | |
| Debug.LogWarning("LetterSpacing: Missing Text component"); | |
| return; | |
| } | |
| string[] lines = text.text.Split('\n'); | |
| Vector3 pos; | |
| float letterOffset = spacing * (float)text.fontSize / 100f; | |
| float alignmentFactor = 0; | |
| int glyphIdx = 0; | |
| switch (text.alignment) | |
| { | |
| case TextAnchor.LowerLeft: | |
| case TextAnchor.MiddleLeft: | |
| case TextAnchor.UpperLeft: | |
| alignmentFactor = 0f; | |
| break; | |
| case TextAnchor.LowerCenter: | |
| case TextAnchor.MiddleCenter: | |
| case TextAnchor.UpperCenter: | |
| alignmentFactor = 0.5f; | |
| break; | |
| case TextAnchor.LowerRight: | |
| case TextAnchor.MiddleRight: | |
| case TextAnchor.UpperRight: | |
| alignmentFactor = 1f; | |
| break; | |
| } | |
| for (int lineIdx = 0; lineIdx < lines.Length; lineIdx++) | |
| { | |
| string line = lines[lineIdx]; | |
| float lineOffset = (line.Length - 1) * letterOffset * alignmentFactor; | |
| for (int charIdx = 0; charIdx < line.Length; charIdx++) | |
| { | |
| int idx1 = glyphIdx * 6 + 0; | |
| int idx2 = glyphIdx * 6 + 1; | |
| int idx3 = glyphIdx * 6 + 2; | |
| int idx4 = glyphIdx * 6 + 3; | |
| int idx5 = glyphIdx * 6 + 4; | |
| int idx6 = glyphIdx * 6 + 5; | |
| // Check for truncated text (doesn't generate verts for all characters) | |
| if (idx6 > verts.Count - 1) return; | |
| UIVertex vert1 = verts[idx1]; | |
| UIVertex vert2 = verts[idx2]; | |
| UIVertex vert3 = verts[idx3]; | |
| UIVertex vert4 = verts[idx4]; | |
| UIVertex vert5 = verts[idx5]; | |
| UIVertex vert6 = verts[idx6]; | |
| pos = Vector3.right * (letterOffset * charIdx - lineOffset); | |
| vert1.position += pos; | |
| vert2.position += pos; | |
| vert3.position += pos; | |
| vert4.position += pos; | |
| vert5.position += pos; | |
| vert6.position += pos; | |
| verts[idx1] = vert1; | |
| verts[idx2] = vert2; | |
| verts[idx3] = vert3; | |
| verts[idx4] = vert4; | |
| verts[idx5] = vert5; | |
| verts[idx6] = vert6; | |
| glyphIdx++; | |
| } | |
| // Offset for carriage return character that still generates verts | |
| glyphIdx++; | |
| } | |
| } | |
| #else | |
| public override void ModifyVertices(List<UIVertex> verts) | |
| { | |
| if (! IsActive()) return; | |
| Text text = GetComponent<Text>(); | |
| if (text == null) | |
| { | |
| Debug.LogWarning("LetterSpacing: Missing Text component"); | |
| return; | |
| } | |
| string[] lines = text.text.Split('\n'); | |
| Vector3 pos; | |
| float letterOffset = spacing * (float)text.fontSize / 100f; | |
| float alignmentFactor = 0; | |
| int glyphIdx = 0; | |
| switch (text.alignment) | |
| { | |
| case TextAnchor.LowerLeft: | |
| case TextAnchor.MiddleLeft: | |
| case TextAnchor.UpperLeft: | |
| alignmentFactor = 0f; | |
| break; | |
| case TextAnchor.LowerCenter: | |
| case TextAnchor.MiddleCenter: | |
| case TextAnchor.UpperCenter: | |
| alignmentFactor = 0.5f; | |
| break; | |
| case TextAnchor.LowerRight: | |
| case TextAnchor.MiddleRight: | |
| case TextAnchor.UpperRight: | |
| alignmentFactor = 1f; | |
| break; | |
| } | |
| for (int lineIdx=0; lineIdx < lines.Length; lineIdx++) | |
| { | |
| string line = lines[lineIdx]; | |
| float lineOffset = (line.Length -1) * letterOffset * alignmentFactor; | |
| for (int charIdx = 0; charIdx < line.Length; charIdx++) | |
| { | |
| int idx1 = glyphIdx * 4 + 0; | |
| int idx2 = glyphIdx * 4 + 1; | |
| int idx3 = glyphIdx * 4 + 2; | |
| int idx4 = glyphIdx * 4 + 3; | |
| // Check for truncated text (doesn't generate verts for all characters) | |
| if (idx4 > verts.Count - 1) return; | |
| UIVertex vert1 = verts[idx1]; | |
| UIVertex vert2 = verts[idx2]; | |
| UIVertex vert3 = verts[idx3]; | |
| UIVertex vert4 = verts[idx4]; | |
| pos = Vector3.right * (letterOffset * charIdx - lineOffset); | |
| vert1.position += pos; | |
| vert2.position += pos; | |
| vert3.position += pos; | |
| vert4.position += pos; | |
| verts[idx1] = vert1; | |
| verts[idx2] = vert2; | |
| verts[idx3] = vert3; | |
| verts[idx4] = vert4; | |
| glyphIdx++; | |
| } | |
| // Offset for carriage return character that still generates verts | |
| glyphIdx++; | |
| } | |
| } | |
| #endif | |
| } | |
| } |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Created by @jo.seemoore on the Unity3d forums
More info: http://forum.unity3d.com/threads/adjustable-character-spacing-free-script.288277/