Class Cutout

Script that mostly sets the attached RectTransform over a certain area or another RectTranform. Used with a special material and CutoutMaskee for make a cutout.

Inheritance

System.Object

UnityEngine.Object

UnityEngine.Component

UnityEngine.Behaviour

UnityEngine.MonoBehaviour

UnityEngine.EventSystems.UIBehaviour

Cutout

Inherited Members

UnityEngine.EventSystems.UIBehaviour.Awake()

UnityEngine.EventSystems.UIBehaviour.OnEnable()

UnityEngine.EventSystems.UIBehaviour.Start()

UnityEngine.EventSystems.UIBehaviour.OnDisable()

UnityEngine.EventSystems.UIBehaviour.OnDestroy()

UnityEngine.EventSystems.UIBehaviour.IsActive()

UnityEngine.EventSystems.UIBehaviour.OnValidate()

UnityEngine.EventSystems.UIBehaviour.Reset()

UnityEngine.EventSystems.UIBehaviour.OnRectTransformDimensionsChange()

UnityEngine.EventSystems.UIBehaviour.OnBeforeTransformParentChanged()

UnityEngine.EventSystems.UIBehaviour.OnTransformParentChanged()

UnityEngine.EventSystems.UIBehaviour.OnDidApplyAnimationProperties()

UnityEngine.EventSystems.UIBehaviour.OnCanvasGroupChanged()

UnityEngine.EventSystems.UIBehaviour.OnCanvasHierarchyChanged()

UnityEngine.EventSystems.UIBehaviour.IsDestroyed()

UnityEngine.MonoBehaviour.IsInvoking()

UnityEngine.MonoBehaviour.CancelInvoke()

UnityEngine.MonoBehaviour.Invoke(System.String, System.Single)

UnityEngine.MonoBehaviour.InvokeRepeating(System.String, System.Single, System.Single)

UnityEngine.MonoBehaviour.CancelInvoke(System.String)

UnityEngine.MonoBehaviour.IsInvoking(System.String)

UnityEngine.MonoBehaviour.StartCoroutine(System.String)

UnityEngine.MonoBehaviour.StartCoroutine(System.String, System.Object)

UnityEngine.MonoBehaviour.StartCoroutine(System.Collections.IEnumerator)

UnityEngine.MonoBehaviour.StartCoroutine_Auto(System.Collections.IEnumerator)

UnityEngine.MonoBehaviour.StopCoroutine(System.Collections.IEnumerator)

UnityEngine.MonoBehaviour.StopCoroutine(UnityEngine.Coroutine)

UnityEngine.MonoBehaviour.StopCoroutine(System.String)

UnityEngine.MonoBehaviour.StopAllCoroutines()

UnityEngine.MonoBehaviour.print(System.Object)

UnityEngine.MonoBehaviour.useGUILayout

UnityEngine.MonoBehaviour.runInEditMode

UnityEngine.Behaviour.enabled

UnityEngine.Behaviour.isActiveAndEnabled

UnityEngine.Component.GetComponent(System.Type)

UnityEngine.Component.GetComponent<T>()

UnityEngine.Component.TryGetComponent(System.Type, UnityEngine.Component)

UnityEngine.Component.TryGetComponent<T>(T)

UnityEngine.Component.GetComponent(System.String)

UnityEngine.Component.GetComponentInChildren(System.Type, System.Boolean)

UnityEngine.Component.GetComponentInChildren(System.Type)

UnityEngine.Component.GetComponentInChildren<T>(System.Boolean)

UnityEngine.Component.GetComponentInChildren<T>()

UnityEngine.Component.GetComponentsInChildren(System.Type, System.Boolean)

UnityEngine.Component.GetComponentsInChildren(System.Type)

UnityEngine.Component.GetComponentsInChildren<T>(System.Boolean)

UnityEngine.Component.GetComponentsInChildren<T>(System.Boolean, System.Collections.Generic.List<T>)

UnityEngine.Component.GetComponentsInChildren<T>()

UnityEngine.Component.GetComponentsInChildren<T>(System.Collections.Generic.List<T>)

UnityEngine.Component.GetComponentInParent(System.Type)

UnityEngine.Component.GetComponentInParent<T>()

UnityEngine.Component.GetComponentsInParent(System.Type, System.Boolean)

UnityEngine.Component.GetComponentsInParent(System.Type)

UnityEngine.Component.GetComponentsInParent<T>(System.Boolean)

UnityEngine.Component.GetComponentsInParent<T>(System.Boolean, System.Collections.Generic.List<T>)

UnityEngine.Component.GetComponentsInParent<T>()

UnityEngine.Component.GetComponents(System.Type)

UnityEngine.Component.GetComponents(System.Type, System.Collections.Generic.List<UnityEngine.Component>)

UnityEngine.Component.GetComponents<T>(System.Collections.Generic.List<T>)

UnityEngine.Component.GetComponents<T>()

UnityEngine.Component.CompareTag(System.String)

UnityEngine.Component.SendMessageUpwards(System.String, System.Object, UnityEngine.SendMessageOptions)

UnityEngine.Component.SendMessageUpwards(System.String, System.Object)

UnityEngine.Component.SendMessageUpwards(System.String)

UnityEngine.Component.SendMessageUpwards(System.String, UnityEngine.SendMessageOptions)

UnityEngine.Component.SendMessage(System.String, System.Object)

