Merge pull request #4401 from jlewin/master

Improve support for StagedSetupWizards
This commit is contained in:
johnlewin 2019-04-05 07:25:21 -07:00 committed by GitHub
commit f445bb68e7
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
11 changed files with 191 additions and 108 deletions

View file

@ -1621,53 +1621,6 @@ namespace MatterHackers.MatterControl
|| ProbeCalibrationWizard.NeedsToBeRun(printer);
}
public bool RunAnyRequiredPrinterSetup(PrinterConfig printer, ThemeConfig theme)
{
// run probe calibration first if we need to
if (ProbeCalibrationWizard.NeedsToBeRun(printer))
{
UiThread.RunOnIdle(() =>
{
DialogWindow.Show(new ProbeCalibrationWizard(printer));
});
return true;
}
// run the leveling wizard if we need to
if (LevelingValidation.NeedsToBeRun(printer))
{
UiThread.RunOnIdle(() =>
{
DialogWindow.Show(new PrintLevelingWizard(printer));
});
return true;
}
// run load filament if we need to
if (LoadFilamentWizard.NeedsToBeRun0(printer))
{
UiThread.RunOnIdle(() =>
{
DialogWindow.Show(
new LoadFilamentWizard(printer, extruderIndex: 0, showAlreadyLoadedButton: true));
});
return true;
}
// run load filament for extruder 1 if we need to
if (LoadFilamentWizard.NeedsToBeRun1(printer))
{
UiThread.RunOnIdle(() =>
{
DialogWindow.Show(
new LoadFilamentWizard(printer, extruderIndex: 1, showAlreadyLoadedButton: true));
});
return true;
}
return false;
}
public void Shutdown()
{
// Ensure all threads shutdown gracefully on close
@ -2414,10 +2367,15 @@ namespace MatterHackers.MatterControl
try
{
// If leveling is required or is currently on
if(this.RunAnyRequiredPrinterSetup(printer, this.Theme))
if (PrinterCalibrationWizard.SetupRequired(printer))
{
// We need to calibrate. So, don't print this part.
UiThread.RunOnIdle(() =>
{
DialogWindow.Show(
new PrinterCalibrationWizard(printer, AppContext.Theme),
advanceToIncompleteStage: true);
});
return;
}

View file

@ -385,7 +385,17 @@ namespace MatterHackers.MatterControl
{
if (sender is PrinterConfig printer)
{
ApplicationController.Instance.RunAnyRequiredPrinterSetup(printer, ApplicationController.Instance.Theme);
if (PrinterCalibrationWizard.SetupRequired(printer))
{
UiThread.RunOnIdle(() =>
{
DialogWindow.Show(
new PrinterCalibrationWizard(printer, AppContext.Theme),
advanceToIncompleteStage: true);
});
return;
}
}
}

View file

@ -77,11 +77,5 @@ namespace MatterHackers.MatterControl.ConfigurationPage.PrintLeveling
base.OnLoad(args);
}
public override void OnClosed(EventArgs e)
{
// move from this wizard to the print leveling wizard if needed
ApplicationController.Instance.RunAnyRequiredPrinterSetup(printer, theme);
}
}
}

View file

@ -106,13 +106,5 @@ namespace MatterHackers.MatterControl.ConfigurationPage.PrintLeveling
base.OnLoad(args);
}
public override void OnClosed(EventArgs e)
{
// give instruction about how to load filament if the user has not gotten them
ApplicationController.Instance.RunAnyRequiredPrinterSetup(printer, theme);
base.OnClosed(e);
}
}
}

View file

