mattercontrol/MatterControlLib/DesignTools/Operations/RadialPinchObject3D.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.Linq;
using System.Reflection.Metadata.Ecma335;
using System.Threading;
using System.Threading.Tasks;
using MatterHackers.Agg;
using MatterHackers.Agg.Transform;
using MatterHackers.Agg.UI;
using MatterHackers.Agg.VertexSource;
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;

namespace MatterHackers.MatterControl.DesignTools
{
    public class RadialPinchObject3D : OperationSourceContainerObject3D, IPropertyGridModifier, IEditorDraw
    {
        public class EditableVertexStorage : VertexStorage
        {

        }

        public RadialPinchObject3D()
        {
            // make sure the path editor is registered
            PropertyEditor.RegisterEditor(typeof(EditableVertexStorage), new PathEditor());

            Name = "Radial Pinch".Localize();
        }

        [PathEditor.TopAndBottomMoveXOnly]
        [PathEditor.XMustBeGreaterThan0]
        public EditableVertexStorage PathForHorizontalOffsets { get; set; } = new EditableVertexStorage();

        [Description("Specifies the number of vertical cuts required to ensure the part can be pinched well.")]
        [Slider(0, 50, snapDistance: 1)]
        public IntOrExpression PinchSlices { get; set; } = 5;

        [Description("Enable advanced features.")]
        public bool Advanced { get; set; } = false;

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

        [Description("The percentage up from the bottom to end the pinch")]
        [Slider(0, 100, Easing.EaseType.Quadratic, snapDistance: 1)]
        public DoubleOrExpression EndHeightPercent { get; set; } = 100;

        [Description("The percentage up from the bottom to start the pinch")]
        [Slider(0, 100, Easing.EaseType.Quadratic, snapDistance: 1)]
        public DoubleOrExpression StartHeightPercent { get; set; } = 0;

        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, 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 AxisAlignedBoundingBox GetEditorWorldspaceAABB(Object3DControlsLayer layer)
        {
            var sourceAabb = this.SourceContainer.GetAxisAlignedBoundingBox();
            var rotationCenter = SourceContainer.GetSmallestEnclosingCircleAlongZ().Center + RotationOffset;
            var center = new Vector3(rotationCenter.X, rotationCenter.Y, sourceAabb.Center.Z);
            return AxisAlignedBoundingBox.CenteredBox(new Vector3(1, 1, sourceAabb.ZSize), center).NewTransformed(this.WorldMatrix());
        }

        public Vector2 Point1 { get; set; } = new Vector2(0, 0);
        public Vector2 Point2 {get; set;} = new Vector2(1, 4);
        public Vector2 Point3 { get; set;} = new Vector2(2, 8);
        public Vector2 Point4 { get; set;} = new Vector2(3, 12);
        public Vector2 Point5 { get; set;} = new Vector2(4, 14);
        public Vector2 Point6 { get; set;} = new Vector2(5, 16);
        public Vector2 Point7 { get; set;} = new Vector2(6, 18);

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

            bool valuesChanged = false;

            var aabb = this.GetAxisAlignedBoundingBox();

            var pinchSlices = PinchSlices.ClampIfNotCalculated(this, 0, 300, ref valuesChanged);
            var endHeightPercent = EndHeightPercent.ClampIfNotCalculated(this, 0, 100, ref valuesChanged);
            endHeightPercent = EndHeightPercent.ClampIfNotCalculated(this, 1, 100, ref valuesChanged);
            var startHeightPercent = StartHeightPercent.ClampIfNotCalculated(this, 0, endHeightPercent - 1, ref valuesChanged);
            startHeightPercent = Math.Min(endHeightPercent - 1, startHeightPercent);

            var rebuildLocks = this.RebuilLockAll();

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

                    var bottom = sourceAabb.MinXYZ.Z;
                    var top = sourceAabb.MaxXYZ.Z;
                    var size = sourceAabb.ZSize;
                    if (Advanced)
                    {
                        top = sourceAabb.ZSize * endHeightPercent / 100.0;
                        bottom = sourceAabb.ZSize * startHeightPercent / 100.0;
                        size = top - bottom;
                    }

