mattercontrol/MatterControlLib/DesignTools/Operations/TwistObject3D.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.ComponentModel;
using System.ComponentModel.DataAnnotations;
using System.Linq;
using System.Threading;
using System.Threading.Tasks;
using MatterHackers.Agg;
using MatterHackers.Agg.UI;
using MatterHackers.DataConverters3D;
using MatterHackers.Localizations;
using MatterHackers.MatterControl.DesignTools.Operations;
using MatterHackers.MatterControl.PartPreviewWindow;
using MatterHackers.PolygonMesh;
using MatterHackers.RenderOpenGl;
using MatterHackers.RenderOpenGl.OpenGl;
using MatterHackers.VectorMath;
using Newtonsoft.Json;

namespace MatterHackers.MatterControl.DesignTools
{
	public class TwistObject3D : OperationSourceContainerObject3D, IPropertyGridModifier, ISelectedEditorDraw
	{
		public TwistObject3D()
		{
			Name = "Twist".Localize();
		}

		public enum RotationTypes
		{
			Angle,
			Distance
		}

		[EnumDisplay(Mode = EnumDisplayAttribute.PresentationMode.Tabs)]
		public RotationTypes RotationType { get; set; } = RotationTypes.Angle;

		[MaxDecimalPlaces(2)]
		[Description("The angle to rotate the top of the part")]
		public double Angle { get; set; } = 135;

		[Description("The distance along the circumference to rotate the top in mm")]
		public double RotationDistance { get; set; } = 10;

		[Description("Specifies the number of vertical cuts required to ensure the part can be twist well.")]
		[Range(3, 300, ErrorMessage = "Value for {0} must be between {1} and {2}.")]
		public double RotationSlices { get; set; } = 5;

		[Description("The source part is specifying a preferred radius. You can turn this off to set a specific radius.")]
		public bool EditRadius { get; set; } = false;

		[Description("The radius described by the source part or implied by the geometry.")]
		[ReadOnly(true)]
		public double PreferedRadius { get; set; } = 0;

		[Description("Specify the radius to use when calculating the circumference.")]
		public double OverrideRadius { get; set; } = .01;

		[DisplayName("Twist Right")]
		public bool TwistCw { get; set; } = true;

		[Description("Enable advanced features like specifying when the twist starts and stops on the part.")]
		public bool Advanced { get; set; } = false;

		[ReadOnly(true)]
		[DisplayName("")] // clear the display name so this text will be the full width of the editor
		public string EasyModeMessage { get; set; } = "You can switch to Advanced mode to get more twist options.";

		[Description("Allows for the repositioning of the rotation origin")]
		public Vector2 RotationOffset { get; set; }

		public Easing.EaseType EasingType { get; set; } = Easing.EaseType.Linear;

		[EnumDisplay(Mode = EnumDisplayAttribute.PresentationMode.Buttons)]
		public Easing.EaseOption EasingOption { get; set; } = Easing.EaseOption.InOut;

		[Description("The percentage up from the bottom to start the twist")]
		public double StartHeightPercent { get; set; } = 0;

		[Description("The percentage up from the bottom to end the twist")]
		public double EndHeightPercent { get; set; } = 100;

		public IRadiusProvider RadiusProvider
		{
			get
			{
				if (this.SourceContainer.Children.Count == 1
						&& this.SourceContainer.Children.First() is IRadiusProvider radiusProvider)
				{
					return radiusProvider;
				}

				return null;
			}
		}

		public void DrawEditor(Object3DControlsLayer layer, List<Object3DView> transparentMeshes, DrawEventArgs e)
		{
			var sourceAabb = this.SourceContainer.GetAxisAlignedBoundingBox();
			var rotationCenter = SourceContainer.GetSmallestEnclosingCircleAlongZ().Center + RotationOffset;

			var center = new Vector3(rotationCenter.X, rotationCenter.Y, sourceAabb.Center.Z);

			// render the top and bottom rings
			layer.World.RenderCylinderOutline(this.WorldMatrix(), center, 1, sourceAabb.ZSize, 15, Color.Red, Color.Red, 5);

			// turn the lighting back on
			GL.Enable(EnableCap.Lighting);
		}