@ -82,6 +82,7 @@ namespace MatterHackers.MatterControl.ConfigurationPage.PrintLeveling
alreadyLoadedButton.Click += (s, e) =>
{
this.DialogWindow.ClosePage();
switch (extruderIndex)
{
case 0:

View file

@ -108,7 +108,7 @@ namespace MatterHackers.MatterControl
base.OnClosed(e);
}
public void ShowWizardFinished()
protected void ShowWizardFinished()
{
var doneButton = new TextButton("Done".Localize(), theme)
{
@ -118,7 +118,14 @@ namespace MatterHackers.MatterControl
doneButton.Click += (s, e) =>
{
this.DialogWindow.ClosePage();
if (this.DialogWindow is StagedSetupWindow setupWindow)
{
setupWindow.NextIncompleteStage();
}
else
{
this.DialogWindow.ClosePage();
}
};
this.AddPageAction(doneButton);

View file

@ -72,30 +72,7 @@ namespace MatterHackers.MatterControl.PrinterControls
{
UiThread.RunOnIdle(() =>
{
DialogWindow.Show(
"Printer Calibration".Localize(),
new Vector2(1200, 700),
new ISetupWizard[]
{
new PrintLevelingWizard(printer),
new ProbeCalibrationWizard(printer),
new XyCalibrationWizard(printer, 1)
},
() =>
{
var homePage = new WizardSummaryPage()
{
HeaderText = "Printer Setup & Calibration".Localize()
};
homePage.ContentRow.AddChild(
new WrappedTextWidget(
@"Select the calibration task on the left to continue".Replace("\r\n", "\n"),
pointSize: theme.DefaultFontSize,
textColor: theme.TextColor));
return homePage;
});
DialogWindow.Show(new PrinterCalibrationWizard(printer, theme));
});
};
settingsRow.AddChild(runWizardButton);

View file

@ -0,0 +1,43 @@
/*
Copyright (c) 2019, 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 MatterHackers.VectorMath;
namespace MatterHackers.MatterControl
{
public interface IStagedSetupWizard
{
IEnumerable<ISetupWizard> Stages { get; }
string Title { get; }
Vector2 WindowSize { get; }
Func<DialogPage> HomePageGenerator { get; }
}
}

View file

@ -0,0 +1,84 @@
/*
Copyright (c) 2019, 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 MatterHackers.Agg.UI;
using MatterHackers.Localizations;
using MatterHackers.MatterControl.ConfigurationPage.PrintLeveling;
using MatterHackers.MatterControl.PrinterControls;
using MatterHackers.VectorMath;
namespace MatterHackers.MatterControl
{
public class PrinterCalibrationWizard : IStagedSetupWizard
{
public PrinterCalibrationWizard(PrinterConfig printer, ThemeConfig theme)
{
this.Stages = new ISetupWizard[]
{
new PrintLevelingWizard(printer),
new ProbeCalibrationWizard(printer),
new XyCalibrationWizard(printer, 1)
};
this.HomePageGenerator = () =>
{
var homePage = new WizardSummaryPage()
{
HeaderText = "Printer Setup & Calibration".Localize()
};
homePage.ContentRow.AddChild(
new WrappedTextWidget(
@"Select the calibration task on the left to continue".Replace("\r\n", "\n"),
pointSize: theme.DefaultFontSize,
textColor: theme.TextColor));
return homePage;
};
}
public string Title { get; } = "Printer Calibration".Localize();
public Vector2 WindowSize { get; } = new Vector2(1200, 700);
public IEnumerable<ISetupWizard> Stages { get; }
public Func<DialogPage> HomePageGenerator { get; }
public static bool SetupRequired(PrinterConfig printer)
{
return LevelingValidation.NeedsToBeRun(printer) // PrintLevelingWizard
|| ProbeCalibrationWizard.NeedsToBeRun(printer)
|| LoadFilamentWizard.NeedsToBeRun0(printer)
|| LoadFilamentWizard.NeedsToBeRun1(printer);
}
}
}

View file

@ -87,22 +87,27 @@ namespace MatterHackers.MatterControl
return wizardWindow;
}
public static DialogWindow Show(string title, Vector2 windowSize, IEnumerable<ISetupWizard> stages, Func<DialogPage> homePageGenerator)
public static DialogWindow Show(IStagedSetupWizard setupWizard, bool advanceToIncompleteStage = false)
{
var wizardStages = stages.ToList();
var type = homePageGenerator.GetType();
var type = setupWizard.GetType();
var homePage = homePageGenerator();
var wizardWindow = new StagedSetupWindow(title, stages, homePageGenerator);
var wizardWindow = new StagedSetupWindow(setupWizard);
wizardWindow.Closed += (s, e) => allWindows.Remove(type);
allWindows[type] = wizardWindow;
wizardWindow.Size = windowSize;
wizardWindow.Size = setupWizard.WindowSize;
var homePage = setupWizard.HomePageGenerator();
SetSizeAndShow(wizardWindow, homePage);
wizardWindow.ChangeToPage(homePage);
if (advanceToIncompleteStage)
{
wizardWindow.NextIncompleteStage();
}
else
{
wizardWindow.ChangeToPage(homePage);
}
return wizardWindow;
}

View file

@ -37,8 +37,6 @@ namespace MatterHackers.MatterControl
{
public class StagedSetupWindow : DialogWindow
{
private IEnumerable<ISetupWizard> stages;
private Func<DialogPage> homePageGenerator;
private FlowLayoutWidget leftPanel;
private DialogPage activePage;
private GuiWidget rightPanel;
@ -46,6 +44,7 @@ namespace MatterHackers.MatterControl
private ISetupWizard _activeStage;
private Dictionary<ISetupWizard, WizardStageRow> stageButtons = new Dictionary<ISetupWizard, WizardStageRow>();
private IStagedSetupWizard setupWizard;
public ISetupWizard ActiveStage
{
@ -82,10 +81,9 @@ namespace MatterHackers.MatterControl
}
}
public StagedSetupWindow(string title, IEnumerable<ISetupWizard> stages, Func<DialogPage> homePageGenerator)
public StagedSetupWindow(IStagedSetupWizard setupWizard)
{
this.stages = stages;
this.homePageGenerator = homePageGenerator;
this.setupWizard = setupWizard;
var theme = AppContext.Theme;
@ -105,7 +103,7 @@ namespace MatterHackers.MatterControl
});
int i = 1;
foreach (var stage in stages.Where(s => s.Visible))
foreach (var stage in setupWizard.Stages.Where(s => s.Visible))
{
var stageWidget = new WizardStageRow(
$"{i++}. {stage.Title}",
@ -129,7 +127,7 @@ namespace MatterHackers.MatterControl
VAnchor = VAnchor.Stretch
});
this.Title = title;
this.Title = setupWizard.Title;
// Multi-part wizard should not try to resize per page
this.UseChildWindowSize = false;
@ -157,10 +155,24 @@ namespace MatterHackers.MatterControl
this.Invalidate();
}
public void NextIncompleteStage()
{
ISetupWizard nextStage = setupWizard.Stages.FirstOrDefault(s => s.SetupRequired);
if (nextStage != null)
{
this.ActiveStage = nextStage;
}
else
{
this.ClosePage();
}
}
public override void ClosePage()
{
// Move to the summary/home page
this.ChangeToPage(homePageGenerator());
// Construct and move to the summary/home page
this.ChangeToPage(setupWizard.HomePageGenerator());
this.ActiveStage = null;
}