UnityEngine.Component.SendMessage(System.String)

UnityEngine.Component.SendMessage(System.String, System.Object, UnityEngine.SendMessageOptions)

UnityEngine.Component.SendMessage(System.String, UnityEngine.SendMessageOptions)

UnityEngine.Component.BroadcastMessage(System.String, System.Object, UnityEngine.SendMessageOptions)

UnityEngine.Component.BroadcastMessage(System.String, System.Object)

UnityEngine.Component.BroadcastMessage(System.String)

UnityEngine.Component.BroadcastMessage(System.String, UnityEngine.SendMessageOptions)

UnityEngine.Component.transform

UnityEngine.Component.gameObject

UnityEngine.Component.tag

UnityEngine.Object.GetInstanceID()

UnityEngine.Object.GetHashCode()

UnityEngine.Object.Equals(System.Object)

UnityEngine.Object.Instantiate(UnityEngine.Object, UnityEngine.Vector3, UnityEngine.Quaternion)

UnityEngine.Object.Instantiate(UnityEngine.Object, UnityEngine.Vector3, UnityEngine.Quaternion, UnityEngine.Transform)

UnityEngine.Object.Instantiate(UnityEngine.Object)

UnityEngine.Object.Instantiate(UnityEngine.Object, UnityEngine.Transform)

UnityEngine.Object.Instantiate(UnityEngine.Object, UnityEngine.Transform, System.Boolean)

UnityEngine.Object.Instantiate<T>(T)

UnityEngine.Object.Instantiate<T>(T, UnityEngine.Vector3, UnityEngine.Quaternion)

UnityEngine.Object.Instantiate<T>(T, UnityEngine.Vector3, UnityEngine.Quaternion, UnityEngine.Transform)

UnityEngine.Object.Instantiate<T>(T, UnityEngine.Transform)

UnityEngine.Object.Instantiate<T>(T, UnityEngine.Transform, System.Boolean)

UnityEngine.Object.Destroy(UnityEngine.Object, System.Single)

UnityEngine.Object.Destroy(UnityEngine.Object)

UnityEngine.Object.DestroyImmediate(UnityEngine.Object, System.Boolean)

UnityEngine.Object.DestroyImmediate(UnityEngine.Object)

UnityEngine.Object.FindObjectsOfType(System.Type)

UnityEngine.Object.FindObjectsOfType(System.Type, System.Boolean)

UnityEngine.Object.DontDestroyOnLoad(UnityEngine.Object)

UnityEngine.Object.DestroyObject(UnityEngine.Object, System.Single)

UnityEngine.Object.DestroyObject(UnityEngine.Object)

UnityEngine.Object.FindSceneObjectsOfType(System.Type)

UnityEngine.Object.FindObjectsOfTypeIncludingAssets(System.Type)

UnityEngine.Object.FindObjectsOfType<T>()

UnityEngine.Object.FindObjectsOfType<T>(System.Boolean)

UnityEngine.Object.FindObjectOfType<T>()

UnityEngine.Object.FindObjectOfType<T>(System.Boolean)

UnityEngine.Object.FindObjectsOfTypeAll(System.Type)

UnityEngine.Object.FindObjectOfType(System.Type)

UnityEngine.Object.FindObjectOfType(System.Type, System.Boolean)

UnityEngine.Object.ToString()

UnityEngine.Object.name

UnityEngine.Object.hideFlags

System.Object.Equals(System.Object, System.Object)

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

Namespace: GDA

Assembly: Assembly-CSharp.dll

Syntax

[RequireComponent(typeof(RectTransform))]
public class Cutout : UIBehaviour

Fields

hasPadding

Declaration

public bool hasPadding

Field Value

Type	Description
System.Boolean

Properties

rectTransform

Declaration

public RectTransform rectTransform { get; }

Property Value

Type	Description
UnityEngine.RectTransform

Methods

HighlightArea(Vector2, Vector2, String, Boolean)

Sets the RectTransform attached to the gameobject to encompass a specifc area.

Declaration

public void HighlightArea(Vector2 min, Vector2 max, string label, bool padding = true)

Parameters

Type	Name	Description
UnityEngine.Vector2	min	bottom left corner of the area in world coordinates
UnityEngine.Vector2	max	upper right corner of the area in world coordinates
System.String	label	The label to be displayed with the cutout
System.Boolean	padding	Whether to add padding to the Cutout

Initialize()

Declaration

public void Initialize()

SetLabel(String)

Declaration

public void SetLabel(string str = "")

Parameters

Type	Name	Description
System.String	str

SetOutlineVisibility(Boolean)

Declaration

public void SetOutlineVisibility(bool isVisible)

Parameters

Type	Name	Description
System.Boolean	isVisible

SetRectToHighlight(RectTransform, String)

Sets the GDA.Cutout.highlightedRectTrans for the Cutout to encompass and highlight.

Declaration

public void SetRectToHighlight(RectTransform rectToHighlight, string label = "")

Parameters

Type	Name	Description
UnityEngine.RectTransform	rectToHighlight
System.String	label	The label to be displayed with the cutout

ShowLabelOnly(Vector2, String)

Show a lable at a specific location, without a Cutout

Declaration

public void ShowLabelOnly(Vector2 pos, string label)

Parameters

Type	Name	Description
UnityEngine.Vector2	pos
System.String	label