Continued work on tutorial flow. See #950.

Author: azonenberg

src/ngscopeclient/AddInstrumentDialog.cpp

@@ -78,7 +78,10 @@ AddInstrumentDialog::~AddInstrumentDialog()
  */
 bool AddInstrumentDialog::DoRender()
 {
+	//Get the tutorial wizard and see if we're on the "connect to scope" page
 	auto tutorial = m_parent->GetTutorialWizard();
+	if(tutorial && (tutorial->GetCurrentStep() != TutorialWizard::TUTORIAL_02_CONNECT) )
+		tutorial = nullptr;
 
 	ImGui::InputText("Nickname", &m_nickname);
 	HelpMarker(
@@ -99,10 +102,7 @@ bool AddInstrumentDialog::DoRender()
 
 	//Show speech bubble for tutorial
 	bool showedBubble = false;
-	if(tutorial &&
-		(tutorial->GetCurrentStep() == TutorialWizard::TUTORIAL_02_CONNECT) &&
-		(m_drivers[m_selectedDriver] != "demo") &&
-		!dropdownOpen )
+	if(tutorial && (m_drivers[m_selectedDriver] != "demo") && !dropdownOpen )
 	{
 		auto pos = ImGui::GetCursorScreenPos();
 		ImVec2 anchorPos(pos.x + 10*ImGui::GetFontSize(), pos.y);
@@ -129,11 +129,7 @@ bool AddInstrumentDialog::DoRender()
 		);
 
 	//Show speech bubble for tutorial
-	if(tutorial &&
-		(tutorial->GetCurrentStep() == TutorialWizard::TUTORIAL_02_CONNECT) &&
-		(m_transports[m_selectedTransport] != "null") &&
-		!dropdownOpen &&
-		!showedBubble)
+	if(tutorial && (m_transports[m_selectedTransport] != "null") && !dropdownOpen && !showedBubble)
 	{
 		auto pos = ImGui::GetCursorScreenPos();
 		ImVec2 anchorPos(pos.x + 10*ImGui::GetFontSize(), pos.y);
@@ -161,20 +157,33 @@ bool AddInstrumentDialog::DoRender()
 		if(m_nickname.empty())
 		{
 			ShowErrorPopup(
-			"Nickname error",
-			"Nickname shall be not empty");
+				"Nickname error",
+				"The nickname cannot be left blank");
 		}
 		else
 		{
 			auto transport = MakeTransport();
 			if(transport)
 			{
 				if(DoConnect(transport))
+				{
+					if(tutorial)
+						tutorial->AdvanceToNextStep();
+
 					return false;
+				}
 			}
 		}
 	}
 
+	if(tutorial && !dropdownOpen && !showedBubble)
+	{
+		auto pos = ImGui::GetCursorScreenPos();
+		ImVec2 anchorPos(pos.x + 2*ImGui::GetFontSize(), pos.y);
+		tutorial->DrawSpeechBubble(anchorPos, ImGuiDir_Up, "Add the scope to your session");
+		showedBubble = true;
+	}
+
 	return true;
 }
 

src/ngscopeclient/MainWindow.cpp

@@ -233,7 +233,8 @@ void MainWindow::InitializeDefaultSession()
 	m_initialWorkspaceDockRequest = w;
 
 	//Spawn the tutorial if requested
-	if(m_session.GetPreferences().GetBool("Help.Wizards.first_run_wizard"))
+	//if(m_session.GetPreferences().GetBool("Help.Wizards.first_run_wizard"))
+	if(false)
 	{
 		m_tutorialDialog = make_shared<TutorialWizard>(&m_session, this);
 		AddDialog(m_tutorialDialog);
@@ -1030,6 +1031,8 @@ void MainWindow::ToolbarButtons()
 
 	bool multigroup = (m_session.GetTriggerGroups().size() > 1);
 
+	auto buttonStartPos = ImGui::GetCursorScreenPos();;
+
 	//Trigger button group
 	if(ImGui::ImageButton("trigger-start", GetTexture("trigger-start"), buttonsize))
 		m_session.ArmTrigger(TriggerGroup::TRIGGER_TYPE_NORMAL);
@@ -1041,6 +1044,17 @@ void MainWindow::ToolbarButtons()
 	}
 
 	ImGui::SameLine(0.0, 0.0);
