UnmaskForUGUI/Scripts/Unmask.cs

using System.Collections;
using System.Collections.Generic;
using UnityEngine;
using UnityEngine.Rendering;
using UnityEngine.UI;


namespace Coffee.UIExtensions
{
	/// <summary>
	/// Reverse masking for parent Mask component.
	/// </summary>
	[ExecuteInEditMode]
	[AddComponentMenu("UI/Unmask/Unmask", 1)]
	public class Unmask : MonoBehaviour, IMaterialModifier
	{
		//################################
		// Constant or Static Members.
		//################################
		static readonly Vector2 s_Center = new Vector2(0.5f, 0.5f);


		//################################
		// Serialize Members.
		//################################
		[Tooltip("Fit graphic's transform to target transform.")]
		[SerializeField] RectTransform m_FitTarget;
		[Tooltip("Fit graphic's transform to target transform on LateUpdate every frame.")]
		[SerializeField] bool m_FitOnLateUpdate;
		[Tooltip("Show the graphic that is associated with the unmask render area.")]
		[SerializeField] bool m_ShowUnmaskGraphic = false;
		[Tooltip ("Unmask affects only for children.")]
		[SerializeField] bool m_OnlyForChildren = false;


		//################################
		// Public Members.
		//################################
		/// <summary>
		/// The graphic associated with the unmask.
		/// </summary>
		public Graphic graphic{ get { return _graphic ?? (_graphic = GetComponent<Graphic>()); } }

		/// <summary>
		/// Fit graphic's transform to target transform.
		/// </summary>
		public RectTransform fitTarget
		{
			get { return m_FitTarget; }
			set
			{
				m_FitTarget = value;
				FitTo(m_FitTarget);
			}
		}

		/// <summary>
		/// Fit graphic's transform to target transform on LateUpdate every frame.
		/// </summary>
		public bool fitOnLateUpdate{ get { return m_FitOnLateUpdate; } set { m_FitOnLateUpdate = value; } }

		/// <summary>
		/// Show the graphic that is associated with the unmask render area.
		/// </summary>
		public bool showUnmaskGraphic
		{
			get { return m_ShowUnmaskGraphic; }
			set
			{
				m_ShowUnmaskGraphic = value;
				SetDirty();
			}
		}


		/// <summary>
		/// Unmask affects only for children.
		/// </summary>
		public bool onlyForChildren
		{
			get { return m_OnlyForChildren; }
			set
			{
				m_OnlyForChildren = value;
				SetDirty ();
			}
		}

		/// <summary>
		/// Perform material modification in this function.
		/// </summary>
		/// <returns>Modified material.</returns>
		/// <param name="baseMaterial">Configured Material.</param>
		public Material GetModifiedMaterial(Material baseMaterial)
		{
			if (!isActiveAndEnabled)
			{
				return baseMaterial;
			}

			Transform stopAfter = MaskUtilities.FindRootSortOverrideCanvas(transform);
			var stencilDepth = MaskUtilities.GetStencilDepth(transform, stopAfter);

			StencilMaterial.Remove(_unmaskMaterial);
			_unmaskMaterial = StencilMaterial.Add(baseMaterial, (1 << stencilDepth) - 1, StencilOp.Zero, CompareFunction.Always, m_ShowUnmaskGraphic ? ColorWriteMask.All : (ColorWriteMask)0, 0, (1 << stencilDepth) - 1);

			// Unmask affects only for children.
			var canvasRenderer = graphic.canvasRenderer;
			if (m_OnlyForChildren)
			{
				canvasRenderer.hasPopInstruction = true;
				StencilMaterial.Remove (_revertUnmaskMaterial);
				_revertUnmaskMaterial = StencilMaterial.Add (baseMaterial, (1 << stencilDepth) - 1, StencilOp.Replace, CompareFunction.NotEqual, (ColorWriteMask)0);
				canvasRenderer.popMaterialCount = 1;
				canvasRenderer.SetPopMaterial (_revertUnmaskMaterial, 0);
			}
			else
			{
				canvasRenderer.hasPopInstruction = false;
				canvasRenderer.popMaterialCount = 0;
			}

			return _unmaskMaterial;
		}

		/// <summary>
		/// Fit to target transform.
		/// </summary>
		/// <param name="target">Target transform.</param>
		public void FitTo(RectTransform target)
		{
			var rt = transform as RectTransform;

			rt.position = target.position;
			rt.rotation = target.rotation;

			var s1 = target.lossyScale;
			var s2 = rt.parent.lossyScale;
			rt.localScale = new Vector3(s1.x / s2.x, s1.y / s2.y, s1.z / s2.z);
			rt.sizeDelta = target.rect.size;
			rt.anchorMax = rt.anchorMin = s_Center;
		}


		//################################
		// Private Members.
		//################################
		Material _unmaskMaterial;
		Material _revertUnmaskMaterial;
		Graphic _graphic;

		/// <summary>
		/// This function is called when the object becomes enabled and active.
		/// </summary>
		void OnEnable()
		{
			if (m_FitTarget)
			{
				FitTo(m_FitTarget);
			}
			SetDirty();
		}

		/// <summary>
		/// This function is called when the behaviour becomes disabled () or inactive.
		/// </summary>
		void OnDisable()
		{
			StencilMaterial.Remove (_unmaskMaterial);
			StencilMaterial.Remove (_revertUnmaskMaterial);
			_unmaskMaterial = null;
			_revertUnmaskMaterial = null;

			var canvasRenderer = graphic.canvasRenderer;
			canvasRenderer.hasPopInstruction = false;
			canvasRenderer.popMaterialCount = 0;
			SetDirty ();
		}

		/// <summary>
		/// LateUpdate is called every frame, if the Behaviour is enabled.
		/// </summary>
		void LateUpdate()
		{
			#if UNITY_EDITOR
			if (m_FitTarget && (m_FitOnLateUpdate || !Application.isPlaying))
			#else
			if (m_FitTarget && m_FitOnLateUpdate)
			#endif
			{
				FitTo(m_FitTarget);
			}
		}

		/// <summary>
		/// This function is called when the script is loaded or a value is changed in the inspector (Called in the editor only).
		/// </summary>
		void OnValidate()
		{
			SetDirty();
		}

		/// <summary>
		/// Mark the graphic as dirty.
		/// </summary>
		void SetDirty()
		{
			if (graphic)
			{
				graphic.SetMaterialDirty();
			}
		}
	}
}