Dialog.cs

Go to the documentation of this file.

// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License. See LICENSE in the project root for license information.

using HoloToolkit.Unity.Receivers;
using System;
using System.Collections;
using UnityEngine;

namespace HoloToolkit.UX.Dialog
{
    public abstract class Dialog : InteractionReceiver
    {
        [SerializeField]
        protected Transform buttonParent;

        protected DialogResult result;

        protected DialogState state = DialogState.Uninitialized;
        public DialogState State
        {
            get
            {
                return state;
            }
            set
            {
                state = value;
            }
        }

        public Action<DialogResult> OnClosed;

        public DialogResult Result
        {
            get
            {
                return result;
            }
        }

        protected void Launch(DialogResult newResult)
        {
            if (State != DialogState.Uninitialized)
            {
                return;
            }

            result = newResult;
            StartCoroutine(RunDialogOverTime());
        }

        protected IEnumerator RunDialogOverTime()
        {  
            // Create our buttons and set up our message
            GenerateButtons();
            SetTitleAndMessage();
            FinalizeLayout();

            // Open dialog
            State = DialogState.Opening;
            yield return StartCoroutine(OpenDialog());
            State = DialogState.WaitingForInput;
            // Wait for input
            while (State == DialogState.WaitingForInput)
            {
                UpdateDialog();
                yield return null;
            }
            // Close dialog
            State = DialogState.Closing;
            yield return StartCoroutine(CloseDialog());
            State = DialogState.Closed;
            // Callback
            if (OnClosed != null)
            {
                OnClosed(result);
            }
            // Wait a moment to give scripts a chance to respond
            yield return null;
            // Destroy ourselves
            GameObject.Destroy(gameObject);
            yield break;
        }

        protected virtual IEnumerator OpenDialog()
        {
            yield break;
        }

        protected virtual IEnumerator CloseDialog()
        {
            yield break;
        }

        protected virtual void UpdateDialog()
        {
            return;
        }

        protected abstract void GenerateButtons();

        protected abstract void FinalizeLayout();

        protected abstract void SetTitleAndMessage();

        public static Dialog Open(GameObject dialogPrefab, DialogResult result)
        {
            GameObject dialogGo = GameObject.Instantiate(dialogPrefab) as GameObject;
            Dialog dialog = dialogGo.GetComponent<Dialog>();

            dialog.Launch(result);
            return dialog;
        }

        public static Dialog Open(GameObject dialogPrefab, DialogButtonType buttons, string title, string message)
        {
            GameObject dialogGameObject = GameObject.Instantiate(dialogPrefab) as GameObject;
            Dialog dialog = dialogGameObject.GetComponent<Dialog>();

            DialogResult result = new DialogResult
            {
                Buttons = buttons,
                Title = title,
                Message = message
            };
            
            dialog.Launch(result);
            return dialog;
        }
    }
}