		public override Task Rebuild()
		{
			this.DebugDepth("Rebuild");

			bool valuesChanged = false;

			if (Angle < 1 || Angle > 100000)
			{
				Angle = Math.Min(100000, Math.Max(1, Angle));
				valuesChanged = true;
			}

			if (RotationDistance < 0 || RotationDistance > 100000)
			{
				RotationDistance = Math.Min(100000, Math.Max(0, RotationDistance));
				valuesChanged = true;
			}

			if (RotationSlices < 3 || RotationSlices > 300)
			{
				RotationSlices = Math.Min(300, Math.Max(3, RotationSlices));
				valuesChanged = true;
			}

			if (EndHeightPercent < 1 || EndHeightPercent > 100)
			{
				EndHeightPercent = Math.Min(100, Math.Max(1, EndHeightPercent));
				valuesChanged = true;
			}

			if (StartHeightPercent < 0 || StartHeightPercent > EndHeightPercent - 1)
			{
				StartHeightPercent = Math.Min(EndHeightPercent - 1, Math.Max(0, StartHeightPercent));
				valuesChanged = true;
			}

			if (OverrideRadius < .01)
			{
				OverrideRadius = Math.Max(this.GetAxisAlignedBoundingBox().XSize, this.GetAxisAlignedBoundingBox().YSize);
				valuesChanged = true;
			}

			var rebuildLocks = this.RebuilLockAll();

			return ApplicationController.Instance.Tasks.Execute(
				"Twist".Localize(),
				null,
				(reporter, cancellationToken) =>
				{
					var sourceAabb = this.SourceContainer.GetAxisAlignedBoundingBox();

					var bottom = sourceAabb.MinXYZ.Z;
					var top = sourceAabb.ZSize * EndHeightPercent / 100.0;
					var size = sourceAabb.ZSize;
					if (Advanced)
					{
						bottom += sourceAabb.ZSize * StartHeightPercent / 100.0;
						size = top - bottom;
					}

					double numberOfCuts = RotationSlices;

					double cutSize = size / numberOfCuts;
					var cuts = new List<double>();
					for (int i = 0; i < numberOfCuts + 1; i++)
					{
						var ratio = i / numberOfCuts;
						if (Advanced)
						{
							var goal = ratio;
							var current = .5;
							var next = .25;
							// look for an x value that equals the goal
							for (int j = 0; j < 64; j++)
							{
								var xAtY = Easing.Calculate(EasingType, EasingOption, current);
								if (xAtY < goal)
								{
									current += next;
								}
								else if (xAtY > goal)
								{
									current -= next;
								}

								next *= .5;
							}

							ratio = current;
						}

						cuts.Add(bottom - cutSize + (size * ratio));
					}

					// get the rotation from the center of the circumscribed circle of the convex hull
					var enclosingCircle = SourceContainer.GetSmallestEnclosingCircleAlongZ();
					var rotationCenter = enclosingCircle.Center + RotationOffset;

					var twistedChildren = new List<IObject3D>();

					var status = new ProgressStatus();

					foreach (var sourceItem in SourceContainer.VisibleMeshes())
					{
						var originalMesh = sourceItem.Mesh;
						status.Status = "Copy Mesh".Localize();
						reporter.Report(status);
						var transformedMesh = originalMesh.Copy(CancellationToken.None);
						var itemMatrix = sourceItem.WorldMatrix(SourceContainer);

						// transform into this space
						transformedMesh.Transform(itemMatrix);

						status.Status = "Split Mesh".Localize();
						reporter.Report(status);

						// split the mesh along the z axis
						transformedMesh.SplitOnPlanes(Vector3.UnitZ, cuts, cutSize / 8);

						for (int i = 0; i < transformedMesh.Vertices.Count; i++)
						{
							var position = transformedMesh.Vertices[i];

							var ratio = (position.Z - bottom) / size;

							if (Advanced)
							{
								if (position.Z < bottom)
								{
									ratio = 0;
								}
								else if (position.Z > top)
								{
									ratio = 1;
								}
								else
								{
									ratio = (position.Z - bottom) / size;
									ratio = Easing.Calculate(EasingType, EasingOption, ratio);
								}
							}

							var angleToRotate = ratio * Angle / 360.0 * MathHelper.Tau;
							if (RotationType == RotationTypes.Distance)
							{
								IRadiusProvider radiusProvider = RadiusProvider;

								// start off with assuming we want to set the radius
								var radius = this.OverrideRadius;
								if (radiusProvider != null && !this.EditRadius)
								{
									// have a radius provider and not wanting to edit
									radius = radiusProvider.Radius;
								}
								else if (!this.EditRadius)
								{
									// not wanting to edit
									radius = enclosingCircle.Radius;
								}

								if (this.PreferedRadius != radius)
								{
									this.PreferedRadius = radius;
									this.OverrideRadius = radius;
									UiThread.RunOnIdle(() => Invalidate(InvalidateType.DisplayValues));
								}

								angleToRotate = ratio * (RotationDistance / radius);
							}

							if (!TwistCw)
							{
								angleToRotate = -angleToRotate;
							}

							var positionXy = new Vector2(position) - rotationCenter;
							positionXy.Rotate(angleToRotate);
							positionXy += rotationCenter;
							transformedMesh.Vertices[i] = new Vector3Float(positionXy.X, positionXy.Y, position.Z);
						}

						// transform back into item local space
						transformedMesh.Transform(itemMatrix.Inverted);

						//transformedMesh.MergeVertices(.1);
						transformedMesh.CalculateNormals();

						var twistedChild = new Object3D()
						{
							Mesh = transformedMesh
						};
						twistedChild.CopyWorldProperties(sourceItem, SourceContainer, Object3DPropertyFlags.All, false);
						twistedChild.Visible = true;

						twistedChildren.Add(twistedChild);
					}

					RemoveAllButSource();
					this.SourceContainer.Visible = false;

					this.Children.Modify((list) =>
					{
						list.AddRange(twistedChildren);
					});

					if (valuesChanged)
					{
						Invalidate(InvalidateType.DisplayValues);
					}

					UiThread.RunOnIdle(() =>
					{
						rebuildLocks.Dispose();
						Parent?.Invalidate(new InvalidateArgs(this, InvalidateType.Children));
					});

					return Task.CompletedTask;
				});
		}

