Merge pull request #424 from HodgsonSDAS/HTK-MaterialRefFixes

Fixes material memory leaks in various files

Author: NeerajW

Assets/HoloToolkit/Input/Tests/Scripts/FocusedObjectColorChanger.cs

@@ -6,27 +6,34 @@ namespace HoloToolkit.Unity.InputModule.Tests
     /// FocusedObjectMessageReceiver class shows how to handle focus events.
     /// This particular implementatoin controls object appearance by changing its color when focused.
     /// </summary>
+    [RequireComponent(typeof(Renderer))]
     public class FocusedObjectColorChanger : MonoBehaviour, IFocusable
     {
-        [Tooltip("Object color changes to this when focused.")] public Color FocusedColor = Color.red;
+        [Tooltip("Object color changes to this when focused.")]
+        public Color FocusedColor = Color.red;
 
-        private Material material;
         private Color originalColor;
+        private Material cachedMaterial;
 
-        private void Start()
+        private void Awake()
         {
-            material = GetComponent<Renderer>().material;
-            originalColor = material.color;
+            cachedMaterial = GetComponent<Renderer>().material;
+            originalColor = cachedMaterial.GetColor("_Color");
         }
 
         public void OnFocusEnter()
         {
-            material.color = FocusedColor;
+            cachedMaterial.SetColor("_Color", FocusedColor);
         }
 
         public void OnFocusExit()
         {
-            material.color = originalColor;
+            cachedMaterial.SetColor("_Color", originalColor);
+        }
+
+        private void OnDestroy()
+        {
+            DestroyImmediate(cachedMaterial);
         }
     }
 }

Assets/HoloToolkit/Input/Tests/Scripts/SelectedObjectMessageReceiver.cs

@@ -6,27 +6,34 @@ namespace HoloToolkit.Unity.InputModule.Tests
     /// SelectedObjectMessageReceiver class shows how to handle messages sent by SelectedObjectMessageSender.
     /// This particular implementatoin controls object appearance by changing its color when selected.
     /// </summary>
+    [RequireComponent(typeof(Renderer))]
     public class SelectedObjectMessageReceiver : MonoBehaviour
     {
-        [Tooltip("Object color changes to this when selected.")] public Color SelectedColor = Color.red;
+        [Tooltip("Object color changes to this when selected.")]
+        public Color SelectedColor = Color.red;
 
-        private Material material;
         private Color originalColor;
+        private Material cachedMaterial;
 
-        private void Start()
+        private void Awake()
         {
-            material = GetComponent<Renderer>().material;
-            originalColor = material.color;
+            cachedMaterial = GetComponent<Renderer>().material;
+            originalColor = cachedMaterial.GetColor("_Color");
         }
 
         public void OnSelectObject()
         {
-            material.color = SelectedColor;
+            cachedMaterial.SetColor("_Color", SelectedColor);
         }
 
         public void OnClearSelection()
         {
-            material.color = originalColor;
+            cachedMaterial.SetColor("_Color", originalColor);
+        }
+
+        private void OnDestroy()
+        {
+            DestroyImmediate(cachedMaterial);
         }
     }
 }

Assets/HoloToolkit/Input/Tests/Scripts/SphereGlobalKeywords.cs

@@ -1,24 +1,46 @@
 // Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT License. See LICENSE in the project root for license information.
 
-using System;
 using UnityEngine;
 
 namespace HoloToolkit.Unity.InputModule.Tests
 {
     public class SphereGlobalKeywords : MonoBehaviour, ISpeechHandler
     {
+        private Material[] cachedChildMaterials;
+
+        private void Awake()
+        {
+            Renderer[] childRenderers = GetComponentsInChildren<Renderer>();
+            if (childRenderers != null && childRenderers.Length > 0)
+            {
+                cachedChildMaterials = new Material[childRenderers.Length];
+                for (int i = 0; i < childRenderers.Length; i++)
+                {
+                    cachedChildMaterials[i] = childRenderers[i].material;
+                }
+            }
+        }
+
         public void OnSpeechKeywordRecognized(SpeechKeywordRecognizedEventData eventData)
         {
             switch (eventData.RecognizedText.ToLower())
             {
                 case "reset all":
-                    foreach (Renderer renderer in GetComponentsInChildren<Renderer>())
+                    foreach (Material cachedChildMaterial in cachedChildMaterials)
                     {
-                        renderer.material.color = Color.gray;
+                        cachedChildMaterial.SetColor("_Color", Color.gray);
                     }
                     break;
             }
         }
+
+        private void OnDestroy()
+        {
+            for (int i = 0; i < cachedChildMaterials.Length; i++)
+            {
+                DestroyImmediate(cachedChildMaterials[i]);
+            }
+        }
     }
 }

