mattercontrol/MatterControlLib/PartPreviewWindow/GCode2DWidget.cs

/*
Copyright (c) 2014, Lars Brubaker
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 MatterControl.Printing;
using MatterHackers.Agg;
using MatterHackers.Agg.Image;
using MatterHackers.Agg.Transform;
using MatterHackers.Agg.UI;
using MatterHackers.GCodeVisualizer;
using MatterHackers.MatterControl.SlicerConfiguration;
using MatterHackers.RenderOpenGl;
using MatterHackers.VectorMath;

namespace MatterHackers.MatterControl.PartPreviewWindow
{
	public class GCode2DWidget : GuiWidget
	{
		private static Color gridColor = new Color(190, 190, 190, 255);

		private ImageBuffer bedImage;

		private Vector2 gridCenterMm;

		private Vector2 gridSizeMm;

		private Vector2 lastMousePosition = new Vector2(0, 0);

		private Vector2 mouseDownPosition = new Vector2(0, 0);

		private View3DConfig options;

		private double pinchStartScale = 1;

		private PrinterConfig printer;

		private double startDistanceBetweenPoints = 1;

		private Vector2 unscaledRenderOffset = new Vector2(0, 0);

		public GCode2DWidget(PrinterConfig printer, ThemeConfig theme)
		{
			this.printer = printer;
			options = printer.Bed.RendererOptions;

			this.LocalBounds = new RectangleDouble(0, 0, 100, 100);
			this.AnchorAll();

			// Register listeners
			printer.Bed.LoadedGCodeChanged += LoadedGCodeChanged;
			printer.Settings.SettingChanged += Printer_SettingChanged;

			Printer_SettingChanged(this, null);

			this.gridSizeMm = printer.Settings.GetValue<Vector2>(SettingsKey.bed_size);
			this.gridCenterMm = printer.Settings.GetValue<Vector2>(SettingsKey.print_center);

			// Acquire the bed image
			bedImage = BedMeshGenerator.CreatePrintBedImage(printer);

			// Create a semi-transparent overlay with the theme color
			var overlay = new ImageBuffer(bedImage.Width, bedImage.Height);
			overlay.NewGraphics2D().Clear(new Color(theme.BackgroundColor, 100));

			// Render the overlay onto the bedImage to tint it and reduce its default overbearing light on dark contrast
			bedImage.NewGraphics2D().Render(overlay, 0, 0);

			// Preload GL texture for 2D bed image and use MipMaps
			UiThread.RunOnIdle(() =>
			{
				ImageGlPlugin.GetImageGlPlugin(bedImage, createAndUseMipMaps: true);
			});
		}

		public enum ETransformState { Move, Scale };

		public override RectangleDouble LocalBounds
		{
			get
			{
				return base.LocalBounds;
			}

			set
			{
				double oldWidth = Width;
				double oldHeight = Height;
				base.LocalBounds = value;
				if (oldWidth > 0)
				{
					layerScale = layerScale * (Width / oldWidth);
				}
				else if (printer.Bed.GCodeRenderer != null)
				{
					CenterPartInView();
				}
			}
		}

		public ETransformState TransformState { get; set; }

		private double layerScale { get; set; } = 1;

		private GCodeFile LoadedGCode => printer.Bed.LoadedGCode;

		private Affine ScalingTransform => Affine.NewScaling(layerScale, layerScale);

		private Affine TotalTransform => Affine.NewTranslation(unscaledRenderOffset) * ScalingTransform * Affine.NewTranslation(Width / 2, Height / 2);

		public void CenterPartInView()
		{
			if (LoadedGCode != null)
			{
				RectangleDouble partBounds = LoadedGCode.GetBounds();
				Vector2 weightedCenter = LoadedGCode.GetWeightedCenter();

				unscaledRenderOffset = -weightedCenter;
				layerScale = Math.Min(Height / partBounds.Height, Width / partBounds.Width);

				Invalidate();
			}
		}

		public void DrawBedImage(Graphics2D graphics2D, Affine transform)
		{
			Vector2 gridOffset = gridCenterMm - gridSizeMm / 2;

			Vector2 imageStart = Vector2.Zero + gridOffset;
			transform.transform(ref imageStart);
			Vector2 imageEnd = gridSizeMm + gridOffset;
			transform.transform(ref imageEnd);
			graphics2D.Render(bedImage, imageStart, imageEnd.X - imageStart.X, imageEnd.Y - imageStart.Y);
		}

		public override void OnClosed(EventArgs e)
		{
			// Unregister listeners
			printer.Settings.SettingChanged -= Printer_SettingChanged;
			printer.Bed.LoadedGCodeChanged -= LoadedGCodeChanged;
			printer.Bed.GCodeRenderer?.Dispose();

			base.OnClosed(e);
		}

		public override void OnDraw(Graphics2D graphics2D)
		{
			if (LoadedGCode != null)
			{
				if (layerScale == 0)
				{
					CenterPartInView();
				}
				//using (new PerformanceTimer("GCode Timer", "Total"))
				{
					Affine transform = TotalTransform;

					if (this.options.RenderBed)
					{
						//using (new PerformanceTimer("GCode Timer", "Render Grid"))
						{
							double gridLineWidths = 0.2 * layerScale;

							DrawBedImage(graphics2D, transform);
						}
					}

					if (printer.Bed.RenderInfo is GCodeRenderInfo options)
					{
						var renderInfo = new GCodeRenderInfo(
							printer.Bed.ActiveLayerIndex,
							printer.Bed.ActiveLayerIndex,
							transform,
							layerScale,
							options.FeatureToStartOnRatio0To1,
							options.FeatureToEndOnRatio0To1,
							options.GetRenderType,
							options.GetMaterialColor);

						printer.Bed.GCodeRenderer?.Render(graphics2D, renderInfo);
					}
				}
			}

			base.OnDraw(graphics2D);
		}

		public override void OnMouseDown(MouseEventArgs mouseEvent)
		{
			base.OnMouseDown(mouseEvent);
			if (MouseCaptured)
			{
				if (mouseEvent.NumPositions == 1)
				{
					mouseDownPosition.X = mouseEvent.X;
					mouseDownPosition.Y = mouseEvent.Y;
				}
				else
				{
					Vector2 centerPosition = (mouseEvent.GetPosition(1) + mouseEvent.GetPosition(0)) / 2;
					mouseDownPosition = centerPosition;
				}

				lastMousePosition = mouseDownPosition;

				if (mouseEvent.NumPositions > 1)
				{
					startDistanceBetweenPoints = (mouseEvent.GetPosition(1) - mouseEvent.GetPosition(0)).Length;
					pinchStartScale = layerScale;
				}
			}
		}

		public override void OnMouseMove(MouseEventArgs mouseEvent)
		{
			base.OnMouseMove(mouseEvent);
			Vector2 mousePos = new Vector2();
			if (mouseEvent.NumPositions == 1)
			{
				mousePos = new Vector2(mouseEvent.X, mouseEvent.Y);
			}
			else
			{
				Vector2 centerPosition = (mouseEvent.GetPosition(1) + mouseEvent.GetPosition(0)) / 2;
				mousePos = centerPosition;
			}
			if (MouseCaptured)
			{
				Vector2 mouseDelta = mousePos - lastMousePosition;
				switch (TransformState)
				{
					case ETransformState.Scale:
						double zoomDelta = 1;
						if (mouseDelta.Y < 0)
						{
							zoomDelta = 1 - (-1 * mouseDelta.Y / 100);
						}
						else if (mouseDelta.Y > 0)
						{
							zoomDelta = 1 + (1 * mouseDelta.Y / 100);
						}

						Vector2 mousePreScale = mouseDownPosition;
						TotalTransform.inverse_transform(ref mousePreScale);

						layerScale *= zoomDelta;

						Vector2 mousePostScale = mouseDownPosition;
						TotalTransform.inverse_transform(ref mousePostScale);

						unscaledRenderOffset += (mousePostScale - mousePreScale);
						break;

					case ETransformState.Move:
					default: // also treat everything else like a move
						ScalingTransform.inverse_transform(ref mouseDelta);

						unscaledRenderOffset += mouseDelta;
						break;
				}

				Invalidate();
			}
			lastMousePosition = mousePos;

			// check if we should do some scaling
			if (TransformState == ETransformState.Move
				&& mouseEvent.NumPositions > 1
				&& startDistanceBetweenPoints > 0)
			{
				double curDistanceBetweenPoints = (mouseEvent.GetPosition(1) - mouseEvent.GetPosition(0)).Length;

				double scaleAmount = pinchStartScale * curDistanceBetweenPoints / startDistanceBetweenPoints;
				ScalePartAndFixPosition(mouseEvent, scaleAmount);
			}
		}

		public override void OnMouseWheel(MouseEventArgs mouseEvent)
		{
			base.OnMouseWheel(mouseEvent);
			if (FirstWidgetUnderMouse) // TODO: find a good way to decide if you are what the wheel is trying to do
			{
				const double deltaFor1Click = 120;
				double scaleAmount = (mouseEvent.WheelDelta / deltaFor1Click) * .1;

				ScalePartAndFixPosition(mouseEvent, layerScale + layerScale * scaleAmount);

				Invalidate();
			}
		}

		public void Zoom(double scaleAmount)
		{
			ScalePartAndFixPosition(new MouseEventArgs(MouseButtons.None, 0, Width / 2, Height / 2, 0), layerScale * scaleAmount);
			Invalidate();
		}

		private void LoadedGCodeChanged(object sender, EventArgs e)
		{
			if (LoadedGCode == null)
			{
				// TODO: Display an overlay for invalid GCode
			}
			else
			{
				CenterPartInView();
			}
		}

		private void Printer_SettingChanged(object sender, StringEventArgs stringEvent)
		{
			if (stringEvent != null)
			{
				if (stringEvent.Data == SettingsKey.bed_size
					|| stringEvent.Data == SettingsKey.print_center
					|| stringEvent.Data == SettingsKey.bed_shape)
				{
					this.gridSizeMm = printer.Settings.GetValue<Vector2>(SettingsKey.bed_size);
					this.gridCenterMm = printer.Settings.GetValue<Vector2>(SettingsKey.print_center);

					bedImage = BedMeshGenerator.CreatePrintBedImage(printer);
				}
			}
		}

		private void ScalePartAndFixPosition(MouseEventArgs mouseEvent, double scaleAmount)
		{
			Vector2 mousePreScale = new Vector2(mouseEvent.X, mouseEvent.Y);
			TotalTransform.inverse_transform(ref mousePreScale);

			layerScale = scaleAmount;

			Vector2 mousePostScale = new Vector2(mouseEvent.X, mouseEvent.Y);
			TotalTransform.inverse_transform(ref mousePostScale);

			unscaledRenderOffset += (mousePostScale - mousePreScale);
		}
	}
}