AppExperiments

/******************************************************************************
 * Copyright (C) Leap Motion, Inc. 2011-2018.                                 *
 * Leap Motion proprietary and confidential.                                  *
 *                                                                            *
 * Use subject to the terms of the Leap Motion SDK Agreement available at     *
 * https://developer.leapmotion.com/sdk_agreement, or another agreement       *
 * between Leap Motion and you, your company or other organization.           *
 ******************************************************************************/

using System;
using System.Collections.Generic;
using UnityEngine;
using UnityEngine.Assertions;
#if UNITY_EDITOR
using UnityEditor;
#endif
using Leap.Unity.Space;

namespace Leap.Unity.GraphicalRenderer {

  public partial class LeapGraphicRenderer : MonoBehaviour {

    //Need to keep this outside of the #if guards or else Unity will throw a fit
    //about the serialized format changing between editor and build
    [SerializeField]
#pragma warning disable 0414
    private int _selectedGroup = 0;
#pragma warning restore 0414

#if UNITY_EDITOR
    public readonly EditorApi editor;

    [ContextMenu("Show all hidden objects (INTERNAL)")]
    private void showAllHiddenObjects() {
      foreach (var obj in FindObjectsOfType<UnityEngine.Object>()) {
        obj.hideFlags = HideFlags.None;
      }
    }

    public class EditorApi {
      private LeapGraphicRenderer _renderer;

      [NonSerialized]
      private Hash _previousHierarchyHash;

      public EditorApi(LeapGraphicRenderer renderer) {
        _renderer = renderer;
        InternalUtility.OnAnySave += onAnySave;
      }

      public void OnValidate() {
        Assert.IsFalse(InternalUtility.IsPrefab(_renderer), "Should never run editor validation on a prefab");

        for (int i = _renderer._groups.Count; i-- > 0;) {
          if (_renderer._groups[i] == null) {
            _renderer._groups.RemoveAt(i);
          }
        }

        _renderer.validateSpaceComponent();

        foreach (var group in _renderer._groups) {
          group.editor.OnValidate();
        }
      }

      public void OnDestroy() {
        InternalUtility.OnAnySave -= onAnySave;

        foreach (var group in _renderer._groups) {
          group.editor.OnDestroy();
        }
      }

      /// <summary>
      /// Creates a new group for this graphic renderer, and assigns it the
      /// given rendering method.  This is an editor only api, as creating new
      /// groups cannot be done at runtime.
      /// </summary>
      public void CreateGroup(Type rendererType) {
        AssertHelper.AssertEditorOnly();
        Assert.IsNotNull(rendererType);

        var group = new LeapGraphicGroup(_renderer, rendererType);

        _renderer._selectedGroup = _renderer._groups.Count;
        _renderer._groups.Add(group);
      }

      /// <summary>
      /// Destroys the currently selected group.  This is an editor-only api,
      /// as destroying groups cannot be done at runtime.
      /// </summary>
      public void DestroySelectedGroup() {
        AssertHelper.AssertEditorOnly();

        var toDestroy = _renderer._groups[_renderer._selectedGroup];
        _renderer._groups.RemoveAt(_renderer._selectedGroup);

        toDestroy.editor.OnDestroy();

        if (_renderer._selectedGroup >= _renderer._groups.Count && _renderer._selectedGroup != 0) {
          _renderer._selectedGroup--;
        }
      }

      /// <summary>
      /// Returns the rendering method of the currently selected group.  This
      /// is an editor-only api, as the notion of selection does not exist at
      /// runtime.
      /// </summary>
      public LeapRenderingMethod GetSelectedRenderingMethod() {
        return _renderer._groups[_renderer._selectedGroup].renderingMethod;
      }

      /// <summary>
      /// Schedules a full editor rebuild of all graphic groups and their representations.
      /// This method only schedules the rebuild, it does not actually execute it.  The
      /// rebuild will happen on during the next editor tick.
      /// 
      /// This is an editor-only api.  During runtime rebuilding is handled automatically,
      /// and full rebuilds do not occur.
      /// </summary>
      public void ScheduleRebuild() {
        AssertHelper.AssertEditorOnly();

        //Dirty the hash by changing it to something else
        _previousHierarchyHash++;
      }

      /// <summary>
      /// Force a rebuild of all editor picking meshes for all graphics attached to all
      /// groups.  Editor picking meshes are what allow graphics to be accurately picked
      /// in the scene view even if they are in a curved space.
      /// </summary>
      public void RebuildEditorPickingMeshes() {
        //No picking meshes for prefabs
        if (InternalUtility.IsPrefab(_renderer)) {
          return;
        }

        if (!Application.isPlaying) {
          if (_renderer._space != null) {
            _renderer._space.RebuildHierarchy();
            _renderer._space.RecalculateTransformers();
          }

          validateGraphics();

          foreach (var group in _renderer._groups) {
            group.editor.ValidateGraphicList();
            group.RebuildFeatureData();
            group.RebuildFeatureSupportInfo();
            group.editor.RebuildEditorPickingMeshes();
          }
        }

        foreach (var group in _renderer._groups) {
          group.editor.RebuildEditorPickingMeshes();
        }
      }

      /// <summary>
      /// Changes the rendering method of the selected group.  This method is just
      /// a helpful wrapper around the ChangeRenderingMethod of the LeapGraphicGroup class.
      /// </summary>
      public void ChangeRenderingMethodOfSelectedGroup(Type renderingMethod, bool addFeatures) {
        _renderer._groups[_renderer._selectedGroup].editor.ChangeRenderingMethod(renderingMethod, addFeatures);
      }