Assets/HoloToolkit/Input/Tests/Scripts/SphereKeywords.cs

@@ -1,25 +1,32 @@
 // Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT License. See LICENSE in the project root for license information.
 
-using System;
 using UnityEngine;
 
 namespace HoloToolkit.Unity.InputModule.Tests
 {
+    [RequireComponent(typeof(Renderer))]
     public class SphereKeywords : MonoBehaviour, ISpeechHandler
     {
+        private Material cachedMaterial;
+
+        private void Awake()
+        {
+            cachedMaterial = GetComponent<Renderer>().material;
+        }
+
         public void ChangeColor(string color)
         {
             switch (color.ToLower())
             {
                 case "red":
-                    GetComponent<Renderer>().material.color = Color.red;
+                    cachedMaterial.SetColor("_Color", Color.red);
                     break;
                 case "blue":
-                    GetComponent<Renderer>().material.color = Color.blue;
+                    cachedMaterial.SetColor("_Color", Color.blue);
                     break;
                 case "green":
-                    GetComponent<Renderer>().material.color = Color.green;
+                    cachedMaterial.SetColor("_Color", Color.green);
                     break;
             }
         }
@@ -28,5 +35,10 @@ public void OnSpeechKeywordRecognized(SpeechKeywordRecognizedEventData eventData
         {
             ChangeColor(eventData.RecognizedText);
         }
+
+        private void OnDestroy()
+        {
+            DestroyImmediate(cachedMaterial);
+        }
     }
 }

Assets/HoloToolkit/Input/Tests/Scripts/TestButton.cs

@@ -33,6 +33,7 @@ public class TestButton : MonoBehaviour, IInputClickHandler, IFocusable
         public bool EnableActivation = true;
 
         private AnimatorControllerParameter[] animatorHashes;
+        private Material cachedToolTipMaterial;
 
         private bool focused;
         public bool Focused
@@ -101,13 +102,14 @@ protected virtual void Awake()
 
         protected virtual void OnEnable()
         {
-
             // Set the initial alpha
             if (ToolTipRenderer != null)
             {
-                Color tipColor = ToolTipRenderer.material.color;
+                cachedToolTipMaterial = ToolTipRenderer.material;
+
+                Color tipColor = cachedToolTipMaterial.GetColor("_Color");
                 tipColor.a = 0.0f;
-                ToolTipRenderer.material.color = tipColor;
+                cachedToolTipMaterial.SetColor("_Color", tipColor);
                 toolTipTimer = 0.0f;
             }
 
@@ -135,9 +137,9 @@ private void Update()
                 // Update the new opacity
                 if (ToolTipRenderer != null)
                 {
-                    Color tipColor = ToolTipRenderer.material.color;
+                    Color tipColor = cachedToolTipMaterial.GetColor("_Color");
                     tipColor.a = Mathf.Clamp(toolTipTimer, 0, ToolTipFadeTime) / ToolTipFadeTime;
-                    ToolTipRenderer.material.color = tipColor;
+                    cachedToolTipMaterial.SetColor("_Color", tipColor);
                 }
             }
         }
@@ -229,5 +231,10 @@ public void OnFocusExit()
 
             UpdateVisuals();
         }
+
+        private void OnDestroy()
+        {
+            DestroyImmediate(cachedToolTipMaterial);
+        }
     }
 }

Assets/HoloToolkit/Sharing/Scripts/Utilities/Utils.cs

@@ -112,11 +112,16 @@ public static void SetMaterialRecursive(Transform t, Material mat)
         }
 
         /// <summary>
-        /// Change material for every object in hierarchy which has a name equal to nameToTest
+        /// Change material for every object in hierarchy which has a name equal to nameToTest.  WARNING! 
+        /// <see cref="http://answers.unity3d.com/questions/548420/material-memory-leak.html">See Community Answer</see>
+        /// This function automatically instantiates the materials and makes them unique to this renderer.
+        /// It is your responsibility to destroy the materials when the game object is being destroyed.
+        /// Resources.UnloadUnusedAssets also destroys the materials but it is usually only called when loading a new level.
+        /// <see cref="https://docs.unity3d.com/ScriptReference/Renderer-material.html">See Unity Documentation</see>
         /// </summary>
         /// <param name="t">root transform to start looking for renderers</param>
         /// <param name="mat">material to set everything to</param>