		private Dictionary<string, bool> changeSet = new Dictionary<string, bool>();

		public void UpdateControls(PublicPropertyChange change)
		{
			changeSet.Clear();

			changeSet.Add(nameof(RotationDistance), RotationType == RotationTypes.Distance);
			changeSet.Add(nameof(Angle), RotationType == RotationTypes.Angle);
			changeSet.Add(nameof(RotationOffset), Advanced);
			changeSet.Add(nameof(StartHeightPercent), Advanced);
			changeSet.Add(nameof(EasingOption), Advanced && EasingType != Easing.EaseType.Linear);
			changeSet.Add(nameof(EasingType), Advanced);
			changeSet.Add(nameof(EndHeightPercent), Advanced);
			changeSet.Add(nameof(EasyModeMessage), !Advanced);
			changeSet.Add(nameof(PreferedRadius), RadiusProvider != null && !this.EditRadius && RotationType == RotationTypes.Distance);
			changeSet.Add(nameof(OverrideRadius), (RadiusProvider == null || this.EditRadius) && RotationType == RotationTypes.Distance);
			changeSet.Add(nameof(EditRadius), RadiusProvider != null && RotationType == RotationTypes.Distance);

			// first turn on all the settings we want to see
			foreach (var kvp in changeSet.Where(c => c.Value))
			{
				change.SetRowVisible(kvp.Key, () => kvp.Value);
			}

			// then turn off all the settings we want to hide
			foreach (var kvp in changeSet.Where(c => !c.Value))
			{
				change.SetRowVisible(kvp.Key, () => kvp.Value);
			}
		}
	}

	public interface IRadiusProvider
	{
		double Radius { get; }
	}

	public static class ObjectCircleExtensions
	{
		public static Circle GetSmallestEnclosingCircleAlongZ(this IObject3D object3D)
		{
			var visibleMeshes = object3D.VisibleMeshes().Select(vm => (source: vm, convexHull: vm.Mesh.GetConvexHull(false))).ToList();

			IEnumerable<Vector2> GetVertices()
			{
				foreach (var visibleMesh in visibleMeshes)
				{
					var matrix = visibleMesh.source.WorldMatrix(object3D);
					foreach (var positon in visibleMesh.convexHull.Vertices)
					{
						var transformed = positon.Transform(matrix);
						yield return new Vector2(transformed.X, transformed.Y);
					}
				}
			}

			var circle = SmallestEnclosingCircle.MakeCircle(GetVertices());

			return circle;
		}
	}
}