+
+	if(m_tutorialDialog && (m_tutorialDialog->GetCurrentStep() == TutorialWizard::TUTORIAL_03_ACQUIRE) )
+	{
+		auto buttonEndPos = ImGui::GetCursorScreenPos();
+		ImVec2 anchorPos(
+			buttonEndPos.x - ImGui::GetFontSize(),
+			buttonStartPos.y + 2*ImGui::GetFontSize());
+		m_tutorialDialog->DrawSpeechBubble(anchorPos, ImGuiDir_Up, "  Arm the trigger");
+		//FIXME better handling of going off edge
+	}
+
 	if(ImGui::ImageButton("trigger-single", GetTexture("trigger-single"), buttonsize))
 		m_session.ArmTrigger(TriggerGroup::TRIGGER_TYPE_SINGLE);
 	Dialog::Tooltip("Arm the trigger in one-shot mode");

src/ngscopeclient/TutorialWizard.cpp

@@ -52,6 +52,7 @@ TutorialWizard::TutorialWizard(Session* session, MainWindow* parent)
 	m_markdownText.push_back(ReadDataFile("md/tutorial_00_intro.md"));
 	m_markdownText.push_back(ReadDataFile("md/tutorial_01_addinstrument.md"));
 	m_markdownText.push_back(ReadDataFile("md/tutorial_02_connect.md"));
+	m_markdownText.push_back(ReadDataFile("md/tutorial_03_acquire.md"));
 }
 
 TutorialWizard::~TutorialWizard()
@@ -183,12 +184,25 @@ void TutorialWizard::MakePathSpeechBubble(
 	float radius)
 {
 	auto size = ImGui::GetFontSize();
-
-	//ImGui wants clockwise winding. Starting from the tip of the speech bubble go down, then across
-	//Angles are measured clockwise from the 3 o'clock position
 	auto tailWidth = size;
+
+	//Default is for the arrow to be 1/4 of the way across
 	auto leftOverhang = textsize.x / 4;
+
+	//Update overhang if the button would go off the start of the window
+	auto wpos = ImGui::GetWindowPos();
+	float minleft = wpos.x;
+	float farleft = anchorPos.x - (leftOverhang + radius);
+	float offLeftEdge = farleft - minleft;
+	if(offLeftEdge < 0)
+	{
+		//leftOverhang = 0.5*size;
+	}
+
 	auto rightOverhang = textsize.x - leftOverhang;
+
+	//ImGui wants clockwise winding. Starting from the tip of the speech bubble go down, then across
+	//Angles are measured clockwise from the 3 o'clock position
 	ImVec2 tailCorner(anchorPos.x, anchorPos.y + tailLength);
 	ImVec2 topRight(tailCorner.x + rightOverhang, tailCorner.y);
 	ImVec2 topRightRadiusCenter(topRight.x, topRight.y + radius);

src/ngscopeclient/TutorialWizard.h

@@ -50,7 +50,8 @@ class TutorialWizard : public Dialog
 	{
 		TUTORIAL_00_INTRO,
 		TUTORIAL_01_ADDINSTRUMENT,
-		TUTORIAL_02_CONNECT
+		TUTORIAL_02_CONNECT,
+		TUTORIAL_03_ACQUIRE
 	};
 
 	TutorialStep GetCurrentStep()

src/ngscopeclient/md/tutorial_03_acquire.md

@@ -0,0 +1,5 @@
+# Acquire Data
+
+We're connected to the scope. Let's start capturing data!
+
+Press the "normal trigger" button on the toolbar.