mattercontrol/PartPreviewWindow/Object3DTreeBuilder.cs

/*
Copyright (c) 2018, Lars Brubaker, John Lewin
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this
   list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice,
   this list of conditions and the following disclaimer in the documentation
   and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

The views and conclusions contained in the software and documentation are those
of the authors and should not be interpreted as representing official policies,
either expressed or implied, of the FreeBSD Project.
*/

using System;
using System.Collections.Generic;
using System.Linq;
using System.Threading.Tasks;
using MatterHackers.Agg.UI;
using MatterHackers.DataConverters3D;
using MatterHackers.Localizations;
using MatterHackers.MatterControl.CustomWidgets;
using MatterHackers.MatterControl.DesignTools.Operations;
using MatterHackers.MatterControl.Library;
using MatterHackers.MatterControl.PartPreviewWindow.View3D;

namespace MatterHackers.MatterControl.PartPreviewWindow
{
	public static class Object3DTreeBuilder
	{
		public static TreeNode BuildTree(IObject3D rootItem, ThemeConfig theme)
		{
			return AddTree(BuildItemView(rootItem), null, theme);
		}

		private static TreeNode AddTree(ObjectView item, TreeNode parent, ThemeConfig theme)
		{
			// Suppress MeshWrapper and OperationSource nodes in tree
			bool shouldCollapseToParent = item.Source is MeshWrapper || item.Source is OperationSource;
			var contextNode = (shouldCollapseToParent && parent != null) ? parent : AddItem(item, parent, theme);

			contextNode.SuspendLayout();

			if (!(item.Source is IVisualLeafNode))
			{
				foreach (var child in item.Children)
				{
					AddTree(BuildItemView(child), contextNode, theme);
				}
			}

			contextNode.ResumeLayout();

			return contextNode;
		}

		private static TreeNode AddItem(ObjectView item, TreeNode parentNode, ThemeConfig theme)
		{
			if(item.Source is InsertionGroup insertionGroup)
			{
				return new TreeNode()
				{
					Text = "Loading".Localize(),
					Tag = item.Source,
					TextColor = theme.Colors.PrimaryTextColor,
					PointSize = theme.DefaultFontSize,
				};
			}

			var node = new TreeNode()
			{
				Text = GetName(item),
				Tag = item.Source,
				TextColor = theme.Colors.PrimaryTextColor,
				PointSize = theme.DefaultFontSize,
			};

			// Check for operation resulting in the given type
			if (ApplicationController.Instance.OperationsByType.TryGetValue(item.Source.GetType(), out SceneSelectionOperation operation))
			{
				// If exists, use the operation icon
				node.Image = operation.Icon;
			}
			else
			{
				node.Load += (s, e) =>
				{
					ApplicationController.Instance.QueueForGeneration(() =>
					{
						// When this widget is dequeued for generation, validate before processing. Off-screen widgets should be skipped and will requeue next time they become visible
						if (node.ActuallyVisibleOnScreen()
							&& ApplicationController.Instance.Library.ContentProviders.TryGetValue("mcx", out IContentProvider contentProvider)
							&& contentProvider is MeshContentProvider meshContentProvider)
						{
							node.Image = meshContentProvider.GetThumbnail(
								item.Source,
								item.Source.MeshRenderId().ToString(),
								16,
								16,
								true);
						}

						return Task.CompletedTask;
					});
				};
			}

			if (parentNode != null)
			{
				parentNode.Nodes.Add(node);
				parentNode.Expanded = true;
			}

			return node;
		}

		private static string GetName(ObjectView item)
		{
			return !string.IsNullOrEmpty(item.Name) ? $"{item.Name}" : $"{item.GetType().Name}";
		}

		private static ObjectView BuildItemView(IObject3D item)
		{
			switch (item)
			{
				case ArrayLinear3D arrayLinear3D:
					return new ObjectView()
					{
						Children = item.Children.OfType<OperationSource>().ToList(),
						Name = $"{arrayLinear3D.Name} ({arrayLinear3D.Count})",
						Source = item
					};

				// TODO: array operations should only expose OperationSource
				case ArrayAdvanced3D arrayAdvanced3D:
					return new ObjectView()
					{
						Children = item.Children.Take(1),
						Name = $"{arrayAdvanced3D.Name} ({arrayAdvanced3D.Count})",
						Source = item
					};

				// TODO: array operations should only expose OperationSource
				case ArrayRadial3D arrayRadial3D:
					return new ObjectView()
					{
						Children = item.Children.Take(1),
						Name = $"{arrayRadial3D.Name} ({arrayRadial3D.Count})",
						Source = item
					};

				default:
					return new ObjectView(item);
			}
		}

		private class ObjectView
		{
			public ObjectView()
			{
			}

			public ObjectView(IObject3D source)
			{
				this.Source = source;
				this.Children = this.Source.Children;
				this.Name = this.Source.Name;
			}

			public IEnumerable<IObject3D> Children { get; set; }

			public string Name { get; set; }

			public IObject3D Source { get; set; }
		}
	}
}