Class DocMiniUI
DocumentUI that represents the mini-view of a document.
Inheritance
Implements
Inherited Members
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 |
Overrides
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 |
Overrides
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 |
Overrides
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 |
Overrides
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 |
Overrides
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 |
Overrides
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()