      /// <summary>
      /// Adds a feature to the currently selected group.  This method is just 
      /// a helpful wrapper around the AddFeature method of the LeapGraphicGroup class.
      /// </summary>
      public void AddFeatureToSelectedGroup(Type featureType) {
        _renderer._groups[_renderer._selectedGroup].editor.AddFeature(featureType);
      }

      /// <summary>
      /// Removes a feature from the currently selected group.  This method is just
      /// a helpful wrapper around the RemoveFeature method of the LeapGraphicGroup class.
      /// </summary>
      public void RemoveFeatureFromSelectedGroup(int featureIndex) {
        _renderer._groups[_renderer._selectedGroup].editor.RemoveFeature(featureIndex);
      }

      public void DoLateUpdateEditor() {
        Undo.RecordObject(_renderer, "Update graphic renderer.");
        Assert.IsFalse(InternalUtility.IsPrefab(_renderer), "Should never do editor updates for prefabs");

        _renderer.validateSpaceComponent();

        bool needsRebuild = false;

        using (new ProfilerSample("Calculate Should Rebuild")) {
          foreach (var group in _renderer._groups) {
#if UNITY_EDITOR
            if (!Application.isPlaying) {
              group.editor.ValidateGraphicList();
            }
#endif

            foreach (var graphic in group.graphics) {
              if (graphic.isRepresentationDirty) {
                needsRebuild = true;
                break;
              }
            }

            foreach (var feature in group.features) {
              if (feature.isDirty) {
                needsRebuild = true;
                break;
              }
            }
          }

          Hash hierarchyHash = Hash.GetHierarchyHash(_renderer.transform);

          if (_renderer._space != null) {
            hierarchyHash.Add(_renderer._space.GetSettingHash());
          }

          if (_previousHierarchyHash != hierarchyHash) {
            _previousHierarchyHash = hierarchyHash;
            needsRebuild = true;
          }
        }

        DoEditorUpdateLogic(needsRebuild);
      }

      public void DoEditorUpdateLogic(bool fullRebuild) {
        Undo.RecordObject(_renderer, "Do Editor Update Logic");

        Assert.IsFalse(InternalUtility.IsPrefab(_renderer), "Should never do editor updates for prefabs");

        using (new ProfilerSample("Validate Space Component")) {
          _renderer.validateSpaceComponent();
        }

        if (fullRebuild) {
          if (_renderer._space != null) {
            using (new ProfilerSample("Rebuild Space")) {
              _renderer._space.RebuildHierarchy();
              _renderer._space.RecalculateTransformers();
            }
          }

          using (new ProfilerSample("Validate graphics")) {
            validateGraphics();
          }

          foreach (var group in _renderer._groups) {
            using (new ProfilerSample("Validate Graphic List")) {
              group.editor.ValidateGraphicList();
            }

            using (new ProfilerSample("Rebuild Feature Data")) {
              group.RebuildFeatureData();
            }

            using (new ProfilerSample("Rebuild Feature Support Info")) {
              group.RebuildFeatureSupportInfo();
            }

            using (new ProfilerSample("Update Renderer Editor")) {
              group.editor.UpdateRendererEditor();
            }
          }
        }

        using (new ProfilerSample("Update Renderer")) {
          foreach (var group in _renderer._groups) {
            group.UpdateRenderer();
          }
        }

        Undo.CollapseUndoOperations(Undo.GetCurrentGroup());
      }

      private void onAnySave() {
        if (_renderer == null || InternalUtility.IsPrefab(_renderer)) {
          InternalUtility.OnAnySave -= onAnySave;
          return;
        }

        DoEditorUpdateLogic(fullRebuild: true);
      }

      [NonSerialized]
      private List<LeapGraphic> _tempGraphicList = new List<LeapGraphic>();
      private void validateGraphics() {
        Assert.IsFalse(InternalUtility.IsPrefab(_renderer), "Should never validate graphics for prefabs");

        _renderer.GetComponentsInChildren(includeInactive: true, result: _tempGraphicList);

        HashSet<LeapGraphic> graphicsInGroup = Pool<HashSet<LeapGraphic>>.Spawn();
        try {
          foreach (var group in _renderer._groups) {

            for (int i = group.graphics.Count; i-- != 0;) {
              if (group.graphics[i] == null) {
                group.graphics.RemoveAt(i);
              } else {
                graphicsInGroup.Add(group.graphics[i]);
              }
            }

            foreach (var graphic in _tempGraphicList) {
              if (graphic.isAttachedToGroup) {
                //If the graphic claims it is attached to this group, but it really isn't, remove
                //it and re-add it.
                bool graphicThinksItsInGroup = graphic.attachedGroup == group;
                bool isActuallyInGroup = graphicsInGroup.Contains(graphic);

                //Also re add it if it is attached to a completely different renderer!
                if (graphicThinksItsInGroup != isActuallyInGroup ||
                    graphic.attachedGroup.renderer != _renderer) {
                  if (!group.TryRemoveGraphic(graphic)) {
                    //If we fail, detach using force!!
                    graphic.OnDetachedFromGroup();
                  }

                  group.TryAddGraphic(graphic);
                }
              }
            }

            graphicsInGroup.Clear();
          }
        } finally {
          graphicsInGroup.Clear();
          Pool<HashSet<LeapGraphic>>.Recycle(graphicsInGroup);
        }

        foreach (var graphic in _tempGraphicList) {
          if (graphic.isAttachedToGroup) {
            //procede to validate

            //If the graphic is anchored to the wrong anchor, detach and reattach
            var anchor = _renderer._space == null ? null : LeapSpaceAnchor.GetAnchor(graphic.transform);
            if (graphic.anchor != anchor) {
              var group = graphic.attachedGroup;

              if (group.TryRemoveGraphic(graphic)) {
                group.TryAddGraphic(graphic);
              }
            }
          }
        }
      }
    }
#endif
  }
}