mattercontrol/Library/ContentProviders/MeshContentProvider.cs

/*
Copyright (c) 2017, 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.Threading.Tasks;

namespace MatterHackers.MatterControl
{
	using System;
	using System.IO;
	using System.Threading;
	using MatterHackers.Agg;
	using MatterHackers.Agg.Image;
	using MatterHackers.Agg.Platform;
	using MatterHackers.DataConverters3D;
	using MatterHackers.MatterControl.Library;
	using MatterHackers.RayTracer;

	/// <summary>
	/// Loads IObject3D objects for mesh based ILibraryItems
	/// </summary>
	public class MeshContentProvider : ISceneContentProvider
	{
		private const int tooBigAndroid = 50000000;
		private const int tooBigDesktop = 250000000;

		private static readonly bool Is32Bit = IntPtr.Size == 4;
		private static readonly int MaxFileSize = (AggContext.OperatingSystem == OSType.Android) ? tooBigAndroid : tooBigDesktop;
		private static readonly Point2D BigRenderSize = new Point2D(460, 460);

		public Task<IObject3D> CreateItem(ILibraryItem item, Action<double, string> progressReporter)
		{
			return Task.Run(async () =>
			{
				IObject3D loadedItem = null;

				try
				{
					var streamInterface = item as ILibraryContentStream;
					if (streamInterface != null)
					{
						using (var contentStream = await streamInterface.GetContentStream(progressReporter))
						{
							if (contentStream != null)
							{
								// TODO: Wire up caching
								loadedItem = Object3D.Load(contentStream.Stream, Path.GetExtension(streamInterface.FileName), CancellationToken.None, null /*itemCache*/, progressReporter);
							}
						}
					}
					else
					{
						var contentInterface = item as ILibraryContentItem;
						loadedItem = await contentInterface?.GetContent(progressReporter);
					}
				}
				catch { }

				if (loadedItem != null)
				{
					// Push the original Library item name through to the IObject3D
					loadedItem.Name = item.Name;
				}

				// Notification should force invalidate and redraw
				progressReporter?.Invoke(1, "");

				return loadedItem;
			});
		}

		// TODO: Trying out an 8 MB mesh max for thumbnail generation
		long MaxFileSizeForTracing = 8 * 1000 * 1000;

		public async Task GetThumbnail(ILibraryItem item, int width, int height, Action<ImageBuffer> imageCallback)
		{
			IObject3D object3D = null;

			if (item is ILibraryContentStream contentModel
				// Only load the stream if it's available - prevents download of internet content simply for thumbnails
				&& contentModel.LocalContentExists
				&& (!Is32Bit || contentModel.FileSize < MaxFileSizeForTracing))
			{
				// TODO: Wire up limits for thumbnail generation. If content is too big, return null allowing the thumbnail to fall back to content default
				object3D = await contentModel.CreateContent();
			}
			else if (item is ILibraryContentItem)
			{
				object3D = await (item as ILibraryContentItem)?.GetContent(null);
			}

			if (object3D != null)
			{
				bool RenderOrthographic = UserSettings.Instance.get(UserSettingsKey.ThumbnailRenderingMode) == "orthographic";

				var thumbnail = ThumbnailEngine.Generate(
					object3D,
					RenderOrthographic ? RenderType.ORTHOGROPHIC : RenderType.RAY_TRACE,
					BigRenderSize.x, 
					BigRenderSize.y, 
					allowMultiThreading: !ApplicationController.Instance.ActivePrinter.Connection.PrinterIsPrinting);

				if (thumbnail != null)
				{
					// Cache big render
					string cachePath = ApplicationController.Instance.ThumbnailCachePath(item);
					AggContext.ImageIO.SaveImageData(cachePath, thumbnail);

					// Cache at requested size
					cachePath = ApplicationController.Instance.ThumbnailCachePath(item, width, height);
					thumbnail = LibraryProviderHelpers.ResizeImage(thumbnail, width, height);
					AggContext.ImageIO.SaveImageData(cachePath, thumbnail);

					if (ApplicationController.Instance.Library.ActiveContainer is ILibraryWritableContainer writableContainer)
					{
						writableContainer.SetThumbnail(item, thumbnail.Width, thumbnail.Height, thumbnail);
					}

					imageCallback(thumbnail);
				}
				else
				{
					// If thumbnail generation was aborted or failed, return the default icon for this content type
					imageCallback(DefaultImage);
				}
			}
			else
			{
				// If thumbnail generation was skipped, return the default icon for this content type
				imageCallback(DefaultImage);
			}
		}

		public ImageBuffer DefaultImage => AggContext.StaticData.LoadIcon("mesh.png");

		private static bool MeshIsTooBigToLoad(string fileLocation)
		{
			if (Is32Bit && File.Exists(fileLocation))
			{
				// Mesh is too big if the estimated size is greater than Max
				return MeshFileIo.GetEstimatedMemoryUse(fileLocation) > MaxFileSize;
			}

			return false;
		}
	}
}