UVtools/UVtools.Core/Operations/OperationEditParameters.cs

/*
 *                     GNU AFFERO GENERAL PUBLIC LICENSE
 *                       Version 3, 19 November 2007
 *  Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
 *  Everyone is permitted to copy and distribute verbatim copies
 *  of this license document, but changing it is not allowed.
 */

using System;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using System.Xml.Serialization;
using UVtools.Core.FileFormats;
using UVtools.Core.Objects;

namespace UVtools.Core.Operations
{
    [Serializable]
    public class OperationEditParameters : Operation
    {
        #region Members

        private bool _propagateModificationsToLayers = true;
        private bool _perLayerOverride;
        private uint _setNumberOfLayer = 1;
        private uint _skipNumberOfLayer = 0;

        #endregion

        #region Overrides
        public override Enumerations.LayerRangeSelection StartLayerRangeSelection => Enumerations.LayerRangeSelection.None;

        public override bool CanROI => false;

        public override string Title => "Edit print parameters";

        public override string Description =>
            "Edits the available print parameters.\n" +
            "Note: Set global parameters will override all per layer settings when they are available.";

        public override string ConfirmationText
        {
            get
            {
                var sb = new StringBuilder();
                foreach (var modifier in Modifiers)
                {
                    if(!modifier.HasChanged) continue;
                    sb.AppendLine($"{modifier.Name}: {modifier.OldValue}{modifier.ValueUnit} » {modifier.NewValue}{modifier.ValueUnit}");
                }
                var text = "commit print parameter changes";
                if (_perLayerOverride)
                {
                    if (LayerRangeCount == 1)
                    {
                        text += $" to layer {LayerIndexStart}";
                    }
                    else
                    {
                        text += $" from layer {LayerIndexStart} to {LayerIndexEnd}";
                    }
                }

                return $"{text}?\n{sb}";
            }
        }

        public override string ProgressTitle => "Change print parameters";

        public override string ProgressAction => "Changing print parameters";

        public override bool CanHaveProfiles => false;

        public override string ValidateSpawn()
        {
            if (Modifiers is null || Modifiers.Length == 0)
            {
                return "No available properties to edit on this file format.";
            }

            return null;
        }

        public override string ValidateInternally()
        {
            var sb = new StringBuilder();
            var changed = Modifiers.Any(modifier => modifier.HasChanged);

            if (!changed)
            {
                sb.AppendLine("Nothing changed\nDo some changes or cancel the operation.");
            }


            return sb.ToString();
        }
        #endregion

        #region Propertiers

        [XmlIgnore]
        public FileFormat.PrintParameterModifier[] Modifiers { get; set; }

        public bool PropagateModificationsToLayers
        {
            get => _propagateModificationsToLayers;
            set => RaiseAndSetIfChanged(ref _propagateModificationsToLayers, value);
        }

        /// <summary>
        /// Gets or sets if parameters are global or per layer inside a layer range
        /// </summary>
        public bool PerLayerOverride
        {
            get => _perLayerOverride;
            set => RaiseAndSetIfChanged(ref _perLayerOverride, value);
        }

        /// <summary>
        /// Gets or sets the number of sequential layers to set the parameters
        /// </summary>
        public uint SetNumberOfLayer
        {
            get => _setNumberOfLayer;
            set => RaiseAndSetIfChanged(ref _setNumberOfLayer, value);
        }

        /// <summary>
        /// Gets or sets the number of sequential layers to skip after set a layer
        /// </summary>
        public uint SkipNumberOfLayer
        {
            get => _skipNumberOfLayer;
            set => RaiseAndSetIfChanged(ref _skipNumberOfLayer, value);
        }

        #endregion

        #region Constructor

        public OperationEditParameters() { }

        public OperationEditParameters(FileFormat slicerFile) : base(slicerFile) { }

        public override void InitWithSlicerFile()
        {
            base.InitWithSlicerFile();
            SlicerFile.RefreshPrintParametersModifiersValues();
            Modifiers = SlicerFile.PrintParameterModifiers;
        }

        #endregion

        #region Methods

        protected override bool ExecuteInternally(OperationProgress progress)
        {
            if (PerLayerOverride)
            {
                uint setLayers = 0;
                for (uint layerIndex = LayerIndexStart; layerIndex <= LayerIndexEnd; layerIndex++)
                {
                    SlicerFile[layerIndex].SetValuesFromPrintParametersModifiers(Modifiers);
                    if (SkipNumberOfLayer <= 0) continue;
                    setLayers++;
                    if (setLayers >= SetNumberOfLayer)
                    {
                        setLayers = 0;
                        layerIndex += SkipNumberOfLayer;
                    }
                }

                foreach (var modifier in Modifiers)
                {
                    modifier.OldValue = modifier.NewValue;
                }
                SlicerFile.RebuildGCode();
            }
            else
            {
                if (!_propagateModificationsToLayers)
                {
                    SlicerFile.SuppressRebuildProperties = true;
                }
                SlicerFile.SetValuesFromPrintParametersModifiers();
                if (!_propagateModificationsToLayers)
                {
                    SlicerFile.SuppressRebuildProperties = false;
                    SlicerFile.RebuildGCode();
                }
            }

            SlicerFile.RefreshPrintParametersModifiersValues();

            return !progress.Token.IsCancellationRequested;
        }

        #endregion
    }
}