Show / Hide Table of Contents

Class DocMiniUI

DocumentUI that represents the mini-view of a document.

Inheritance
System.Object
UnityEngine.Object
UnityEngine.Component
UnityEngine.Behaviour
UnityEngine.MonoBehaviour
DocumentUI
DocMiniUI
Implements
UnityEngine.EventSystems.IPointerDownHandler
UnityEngine.EventSystems.IPointerUpHandler
UnityEngine.EventSystems.IPointerClickHandler
UnityEngine.EventSystems.IDragHandler
UnityEngine.EventSystems.IEndDragHandler
UnityEngine.EventSystems.IBeginDragHandler
UnityEngine.EventSystems.IEventSystemHandler
Inherited Members
DocumentUI.rectTransform
DocumentUI.canvasGrp
DocumentUI.parentRectTransform
DocumentUI.isVisible
DocumentUI.document
DocumentUI.SetVisible(Boolean)
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.GameDocuments.UI
Assembly: Assembly-CSharp.dll
Syntax
public class DocMiniUI : DocumentUI, IPointerDownHandler, IPointerUpHandler, IPointerClickHandler, IDragHandler, IEndDragHandler, IBeginDragHandler, IEventSystemHandler

Properties

isKeeping

Whether the document is mid-animation of being stowed away.

Declaration
public bool isKeeping { get; }
Property Value
Type Description
System.Boolean

Methods

OnBeginDrag(PointerEventData)

Implementation of the IBeginDragHandler interface. Does not actually execute anything apart from calling OnBeginDrag(PointerEventData, DocumentUI) of its related Document.

Declaration
public override void OnBeginDrag(PointerEventData eventData)
Parameters
Type Name Description
UnityEngine.EventSystems.PointerEventData eventData

PointerEventData from the BeginDrag Event.

Overrides
DocumentUI.OnBeginDrag(PointerEventData)

OnDrag(PointerEventData)

Implementation of the IDragHandler interface. Does not actually execute anything apart from calling OnDrag(PointerEventData, DocumentUI) of its related Document.

Declaration
public override void OnDrag(PointerEventData eventData)
Parameters
Type Name Description
UnityEngine.EventSystems.PointerEventData eventData

PointerEventData from the BeginDrag Event.

Overrides
DocumentUI.OnDrag(PointerEventData)

OnEndDrag(PointerEventData)

Implementation of the IEndDragHandler interface. Does not actually execute anything apart from calling OnEndDrag(PointerEventData, DocumentUI) of its related Document.

Declaration
public override void OnEndDrag(PointerEventData eventData)
Parameters
Type Name Description
UnityEngine.EventSystems.PointerEventData eventData

PointerEventData from the BeginDrag Event.

Overrides
DocumentUI.OnEndDrag(PointerEventData)

OnKeep()

Triggers the stow-away animation of the UI element.

Declaration
public void OnKeep()

OnPointerClick(PointerEventData)

Implementation of the IPointerClickHandler interface. Does not actually execute anything apart from calling OnPointerClick(PointerEventData, DocumentUI) of its related Document.

Declaration
public override void OnPointerClick(PointerEventData eventData)
Parameters
Type Name Description
UnityEngine.EventSystems.PointerEventData eventData

PointerEventData from the BeginDrag Event.

Overrides
DocumentUI.OnPointerClick(PointerEventData)

OnPointerDown(PointerEventData)

Implementation of the IPointerDownHandler interface. Does not actually execute anything apart from calling OnPointerDown(PointerEventData, DocumentUI) of its related Document.

Declaration
public override void OnPointerDown(PointerEventData eventData)
Parameters
Type Name Description
UnityEngine.EventSystems.PointerEventData eventData

PointerEventData from the BeginDrag Event.

Overrides
DocumentUI.OnPointerDown(PointerEventData)

OnPointerUp(PointerEventData)

Implementation of the IPointerUpHandler interface. Does not actually execute anything apart from calling OnPointerUp(PointerEventData, DocumentUI) of its related Document.

Declaration
public override void OnPointerUp(PointerEventData eventData)
Parameters
Type Name Description
UnityEngine.EventSystems.PointerEventData eventData

PointerEventData from the BeginDrag Event.

Overrides
DocumentUI.OnPointerUp(PointerEventData)

OnSubmit()

Triggers the fade out animation of the UI element.

Declaration
public void OnSubmit()

OnSubmitAnimationFinish()

Deactivates the UI element after it has finished the fade out animation.

Declaration
public void OnSubmitAnimationFinish()

OnTable()

Triggers the fade in animation of the UI element.

Declaration
public void OnTable()

SetDocument(Document)

Links the mini-view representation to a Document. Used in Initialize(DocMiniUI, DocFullUI).

Declaration
public void SetDocument(Document doc)
Parameters
Type Name Description
Document doc

Document that the UI element is meant to represent.

StopFall()

Stops the Falling animation of the UI animation

Declaration
public void StopFall()

TriggerFall()

Triggers the Falling animation of the UI element.

Declaration
public void TriggerFall()

Implements

UnityEngine.EventSystems.IPointerDownHandler
UnityEngine.EventSystems.IPointerUpHandler
UnityEngine.EventSystems.IPointerClickHandler
UnityEngine.EventSystems.IDragHandler
UnityEngine.EventSystems.IEndDragHandler
UnityEngine.EventSystems.IBeginDragHandler
UnityEngine.EventSystems.IEventSystemHandler
In This Article
Back to top Generated by DocFX