mattercontrol/MatterControlLib/DesignTools/Primitives/ImageObject3D.cs

/*
Copyright (c) 2017, 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.IO;
using System.Threading;
using MatterHackers.Agg;
using MatterHackers.Agg.Image;
using MatterHackers.Agg.ImageProcessing;
using MatterHackers.Agg.Platform;
using MatterHackers.Agg.UI;
using MatterHackers.DataConverters3D;
using MatterHackers.Localizations;
using MatterHackers.PolygonMesh;
using Newtonsoft.Json;

namespace MatterHackers.MatterControl.DesignTools
{
	public class ImageObject3D : AssetObject3D
	{
		private const double DefaultSizeMm = 60;

		private string _assetPath;

		private ImageBuffer _image;

		private bool _invert;

		public ImageObject3D()
		{
			Name = "Image".Localize();
		}

		public override string AssetPath
		{
			get => _assetPath;
			set
			{
				if (_assetPath != value)
				{
					_assetPath = value;
					_image = null;
				}
			}
		}

		[JsonIgnore]
		public ImageBuffer Image
		{
			get
			{
				if (_image == null)
				{
					_image = this.LoadImage();

					if (_image != null)
					{
						if (this.Invert)
						{
							_image = InvertLightness.DoInvertLightness(_image);
						}
					}
					else // bad load
					{
						_image = new ImageBuffer(200, 200);
						var graphics2D = _image.NewGraphics2D();
						graphics2D.Clear(Color.White);
						graphics2D.DrawString("Bad Load", 100, 100);
					}

					// we don't want to invalidate on the mesh change
					using (RebuildLock())
					{
						base.Mesh = this.InitMesh() ?? PlatonicSolids.CreateCube(100, 100, 0.2);
					}

					// send the invalidate on image change
					Invalidate(InvalidateType.Image);
				}

				return _image;
			}
		}

		public bool Invert
		{
			get => _invert;
			set
			{
				if (_invert != value)
				{
					_invert = value;
					_image = null;

					Invalidate(InvalidateType.Image);
				}
			}
		}

		private ImageBuffer LoadImage()
		{
			// TODO: Consider non-awful alternatives
			var resetEvent = new AutoResetEvent(false);

			ImageBuffer imageBuffer = null;

			this.LoadAsset(CancellationToken.None, null).ContinueWith((streamTask) =>
			{
				Stream assetStream = null;
				try
				{
					assetStream = streamTask.Result;
					imageBuffer = AggContext.ImageIO.LoadImage(assetStream);
				}
				catch { }

				assetStream?.Dispose();

				resetEvent.Set();
			});

			// Wait up to 30 seconds for a given image asset
			resetEvent.WaitOne(30 * 1000);

			return imageBuffer;
		}

		public override Mesh Mesh
		{
			get
			{
				if (!string.IsNullOrWhiteSpace(this.AssetPath)
					// TODO: Remove this hack needed to work around Persistable = false
					&& (base.Mesh == null || base.Mesh.FaceTextures.Count <= 0))
				{
					using (this.RebuildLock())
					{
						// TODO: Revise fallback mesh
						base.Mesh = this.InitMesh() ?? PlatonicSolids.CreateCube(100, 100, 0.2);
					}
				}

				return base.Mesh;
			}
		}

		public double ScaleMmPerPixels { get; private set; }

		private Mesh InitMesh()
		{
			if (!string.IsNullOrWhiteSpace(this.AssetPath))
			{
				var imageBuffer = this.Image;
				if (imageBuffer != null)
				{
					ScaleMmPerPixels = Math.Min(DefaultSizeMm / imageBuffer.Width, DefaultSizeMm / imageBuffer.Height);

					// Create texture mesh
					double width = ScaleMmPerPixels * imageBuffer.Width;
					double height = ScaleMmPerPixels * imageBuffer.Height;

					Mesh textureMesh = PlatonicSolids.CreateCube(width, height, 0.2);
					textureMesh.PlaceTextureOnFaces(0, imageBuffer);

					return textureMesh;
				}
			}

			return null;
		}
	}
}