Merge pull request #339 from cre8ivepark/master

Text prefab with optimized dimension and rendering quality

Assets/HoloToolkit/UI/README.md

@@ -0,0 +1,78 @@
+## [UI]()
+
+Useful common UI controls that you can leverage in your application.
+
+
+
+### [Materials](Materials)
+
+Materials used in prefabs
+
+#### 3DTextSegoeUI.mat
+
+Material for 3DTextPrefab with occlusion support. Requires 3DTextShader.shader
+
+![Default Font material vs 3DTextSegoeUI material](https://github.com/cre8ivepark/HoloToolkit-Unity/blob/master/External/ReadMeImages/TextPrefabInstructions06.png)
+
+### [Prefabs](Prefabs)
+
+Common useful UI prefabs 
+
+#### 3DTextPrefab.prefab
+
+3D Text Mesh prefab with optimized scaling factor at 2-meter distance. (Please read the instructions below)
+
+#### UITextPrefab.prefab
+
+UI Text Mesh prefab with optimized scaling factor at 2-meter distance. (Please read the instructions below)
+
+**IMPORTANT**: To use Text prefabs, please make sure to import SegoeUI.TTF font file from your system font folder (C:\Windows\Fonts\)  
+![Importing Segoe UI font file](https://github.com/cre8ivepark/HoloToolkit-Unity/blob/master/External/ReadMeImages/TextPrefabInstructions01.png)
+
+1. Assign font texture to 3DTextSegoeUI.mat material. 
+![Assigning font texture](https://github.com/cre8ivepark/HoloToolkit-Unity/blob/master/External/ReadMeImages/TextPrefabInstructions02.png)
+
+2. On 3DTextSegoeUI.mat material, select the shader Custom/3DTextShader.shader. 
+![Assigning shader](https://github.com/cre8ivepark/HoloToolkit-Unity/blob/master/External/ReadMeImages/TextPrefabInstructions03.png)
+
+3. Assign Segoe UI font and 3DTextSegoeUI material to the text components in the prefabs.
+![Assigning font file and material](https://github.com/cre8ivepark/HoloToolkit-Unity/blob/master/External/ReadMeImages/TextPrefabInstructions04.png)
+
+4. Follow the same steps for the sample text layout prefabs in [HoloToolkit-Examples\Text](../..//HoloToolkit-Examples/Text)
+![Sample layout prefabs](https://github.com/cre8ivepark/HoloToolkit-Unity/blob/master/External/ReadMeImages/TextPrefabInstructions05.png)
+
+**Working with Fonts in Unity**
+
+When adding a new 3D TextMesh to a scene in Unity there are two issues that are visually apparent. One, the font appears very large and two, the font appears very blurry. It is also interesting to notice that the default Font Size value is set to zero in the Inspector. Replacing this zero value with 13 will show no difference in size, because 13 is actually the default value.
+
+Unity assumes all new elements added to a scene is 1 Unity Unit in size, or 100%  Transform scale, which translates to about 1 meter on the HoloLens. In the case of fonts, the bounding box for a 3D TextMesh comes in, by default at about 1 meter in height.
+
+**Font Scale and Font Sizes**
+
+Most visual designers use Points to define font sizes in the real world, as well as their design programs. There are about 2835 (2,834.645666399962) points in 1 meter. Based on the point system conversion to 1 meter and Unity's default TextMesh Font Size of 13, the simple math of 13 divided by 2835 equals 0.0046 (0.004586111116 to be exact) provides a good standard scale to start with, though some may wish to round to 0.005.
+
+Either way, scaling the Text object or container to these values will not only allow for the 1:1 conversion of font sizes from a design program, but also provides a standard to maintain consistency throughout the application or game.
+
+**UI Text**
+
+When adding a UI or canvas based Text element to a scene, the size disparity is greater still. The differences in the two sizes is about 1000%, which would bring the scale factor for UI based Text components to 0.00046 (0.0004586111116 to be exact) or 0.0005 for the rounded value.
+
+**Disclaimer**: The default value of any font may be effected by the texture size of that font or how the font was imported into Unity. These tests were performed based on the default Arial font in Unity, as well as one other imported font.
+
+![Font size with scaling factors](https://github.com/cre8ivepark/HoloToolkit-Unity/blob/master/External/ReadMeImages/TextPrefabInstructions07.png)
+
+### [Scripts](Scripts)
+
+
+
+### [Shaders](Shaders)
+
+Materials used in prefabs
+
+#### 3DTextShader.shader
+
+Shader for 3DTextPrefab with occlusion support.
+
+---
+##### [Go back up to the table of contents.](../../../README.md)
+---

Assets/HoloToolkit/UI/Shaders/3DTextShader.shader

@@ -0,0 +1,18 @@
+Shader "HoloToolkit/3DTextShader"{
+	Properties{
+		_MainTex("Font Texture", 2D) = "white" {}
+		_Color("Text Color", Color) = (1,1,1,1)
+	}
+
+	SubShader{
+		Tags{ "Queue" = "Transparent" "IgnoreProjector" = "True" "RenderType" = "Transparent" }
+		Lighting Off Cull Off ZWrite Off Fog{ Mode Off }
+		Blend SrcAlpha OneMinusSrcAlpha
+		Pass{
+			Color[_Color]
+			SetTexture[_MainTex]{
+				combine primary, texture * primary
+			}
+		}
+	}
+}