                    double numberOfCuts = pinchSlices;

                    double cutSize = size / numberOfCuts;
                    var cuts = new List<double>();
                    for (int i = 0; i < numberOfCuts + 1; i++)
                    {
                        var ratio = i / numberOfCuts;
                        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 maxRadius = enclosingCircle.Radius + RotationOffset.Length;

                    //if (PathForHorizontalOffsets.Count == 0)
                    {
                        var bottomPoint = new Vector2(maxRadius, bottom * 10);
                        var topPoint = new Vector2(maxRadius, top * 10);
                        var middlePoint = (bottomPoint + topPoint) / 2;
                        middlePoint.X *= 2;

                        PathForHorizontalOffsets.Clear();
                        PathForHorizontalOffsets.MoveTo(Point1);
                        PathForHorizontalOffsets.Curve4(Point2, Point3, Point4);
                        PathForHorizontalOffsets.Curve4(Point5, Point6, Point7);
                    }

                    var horizontalOffset = new FlattenCurves(new VertexSourceApplyTransform(PathForHorizontalOffsets, Affine.NewScaling(10)));

                    var xAtYInterpolator = new XAtYInterpolator(horizontalOffset);

                    var pinchedChildren = new List<IObject3D>();

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

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

                        status = "Split Mesh".Localize();
                        reporter?.Invoke(0, 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 = 1.0;

                            if (position.Z >= bottom
                                && position.Z <= top)
                            {
                                ratio = (position.Z - bottom) / size;
                            }

                            var positionXy = new Vector2(position) - rotationCenter;
                            var fromLine = true;
                            if (fromLine)
                            {
                                positionXy *= horizontalOffset.GetXAtY(position.Z * 10) / (maxRadius * 10);
                                //positionXy *= xAtYInterpolator.Get(position.Z * 10) / maxRadius;
                            }
                            else
                            {
                                positionXy *= Easing.Quadratic.InOut(ratio);
                            }
                            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 pinchedChild = new Object3D()
                        {
                            Mesh = transformedMesh
                        };
                        pinchedChild.CopyWorldProperties(sourceItem, SourceContainer, Object3DPropertyFlags.All, false);
                        pinchedChild.Visible = true;

                        pinchedChildren.Add(pinchedChild);
                    }

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

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

                    ApplyHoles(reporter, cancellationToken.Token);

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

                    return Task.CompletedTask;
                });
        }

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

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

            changeSet.Add(nameof(RotationOffset), Advanced);
            changeSet.Add(nameof(StartHeightPercent), Advanced);
            changeSet.Add(nameof(EndHeightPercent), Advanced);

            // 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);
            }
        }
    }

    internal class XAtYInterpolator
    {
        private double bottom;
        private double top;

        private int numberOfSegments;
        private double[] offsetAtY;

        public XAtYInterpolator(IVertexSource inputCurveIn)
        {
            var inputCurve = new VertexStorage(inputCurveIn);

            var bounds = inputCurve.GetBounds();
            bottom = bounds.Bottom;
            top = bounds.Top;
            numberOfSegments = 100;
            offsetAtY = new double[numberOfSegments + 1];
            for (int i = 0; i < numberOfSegments + 1; i++)
            {
                var y = bottom + (top - bottom) * i / numberOfSegments;
                offsetAtY[i] = inputCurve.GetXAtY(y);
            }
        }

        internal double Get(double y)
        {
            // check if we are bellow the bottom 
            if (y <= bottom)
            {
                return offsetAtY[0];
            }

            // check if we are above the top
            if (y >= top)
            {
                return offsetAtY[numberOfSegments];
            }

            // find the segment we are in
            var segment = (int)((y - bottom) / (top - bottom) * numberOfSegments);
            // lerp between the two points
            var ratio = (y - bottom) / (top - bottom) * numberOfSegments - segment;
            return offsetAtY[segment] * (1 - ratio) + offsetAtY[segment + 1] * ratio;
        }
    }
}