-        /// <param name="ignoreName">ignore GameObjects with this name</param>
+        /// <param name="nameToTest">ignore GameObjects with this name</param>
         public static void SetMaterialRecursiveForName(Transform t, Material mat, string nameToTest)
         {
             if (t.gameObject && t.gameObject.GetComponent<Renderer>() && t.gameObject.name == nameToTest)
@@ -128,6 +133,8 @@ public static void SetMaterialRecursiveForName(Transform t, Material mat, string
             {
                 SetMaterialRecursiveForName(t.GetChild(ii), mat, nameToTest);
             }
+
+            Resources.UnloadUnusedAssets();
         }
 
         /// <summary>

Assets/HoloToolkit/Utilities/Scripts/DirectionIndicator.cs

@@ -34,6 +34,9 @@ public class DirectionIndicator : MonoBehaviour
         // Cache the MeshRenderer for the on-cursor indicator since it will be enabled and disabled frequently.
         private Renderer directionIndicatorRenderer;
 
+        // Cache the Material to prevent material leak.
+        private Material indicatorMaterial;
+
         // Check if the cursor direction indicator is visible.
         private bool isDirectionIndicatorVisible;
 
@@ -55,13 +58,13 @@ public void Awake()
             if (DirectionIndicatorObject == null)
             {
                 Debug.LogError("Direction Indicator failed to instantiate.");
-                return;
             }
         }
 
         public void OnDestroy()
         {
-            GameObject.Destroy(DirectionIndicatorObject);
+            DestroyImmediate(indicatorMaterial);
+            Destroy(DirectionIndicatorObject);
         }
 
         private GameObject InstantiateDirectionIndicator(GameObject directionIndicator)
@@ -81,17 +84,17 @@ private GameObject InstantiateDirectionIndicator(GameObject directionIndicator)
             directionIndicatorRenderer.enabled = false;
 
             // Remove any colliders and rigidbodies so the indicators do not interfere with Unity's physics system.
-            foreach (Collider collider in indicator.GetComponents<Collider>())
+            foreach (Collider indicatorCollider in indicator.GetComponents<Collider>())
             {
-                Destroy(collider);
+                Destroy(indicatorCollider);
             }
 
             foreach (Rigidbody rigidBody in indicator.GetComponents<Rigidbody>())
             {
                 Destroy(rigidBody);
             }
 
-            Material indicatorMaterial = directionIndicatorRenderer.material;
+            indicatorMaterial = directionIndicatorRenderer.material;
             indicatorMaterial.color = DirectionIndicatorColor;
             indicatorMaterial.SetColor("_TintColor", DirectionIndicatorColor);
 
@@ -132,14 +135,11 @@ private bool IsTargetVisible()
             // This will return true if the target's mesh is within the Main Camera's view frustums.
             Vector3 targetViewportPosition = Camera.main.WorldToViewportPoint(gameObject.transform.position);
             return (targetViewportPosition.x > VisibilitySafeFactor && targetViewportPosition.x < 1 - VisibilitySafeFactor &&
-                targetViewportPosition.y > VisibilitySafeFactor && targetViewportPosition.y < 1 - VisibilitySafeFactor &&
-                targetViewportPosition.z > 0);
+                    targetViewportPosition.y > VisibilitySafeFactor && targetViewportPosition.y < 1 - VisibilitySafeFactor &&
+                    targetViewportPosition.z > 0);
         }
 
-        private void GetDirectionIndicatorPositionAndRotation(
-            Vector3 camToObjectDirection,
-            out Vector3 position,
-            out Quaternion rotation)
+        private void GetDirectionIndicatorPositionAndRotation(Vector3 camToObjectDirection, out Vector3 position, out Quaternion rotation)
         {
             // Find position:
             // Save the cursor transform position in a variable.
@@ -160,9 +160,7 @@ private void GetDirectionIndicatorPositionAndRotation(
             position = origin + cursorIndicatorDirection * MetersFromCursor;
 
             // Find the rotation from the facing direction to the target object.
-            rotation = Quaternion.LookRotation(
-                Camera.main.transform.forward,
-                cursorIndicatorDirection) * directionIndicatorDefaultRotation;
+            rotation = Quaternion.LookRotation(Camera.main.transform.forward, cursorIndicatorDirection) * directionIndicatorDefaultRotation;
         }
     }
 }