Skip to content

Free, open-source 3D sculpting for Linux, macOS and Windows: dense meshes, remeshing, painting, built-in AI (image/text to 3D), Send to Unreal, game-ready LODs, Gaussian splats and OpenUSD.

Quick tour: ten slides for experienced sculptors, each with Show me

islandmedf65474c5756a
diff --git a/CMakeLists.txt b/CMakeLists.txt
index 098b371a..7d1cc007 100644
--- a/CMakeLists.txt
+++ b/CMakeLists.txt
@@ -363,6 +363,7 @@ if(SCULPTFORGE_BUILD_APP)
src/app/PanelProject.cpp
src/app/PanelSubTools.cpp
src/app/PanelSupport.cpp
+ src/app/QuickTour.cpp
src/app/PanelAi.cpp
src/app/PanelSupportCard.cpp
src/app/WhatsNewPopup.cpp
diff --git a/changes/feat-quick-tour.md b/changes/feat-quick-tour.md
new file mode 100644
index 00000000..72d73377
--- /dev/null
+++ b/changes/feat-quick-tour.md
@@ -0,0 +1,21 @@
+---
+whats_new: **Quick tour**: **Help > Quick tour** (or **Sculpted before? Take the quick tour** in the welcome) shows in
+ ten short slides where remeshing, dynamic topology, quad retopology, levels, masking, cut, brushes and baking are,
+ each with a **Show me** button that opens the panel. The guide has it too: Quick tour for experienced sculptors.
+highlight: A quick tour for experienced sculptors
+added: **Quick tour** (Help > Quick tour, the welcome, and once when the Classic sculpting keys are picked): ten
+ slides with pictures of SculptForge; **Show me** opens and flashes the panel while the tour waits in a bar at the
+ bottom. The last slide is about memberships; **Maybe later** closes it for good. Guide chapter
+ **Quick tour for experienced sculptors** (replaces the old comparison chapter).
+changed: The command search (F3) finds features by plain sculpting words: remesh, voxel, retopo, quads, multires,
+ groups, clip, trim, slice, folders, insert, kitbash, vertex color ("Quad Remesh (also: retopo)").
+testers:
+ - Windows at 150% scaling: Help > Quick tour; step through all ten slides with Next and Back; every picture is
+ sharp and the text fits without scrolling.
+ - Any OS: on slides 2 to 9 click Show me; the panel opens (in the right tray it scrolls to it and flashes), the
+ tour waits at the bottom, Back to the tour returns to the same slide.
+ - Any OS: F3, type "retopo", "multires", "kitbash", "trim": each finds the tool and shows "(also: ...)".
+ - Any OS: Edit > Preferences > Input, pick the Classic keys: a note offers the tour once; No thanks, restart,
+ pick them again: no note.
+---
+Reviewers: no third-party product names anywhere in the tour, the chapter or the search aliases (Tony 11-03).
diff --git a/docs/guide/quick-tour.md b/docs/guide/quick-tour.md
index 470df9e4..6c59a2be 100644
--- a/docs/guide/quick-tour.md
+++ b/docs/guide/quick-tour.md
@@ -1,7 +1,9 @@
# Quick tour for experienced sculptors
-You know how to sculpt; you just need to know where SculptForge keeps things. Here are ten stops, each with a
-picture of the panel it talks about.
+You know how to sculpt; you just need to know where SculptForge keeps things. This chapter is the same ten stops
+as the in-app tour: **Help > Quick tour**, or **Sculpted before? Take the quick tour** in the welcome. Each slide
+there has a **Show me** button that opens the panel it talks about and flashes it, while the tour waits in a small
+bar at the bottom of the view (**Back to the tour** brings it back).
The pictures are SculptForge in its default look and layout.
@@ -106,12 +108,13 @@ the top shelf paints into a texture instead (Auto UV runs first), with paint lay
Everything in this tour is free, and stays free. If SculptForge helps your work, a membership keeps it moving:
members vote on what we build next in #feature-vote on Discord, and Insiders get daily drops and preview builds.
-See [sculptforge.app/support.html](https://sculptforge.app/support.html).
+See [sculptforge.app/support.html](https://sculptforge.app/support.html). **Maybe later** on the tour's last slide
+closes it, and it doesn't come back by itself.
## Keys
**Edit > Preferences > Input > Style** picks the keys: **SculptForge** (the default), **Classic sculpting keys**,
-Blender or Maya. See
+Blender or Maya. Picking the Classic sculpting keys offers this tour once. See
[Keyboard and mouse](shortcuts.md).
## See also
diff --git a/src/app/App.h b/src/app/App.h
index d6d420c5..cf5094b3 100644
--- a/src/app/App.h
+++ b/src/app/App.h
@@ -405,6 +405,19 @@ private:
bool newLookCard_ = false;
bool newLookCardDone_ = false;
void chooseNewLook(bool tryIt);
+ // Help > Quick tour (QuickTour.cpp): ten slides for sculptors who know another app, each with a "Show me".
+ // Offered once (project.json "quick_tour_done"); the welcome and the Help menu always open it.
+ void showQuickTour(int slide = 0);
+ void offerQuickTour(); // the Classic sculpting keys were picked: a note offers the tour, once
+ void closeQuickTour();
+ void quickTourShowMe(int slide);
+ void drawQuickTour();
+ static int quickTourSlides();
+ bool quickTourOpen_ = false, quickTourAside_ = false, quickTourOffer_ = false, quickTourDone_ = false;
+ int quickTourSlide_ = 0;
+ bool quickTourOffersInTests_ = false; // UI tests: the offer only after the script's quick_tour_offers
+ std::string flashSubpalette_; // a Tool sub-palette "Show me" opened: scrolled to and flashed (Palettes.cpp)
+ double flashSubpaletteStart_ = 0.0;
double sculptSeconds_ = 0.0; // cumulative time in strokes (project.json)
bool supportReminderDone_ = false; // the reminder was shown (or turned off) once: never again (project.json)
bool supportReminderOpen_ = false;
@@ -1638,7 +1651,7 @@ private:
float move[3] = {0, 0, 0}, rotate[3] = {0, 0, 0}, scale = 100.0f;
} gizmo_;
// ---- end Gizmo 3D ----
- // ---- ZBrush feel (Input.cpp, docs/guide/coming-from-zbrush.md) ----
+ // ---- Classic sculpting keys (Input.cpp, docs/guide/quick-tour.md) ----
// Preferences > Input (the ZBrush or SculptForge key style), the Space QuickMenu, the intensities and Focal
// Shift (U / I / O), ZBrush's mask and polygroup keys, Shift-constrained straight strokes and the
// Shift+click, release Shift, drag roll.
diff --git a/src/app/Config.cpp b/src/app/Config.cpp
index ce97b801..2a3a9d07 100644
--- a/src/app/Config.cpp
+++ b/src/app/Config.cpp
@@ -589,6 +589,9 @@ void App::initActions() {
ICON_LC_GRADUATION_CAP, nullptr, nullptr, nullptr,
"A step-by-step lesson for complete beginners: a cute owl head from the default sphere, painted and "
"rendered, in about ten minutes.");
+ add("help.quick_tour", "Quick tour", "Help", nullptr, [this] { showQuickTour(0); }, ICON_LC_COMPASS, nullptr, nullptr,
+ nullptr, "Ten short slides for sculptors who know another app: where remeshing, dynamic topology, retopology, "
+ "levels, masking, cut, brushes and baking are, each with a Show me button.");
add("help.whats_new", "What's New", "Help", nullptr, [this] { showWhatsNew(); }, ICON_LC_SPARKLES, nullptr,
nullptr, nullptr, "What changed in this version and the ones before it (opens once by itself after an update).");
add("help.check_updates", "Check for updates", "Help", nullptr, [this] { startUpdateCheck(true); }, ICON_LC_REFRESH_CW,
diff --git a/src/app/Input.cpp b/src/app/Input.cpp
index 766d13ff..37df27b2 100644
--- a/src/app/Input.cpp
+++ b/src/app/Input.cpp
@@ -1,7 +1,7 @@
// SculptForge - open source digital sculpting
// SPDX-License-Identifier: GPL-3.0-or-later
//
-// The ZBrush feel (docs/guide/coming-from-zbrush.md): ZBrush's keys that SculptForge lacked (U Z Intensity, I RGB
+// The Classic sculpting keys (docs/guide/quick-tour.md): the keys SculptForge lacked (U Intensity, I RGB
// Intensity, O Focal Shift, Space QuickMenu, L LazyMouse, V switch colour, Ctrl+A / Ctrl+Shift+A / Ctrl+I /
// Ctrl+H for the mask, Ctrl+W group masked), Preferences > Input with the ZBrush and SculptForge key styles,
// the QuickMenu itself and Shift-constrained straight strokes. The mouse gestures live with the rest of the
@@ -341,6 +341,7 @@ void App::setInputStyle(int style) {
if (blenderStyle()) uiPrefs_.turntable = true; // Blender orbits as a turntable; Preferences > Input changes it
maskBrush_.on = false;
applyInputStyle();
+ if (uiPrefs_.inputStyle == 0) offerQuickTour(); // the Classic sculpting keys: the quick tour, once (QuickTour.cpp)
}
void App::applyInputStyle() {
diff --git a/src/app/Palettes.cpp b/src/app/Palettes.cpp
index e0b69557..50bfc6d1 100644
--- a/src/app/Palettes.cpp
+++ b/src/app/Palettes.cpp
@@ -275,6 +275,15 @@ bool App::subpalette(const char* id, const char* englishTitle) {
"Interface).",
"Tool");
}
+ if (flashSubpalette_ == id) { // the quick tour's "Show me" (QuickTour.cpp): scrolled into view and flashed
+ const double t = ImGui::GetTime() - flashSubpaletteStart_;
+ if (t < 0.1) ImGui::SetScrollHereY(0.1f);
+ if (t < 1.5)
+ dl->AddRectFilled(p, ImVec2(p.x + w, p.y + h), theme::u32(theme::accent, float(0.5 * (1.0 - t / 1.5))),
+ theme::rounding(2.0f * s));
+ else
+ flashSubpalette_.clear();
+ }
if (clicked) {
if (isOpen) {
open.erase(std::remove(open.begin(), open.end(), id), open.end());
@@ -562,6 +571,7 @@ void App::drawPalette_Help() {
menuAction(*this, "help.controls");
menuAction(*this, "help.guide");
menuAction(*this, "help.first_sculpt");
+ menuAction(*this, "help.quick_tour");
menuAction(*this, "help.whats_new");
menuAction(*this, "help.check_updates");
menuAction(*this, "ui.command_palette");
diff --git a/src/app/PanelProject.cpp b/src/app/PanelProject.cpp
index e2c9347d..aac32f16 100644
--- a/src/app/PanelProject.cpp
+++ b/src/app/PanelProject.cpp
@@ -117,6 +117,7 @@ void App::initProject() {
// remembers neither and keeps the Classic look with the ZBrush-style layout; the new-look card offers the
// new default once (PanelSupport.cpp).
newLookCardDone_ = prefs["new_look_card_done"].asBool(false);
+ quickTourDone_ = prefs["quick_tour_done"].asBool(false);
if (!uiPrefs_.lookSaved && !uiConfigDeterministic_) {
UiPrefs saved = uiPrefs_;
if (!lookFromJson(prefs["ui_look"], saved)) {
@@ -189,6 +190,7 @@ void App::saveProjectPrefs() {
prefs.set("ui_look", std::move(look));
}
prefs.set("new_look_card_done", newLookCardDone_);
+ prefs.set("quick_tour_done", quickTourDone_);
std::ofstream(fsPath(prefDir_ + "project.json"), std::ios::binary | std::ios::trunc) << prefs.dump(true);
}
diff --git a/src/app/PanelSupport.cpp b/src/app/PanelSupport.cpp
index 0427a883..ff1e8089 100644
--- a/src/app/PanelSupport.cpp
+++ b/src/app/PanelSupport.cpp
@@ -161,9 +161,15 @@ void App::drawSupportUi() {
ImGui::PopStyleColor();
if (ImGui::IsItemHovered())
ImGui::SetTooltip("Your first sculpt: a cute owl head from this sphere, step by step, in about ten minutes.");
+ // Sculpted before: the quick tour (QuickTour.cpp), where everything is in ten slides.
+ if (ImGui::Button(ICON_LC_COMPASS " Sculpted before? Take the quick tour##welcome.tour", ImVec2(-1, 0)))
+ showQuickTour(0);
+ if (ImGui::IsItemHovered())
+ ImGui::SetTooltip("Ten short slides: remeshing, dynamic topology, retopology, levels, masking, cut, "
+ "brushes and baking, each with a Show me button.");
ImGui::Spacing();
ImGui::TextWrapped("Hold Ctrl over any control to see what it does. The User Guide (Shift+F1) explains every "
- "tool, and Quick tour for experienced sculptors lists what is where.");
+ "tool, and the quick tour shows what is where.");
// The look (0.10.9, #U6): three cards, the first the default. Existing installs never see this window
// unless they open Help > Welcome, so nobody's look changes by itself.
ImGui::Spacing();
@@ -255,6 +261,7 @@ void App::drawSupportUi() {
}
ImGui::End();
}
+ drawQuickTour(); // QuickTour.cpp
if (newLookCard_ && !showWelcome_ && !supportCardOpen() && !whatsNew_ && !showWhatsNew_) {
// Once, after updating from before 0.10.7 (PanelProject.cpp): the new default look, never forced.
ImGui::SetNextWindowPos(ImVec2(c.x + c.w * 0.5f, c.y + c.h - 16.0f * s), ImGuiCond_Always, ImVec2(0.5f, 1.0f));
diff --git a/src/app/QuickTour.cpp b/src/app/QuickTour.cpp
new file mode 100644
index 00000000..d338164b
--- /dev/null
+++ b/src/app/QuickTour.cpp
@@ -0,0 +1,262 @@
+// SculptForge - open source digital sculpting
+// SPDX-License-Identifier: GPL-3.0-or-later
+//
+// Help > Quick tour: ten short slides for sculptors who already know another app, each with a screenshot of
+// SculptForge (docs/guide/images/quick-tour, made by tests/ui/quick_tour.sfui) and a "Show me" that opens the
+// panel and flashes it. The same text is the guide chapter quick-tour.md. Offered in the welcome, in the Help menu
+// and once when the Classic sculpting keys are picked; the last slide is about memberships and never comes back
+// by itself.
+#include "app/App.h"
+#include "app/Support.h"
+#include "app/Theme.h"
+
+#include <IconsLucide.h>
+#include <imgui.h>
+
+#include <algorithm>
+#include <cmath>
+#include <iterator>
+#include <string>
+
+namespace sf {
+
+namespace {
+
+struct TourSlide {
+ const char* title;
+ const char* image; // a guide image (UserGuide::image)
+ const char* text;
+ const char* section; // a Tool sub-palette to open and flash, or nullptr
+ const char* action; // the action "Show me" runs (opens the palette, the search or the Library); "@Label": the
+ // action with that label in the palette of the same name
+};
+
+// Keep in step with docs/guide/quick-tour.md.
+constexpr TourSlide kSlides[] = {
+ {"Where things are", "images/quick-tour/01-where.jpg",
+ "The menus along the top are sorted by task: Sculpt (brushes, strokes, alphas, symmetry), Paint, Mesh, View and "
+ "Render. The right tray holds the Tool palette: Parts, Geometry, Remesh, Masking, Cut, Bake and more. The shelves "
+ "around the view hold the brush, its size and strength, and the brush, stroke, alpha and material tiles. Lost? "
+ "Press F3 and type what you are after in your own words: remesh, retopo, groups, trim, multires.",
+ nullptr, "ui.command_palette"},
+ {"Voxel Remesh", "images/quick-tour/02-voxel.jpg",
+ "A fast remesh for blocking out. Pull shapes far out or merge pieces, then rebuild one even surface: open "
+ "Tool > Remesh in the right tray, set Resolution and click Voxel Remesh. A higher resolution keeps more detail. "
+ "The mask and vertex paint carry over, so you can keep going.",
+ "tool.remesh", "ui.palette.tool"},
+ {"Dynamic topology", "images/quick-tour/03-dynamic.jpg",
+ "Dynamic topology adds detail where you sculpt. Turn on Dynamic on the top shelf and the brush adds triangles "
+ "where it needs them and removes them where it doesn't; Detail sets how small they get. Pull horns, ears or "
+ "fingers out of a ball without remeshing. Wire (Shift+F) shows the new triangles.",
+ nullptr, "ui.palette.draw"},
+ {"Quad Remesh", "images/quick-tour/04-quad.jpg",
+ "Automatic quad retopology: Tool > Remesh > Quad Remesh rebuilds a sculpt as clean quads whose edge loops follow "
+ "the forms. Set Target Polygons and leave Keep Original on. Divide the result, then Project All (Tool > Parts) "
+ "brings the detail back. Draw Quad Remesh Guides to steer the loops.",
+ "tool.remesh", "ui.palette.tool"},
+ {"Levels, Parts and Face Groups", "images/quick-tour/05-levels.jpg",
+ "Ctrl+D divides and keeps the lower levels: Shift+D steps down, D steps up, and you can sculpt at any level "
+ "(Tool > Geometry). A scene holds several Parts (Tool > Parts); Alt+click one in the view to work on it. Face "
+ "Groups split a Part into coloured regions to hide, isolate or mask (Tool > Face Groups).",
+ "tool.geometry", "ui.palette.tool"},
+ {"Masking", "images/quick-tour/06-masking.jpg",
+ "Hold Ctrl and paint to mask, Ctrl+Alt to unmask. Tool > Masking inverts, blurs and grows the mask, and builds "
+ "one By cavity, By face group or along the border. Press G for the stroke popup: its Shapes row picks Mask Pen, "
+ "Mask Lasso or Mask Rect for the next Ctrl stroke.",
+ "tool.masking", "ui.palette.tool"},
+ {"Cut, Clip and Close Holes", "images/quick-tour/07-cut.jpg",
+ "Pick a shape in Tool > Cut and draw it with Ctrl+Shift: a line, lasso, rectangle or polyline goes straight "
+ "through the whole Part, and a closed Part stays closed. Cut it away, cut in, add, or Clip: press everything "
+ "outside the shape flat onto its outline. Close Holes (Tool > Geometry) caps every open boundary.",
+ "tool.cut", "ui.palette.tool"},
+ {"Brushes, alphas and the Library", "images/quick-tour/08-library.jpg",
+ "B opens the brush picker; type the first letters of a name to pick one. The Alpha tile picks the stamp shape. "
+ "The Library (comma) holds starter meshes, brushes, alphas, Lit Spheres and snapshots. A pack (.sfpack) brings "
+ "brushes, alphas and Lit Spheres in one file; File > Install Pack shows what is inside before anything is "
+ "installed.",
+ nullptr, "@Library"},
+ {"Baking and texturing", "images/quick-tour/09-bake.jpg",
+ "Tool > Bake makes normal, displacement, ambient occlusion, cavity and colour maps from your sculpt onto a "
+ "low-poly Part with UVs, in the background. P picks the Paint brush for vertex paint; New Texture on the top "
+ "shelf paints into a texture instead (Auto UV runs first), with paint layers and material channels.",
+ "tool.bake", "ui.palette.tool"},
+ {"SculptForge stays free", "images/wn-first-sculpt.jpg",
+ "Everything in this tour is free, and stays free. If SculptForge helps your work, a membership keeps it moving: "
+ "members vote on what we build next in #feature-vote on Discord, and Insiders get daily drops and preview "
+ "builds.",
+ nullptr, nullptr},
+};
+constexpr int kSlideCount = int(std::size(kSlides));
+
+} // namespace
+
+int App::quickTourSlides() { return kSlideCount; }
+
+void App::showQuickTour(int slide) {
+ quickTourOpen_ = true;
+ quickTourAside_ = false;
+ quickTourOffer_ = false;
+ quickTourSlide_ = std::clamp(slide, 0, kSlideCount - 1);
+ showWelcome_ = false;
+ if (!quickTourDone_) {
+ quickTourDone_ = true; // offered once: from now on only the welcome and the Help menu open it
+ saveProjectPrefs();
+ }
+}
+
+void App::offerQuickTour() {
+ if (uiConfigDeterministic_ && !quickTourOffersInTests_) return; // (UiTest.cpp: quick_tour_offers)
+ if (!quickTourDone_ && !quickTourOpen_) quickTourOffer_ = true;
+}
+
+void App::closeQuickTour() {
+ quickTourOpen_ = quickTourAside_ = false;
+}
+
+void App::quickTourShowMe(int slide) {
+ const TourSlide& s = kSlides[std::clamp(slide, 0, kSlideCount - 1)];
+ if (!s.action) return;
+ quickTourAside_ = true; // out of the way: a small "Back to the tour" bar instead
+ if (s.section) {
+ auto& open = layout_.openSubpalettes;
+ if (uiPrefs_.oneSubpalette) // as a click on its header would: the other Tool sub-palettes close
+ open.erase(std::remove_if(open.begin(), open.end(), [](const std::string& o) { return o.rfind("tool.", 0) == 0; }),
+ open.end());
+ if (std::find(open.begin(), open.end(), s.section) == open.end()) open.push_back(s.section);
+ flashSubpalette_ = s.section;
+ flashSubpaletteStart_ = ImGui::GetTime();
+ }
+ const Action* a = actions_.find(s.action);
+ if (s.action[0] == '@')
+ for (const Action& other : actions_.all())
+ if (other.label == s.action + 1 && other.palette == s.action + 1) a = &other;
+ if (a && a->run) a->run();
+ status_ = std::string("Quick tour: ") + s.title;
+}
+
+void App::drawQuickTour() {
+ const float s = uiScale_;
+ const CanvasRect c = canvasRect();
+ if (quickTourOffer_ && !quickTourOpen_ && !showWelcome_) {
+ // Once, when the Classic sculpting keys are picked: a quiet note along the bottom, no focus taken.
+ ImGui::SetNextWindowPos(ImVec2(c.x + c.w * 0.5f, c.y + c.h - 12.0f * s), ImGuiCond_Always, ImVec2(0.5f, 1.0f));
+ ImGui::SetNextWindowBgAlpha(0.94f);
+ const ImGuiWindowFlags flags = ImGuiWindowFlags_NoDecoration | ImGuiWindowFlags_AlwaysAutoResize |
+ ImGuiWindowFlags_NoSavedSettings | ImGuiWindowFlags_NoFocusOnAppearing |
+ ImGuiWindowFlags_NoNav | ImGuiWindowFlags_NoMove;
+ if (ImGui::Begin("##quicktour_offer", nullptr, flags)) {
+ ImGui::AlignTextToFramePadding();
+ ImGui::TextUnformatted("New to SculptForge? A two-minute tour shows where everything is.");
+ ImGui::SameLine();
+ if (ImGui::SmallButton("Take the tour##quicktour.offer")) showQuickTour(0);
+ ImGui::SameLine();
+ if (ImGui::SmallButton("No thanks##quicktour.offer")) {
+ quickTourOffer_ = false;
+ quickTourDone_ = true;
+ saveProjectPrefs();
+ }
+ }
+ ImGui::End();
+ }
+ if (!flashSubpalette_.empty() && ImGui::GetTime() - flashSubpaletteStart_ < 1.6) redrawIn(0.03); // the flash fades
+ if (!quickTourOpen_) return;
+ const int i = std::clamp(quickTourSlide_, 0, kSlideCount - 1);
+ const TourSlide& slide = kSlides[i];
+ const bool last = i == kSlideCount - 1;
+ if (quickTourAside_) {
+ // "Show me" opened a panel: the tour waits as a small bar along the bottom of the view.
+ ImGui::SetNextWindowPos(ImVec2(c.x + c.w * 0.5f, c.y + c.h - 12.0f * s), ImGuiCond_Always, ImVec2(0.5f, 1.0f));
+ ImGui::SetNextWindowBgAlpha(0.94f);
+ const ImGuiWindowFlags flags = ImGuiWindowFlags_NoDecoration | ImGuiWindowFlags_AlwaysAutoResize |
+ ImGuiWindowFlags_NoSavedSettings | ImGuiWindowFlags_NoFocusOnAppearing |
+ ImGuiWindowFlags_NoNav | ImGuiWindowFlags_NoMove;
+ if (ImGui::Begin("##quicktour_aside", nullptr, flags)) {
+ ImGui::AlignTextToFramePadding();
+ ImGui::Text("Quick tour %d / %d: %s", i + 1, kSlideCount, slide.title);
+ ImGui::SameLine();
+ if (ImGui::SmallButton("Back to the tour##quicktour")) quickTourAside_ = false;
+ ImGui::SameLine();
+ if (ImGui::SmallButton("Next##quicktour.aside")) {
+ quickTourSlide_ = std::min(i + 1, kSlideCount - 1);
+ quickTourAside_ = false;
+ }
+ ImGui::SameLine();
+ if (ImGui::SmallButton("Close##quicktour.aside")) closeQuickTour();
+ }
+ ImGui::End();
+ return;
+ }
+ const float w = std::min(680.0f * s, c.w - 32.0f * s);
+ // The top stays put and every slide is as tall (a fixed picture band and text box), so Next doesn't move.
+ ImGui::SetNextWindowPos(ImVec2(c.x + c.w * 0.5f, c.y + std::max(16.0f * s, c.h * 0.08f)), ImGuiCond_Appearing,
+ ImVec2(0.5f, 0.0f));
+ ImGui::SetNextWindowSize(ImVec2(w, 0.0f), ImGuiCond_Always);
+ bool open = true;
+ const ImGuiWindowFlags flags = ImGuiWindowFlags_NoCollapse | ImGuiWindowFlags_NoSavedSettings | ImGuiWindowFlags_NoResize;
+ if (ImGui::Begin("New to SculptForge? A quick tour##quicktour", &open, flags)) {
+ // The picture: a screenshot of the part of SculptForge the slide is about, in a band of one height.
+ const float iw = ImGui::GetContentRegionAvail().x, band = std::floor(std::min(iw * 0.577f, 360.0f * s));
+ const ImVec2 at = ImGui::GetCursorScreenPos();
+ ImVec2 size;
+ if (const ImTextureID tex = guide_.image(slide.image, &size); tex && size.x > 0.0f && size.y > 0.0f) {
+ const float k = std::min(iw / size.x, band / size.y);
+ const ImVec2 shown(std::floor(size.x * k), std::floor(size.y * k));
+ const ImVec2 a(std::floor(at.x + (iw - shown.x) * 0.5f), std::floor(at.y + (band - shown.y) * 0.5f));
+ ImGui::GetWindowDrawList()->AddImageRounded(tex, a, ImVec2(a.x + shown.x, a.y + shown.y), ImVec2(0, 0), ImVec2(1, 1),
+ IM_COL32_WHITE, theme::rounding(4.0f * s));
+ }
+ ImGui::Dummy(ImVec2(iw, band));
+ ImGui::Spacing();
+ ImGui::TextDisabled("%d / %d", i + 1, kSlideCount);
+ ImGui::SameLine();
+ if (fontBold_) ImGui::PushFont(fontBold_);
+ ImGui::TextUnformatted(slide.title);
+ if (fontBold_) ImGui::PopFont();
+ ImGui::Spacing();
+ const float textTop = ImGui::GetCursorPosY();
+ ImGui::TextWrapped("%s", slide.text);
+ if (last) {
+ ImGui::Spacing();
+ ImGui::TextDisabled("%s", kSupportUrl + 8); // "sculptforge.app/support.html"
+ }
+ const float box = 5.0f * ImGui::GetTextLineHeightWithSpacing(); // the longest slide's lines at this width
+ if (ImGui::GetCursorPosY() < textTop + box) ImGui::Dummy(ImVec2(0, textTop + box - ImGui::GetCursorPosY()));
+ ImGui::Spacing();
+ ImGui::Separator();
+ ImGui::Spacing();
+ const ImVec4 accent = ImGui::GetStyleColorVec4(ImGuiCol_ButtonActive);
+ if (last) {
+ ImGui::PushStyleColor(ImGuiCol_Button, accent);
+ if (ImGui::Button(ICON_LC_HEART " See memberships##quicktour")) openSupportPage();
+ ImGui::PopStyleColor();
+ if (ImGui::IsItemHovered()) ImGui::SetTooltip("Opens sculptforge.app/support.html in your browser.");
+ ImGui::SameLine();
+ if (ImGui::Button("Maybe later##quicktour")) closeQuickTour(); // and it never comes back by itself
+ } else if (slide.action) {
+ ImGui::PushStyleColor(ImGuiCol_Button, accent);
+ if (ImGui::Button(ICON_LC_EYE " Show me##quicktour")) quickTourShowMe(i);
+ ImGui::PopStyleColor();
+ if (ImGui::IsItemHovered()) ImGui::SetTooltip("Opens it in SculptForge; the tour waits at the bottom.");
+ }
+ // Back and Next at the right.
+ const ImGuiStyle& st = ImGui::GetStyle();
+ const char* next = last ? "Done##quicktour" : "Next##quicktour";
+ const float bw = ImGui::CalcTextSize("Back").x + ImGui::CalcTextSize(last ? "Done" : "Next").x + 4.0f * st.FramePadding.x +
+ st.ItemSpacing.x;
+ ImGui::SameLine(std::max(ImGui::GetCursorPosX(), ImGui::GetWindowContentRegionMax().x - bw));
+ ImGui::BeginDisabled(i == 0);
+ if (ImGui::Button("Back##quicktour")) quickTourSlide_ = i - 1;
+ ImGui::EndDisabled();
+ ImGui::SameLine();
+ if (ImGui::Button(next)) {
+ if (last) closeQuickTour();
+ else quickTourSlide_ = i + 1;
+ }
+ if (ImGui::IsKeyPressed(ImGuiKey_RightArrow, false) && ImGui::IsWindowFocused() && !last) quickTourSlide_ = i + 1;
+ if (ImGui::IsKeyPressed(ImGuiKey_LeftArrow, false) && ImGui::IsWindowFocused() && i > 0) quickTourSlide_ = i - 1;
+ }
+ ImGui::End();
+ if (!open) closeQuickTour();
+}
+
+} // namespace sf
diff --git a/src/app/UiTest.cpp b/src/app/UiTest.cpp
index cecccf82..cd8406bc 100644
--- a/src/app/UiTest.cpp
+++ b/src/app/UiTest.cpp
@@ -699,6 +699,13 @@ double Demo::query(const std::string& name, bool& known) const {
if (name == "ai_enabled") return ai::aiEnabled() ? 1.0 : 0.0; // Preferences > AI (PanelAi.cpp)
if (name == "http_requests") return double(ai::httpRequestCount()); // every request this process started
if (name == "welcome_open") return app_.showWelcome_ ? 1.0 : 0.0;
+ // Help > Quick tour (QuickTour.cpp): open, the slide (1-based), waiting aside after Show me, the one offer.
+ if (name == "quick_tour_open") return app_.quickTourOpen_ ? 1.0 : 0.0;
+ if (name == "quick_tour_slide") return double(app_.quickTourSlide_ + 1);
+ if (name == "quick_tour_aside") return app_.quickTourAside_ ? 1.0 : 0.0;
+ if (name == "quick_tour_offer") return app_.quickTourOffer_ ? 1.0 : 0.0;
+ if (name == "quick_tour_done") return app_.quickTourDone_ ? 1.0 : 0.0;
+ if (name == "dropdown_open") return app_.dropdown_.empty() ? 0.0 : 1.0;
if (name == "new_look_card_open") return app_.newLookCard_ ? 1.0 : 0.0; // "SculptForge has a new look" (0.10.7)
if (name == "support_card_open") return app_.supportCardOpen() ? 1.0 : 0.0; // the support card at launch
// What's New (WhatsNewPopup.cpp): open (1 while shown), its cards, Try it clicks; the guide chapter's contents
@@ -1688,6 +1695,11 @@ bool Demo::parseStep(int line, const std::vector<std::string>& w, std::string& e
app_.handleEvent(e);
});
wait(0.2f);
+ } else if (verb == "classic_keys") { // the Classic sculpting keys (style 0), as Preferences > Input sets them
+ run([this] { app_.setInputStyle(0); });
+ } else if (verb == "quick_tour_offers") {
+ // quick_tour_offers: UI tests leave out the quick tour's one offer (it would sit over their clicks)
+ run([this] { app_.quickTourOffersInTests_ = true; });
} else if (verb == "input_style") {
// input_style zbrush|sculptforge|blender|maya: as Preferences > Input sets it (scripts written for one style)
if (!need(1)) return false;
diff --git a/tests/ui/quick_tour.sfui b/tests/ui/quick_tour.sfui
new file mode 100644
index 00000000..829e19a7
--- /dev/null
+++ b/tests/ui/quick_tour.sfui
@@ -0,0 +1,181 @@
+# Help > Quick tour (src/app/QuickTour.cpp, docs/guide/quick-tour.md): ten slides, each "Show me" opens its panel.
+# The slides' and the guide's pictures come from this run, in the default look and the SculptForge layout:
+# build/sculptforge --ui-test tests/ui/quick_tour.sfui --ui-out build/quick-tour
+# python3 tools/guide/make_images.py --quick-tour build/quick-tour
+expect_value look == 1
+expect_value shell_layout == 1
+run new_starter_mesh name=human-head
+camera -25 -6
+key f
+wait_idle 30
+
+# Picking the Classic sculpting keys offers the tour once, with a note along the bottom; No thanks is for good.
+expect_value quick_tour_done == 0
+quick_tour_offers
+classic_keys
+expect_value quick_tour_offer == 1
+shot offer
+click "No thanks##quicktour.offer"
+expect_value quick_tour_offer == 0
+expect_value quick_tour_done == 1
+input_style sculptforge
+classic_keys
+expect_value quick_tour_offer == 0
+input_style sculptforge
+
+# The ways in: the welcome's button and Help > Quick tour.
+key f3
+type "##Command palette" "welcome"
+key enter
+expect_value welcome_open == 1
+hover_window 0.99 0.99
+wait 0.2
+shot welcome
+click "Sculpted before? Take the quick tour##welcome.tour"
+expect_value welcome_open == 0
+expect_value quick_tour_open == 1
+expect_value quick_tour_slide == 1
+expect_value quick_tour_done == 1
+expect_text Where things are
+shot tour-01
+
+# 1. Show me opens the search; the tour waits at the bottom.
+click "Show me##quicktour"
+expect_value quick_tour_aside == 1
+expect_value command_palette_open == 1
+type "##Command palette" "retopo"
+expect_text "also: retopo"
+wait 0.3
+mouse_leave
+wait 0.2
+shot 01-where
+key escape
+click "Back to the tour##quicktour"
+expect_value quick_tour_aside == 0
+
+# 2. Voxel Remesh: Tool > Remesh opens and flashes.
+click "Next##quicktour"
+expect_value quick_tour_slide == 2
+expect_text Voxel Remesh
+shot tour-02
+click "Show me##quicktour"
+expect_value quick_tour_aside == 1
+expect_value right_tray_open == 1
+wait 1.6
+expect_text Resolution
+mouse_leave
+wait 0.2
+shot 02-voxel
+key escape
+click "Next##quicktour.aside"
+
+# 3. Dynamic topology: Sculpt > Draw & Tablet.
+expect_value quick_tour_slide == 3
+shot tour-03
+click "Show me##quicktour"
+expect_value dropdown_open == 1
+wait 0.3
+expect_text Detail
+mouse_leave
+wait 0.2
+shot 03-dynamic
+key escape
+click "Next##quicktour.aside"
+
+# 4. Quad Remesh: Tool > Remesh again, Quad Remesh at its top.
+expect_value quick_tour_slide == 4
+shot tour-04
+click "Show me##quicktour"
+wait 1.6
+expect_text Target Polygons
+mouse_leave
+wait 0.2
+shot 04-quad
+key escape
+click "Next##quicktour.aside"
+
+# 5. Levels, Parts and Face Groups: Tool > Geometry.
+expect_value quick_tour_slide == 5
+shot tour-05
+click "Show me##quicktour"
+wait 1.6
+expect_text Divide
+mouse_leave
+wait 0.2
+shot 05-levels
+key escape
+click "Next##quicktour.aside"
+
+# 6. Masking: Tool > Masking.
+expect_value quick_tour_slide == 6
+shot tour-06
+click "Show me##quicktour"
+wait 1.6
+expect_text By cavity
+mouse_leave
+wait 0.2
+shot 06-masking
+key escape
+click "Next##quicktour.aside"
+
+# 7. Cut: Tool > Cut.
+expect_value quick_tour_slide == 7
+shot tour-07
+click "Show me##quicktour"
+wait 1.6
+expect_text Clip
+mouse_leave
+wait 0.2
+shot 07-cut
+key escape
+click "Next##quicktour.aside"
+
+# 8. Brushes, alphas and the Library: the Library opens.
+expect_value quick_tour_slide == 8
+shot tour-08
+click "Show me##quicktour"
+click "Library/Brush"
+wait 0.5
+mouse_leave
+wait 0.2
+shot 08-library
+key comma
+expect_not "Library/Brush"
+click "Next##quicktour.aside"
+
+# 9. Baking and texturing: Tool > Bake.
+expect_value quick_tour_slide == 9
+shot tour-09
+click "Show me##quicktour"
+wait 1.6
+expect_text Bake
+mouse_leave
+wait 0.2
+shot 09-bake
+key escape
+click "Next##quicktour.aside"
+
+# 10. Last: memberships, friendly. See memberships opens the page (the status bar in tests); Maybe later closes.
+expect_value quick_tour_slide == 10
+expect_text SculptForge stays free
+expect_text feature-vote
+expect_no_text "Show me"
+shot tour-10
+remember support_requests s0
+click "See memberships##quicktour"
+expect_value support_requests == $s0+1
+click "Maybe later##quicktour"
+expect_value quick_tour_open == 0
+
+# Help > Quick tour always opens it; Back and the close box work.
+click "Help##menu.help"
+click "Quick tour##help.quick_tour"
+expect_value quick_tour_open == 1
+expect_value quick_tour_slide == 1
+click "Next##quicktour"
+click "Back##quicktour"
+expect_value quick_tour_slide == 1
+click "Show me##quicktour"
+key escape
+click "Close##quicktour.aside"
+expect_value quick_tour_open == 0
diff --git a/tools/guide/make_images.py b/tools/guide/make_images.py
index c4379039..efbc1a8a 100644
--- a/tools/guide/make_images.py
+++ b/tools/guide/make_images.py
@@ -290,6 +290,25 @@ def first_sculpt(shots: pathlib.Path) -> list:
return made
+# The quick tour (quick-tour.md, src/app/QuickTour.cpp; tests/ui/quick_tour.sfui): name -> crop in the 1600x960
+# window, each the whole model with the panel "Show me" opened, at the slide's shape (1170x674).
+def _crop(x0, y0):
+ return (x0, y0, x0 + 1170, y0 + 674)
+
+
+QUICK_TOUR = {
+ "01-where": _crop(200, 40), "02-voxel": _crop(430, 140), "03-dynamic": _crop(250, 40), "04-quad": _crop(430, 140),
+ "05-levels": _crop(430, 140), "06-masking": _crop(430, 140), "07-cut": _crop(430, 140),
+ "08-library": _crop(90, 40), "09-bake": _crop(430, 140),
+}
+
+
+def quick_tour(shots: pathlib.Path) -> list:
+ (OUT / "quick-tour").mkdir(parents=True, exist_ok=True)
+ return [save(Image.open(shots / f"{name}.png").convert("RGB").crop(box), f"quick-tour/{name}", 1100)
+ for name, box in QUICK_TOUR.items()]
+
+
def main() -> int:
ap = argparse.ArgumentParser(description=__doc__, formatter_class=argparse.RawDescriptionHelpFormatter)
ap.add_argument("shots", type=pathlib.Path, help="folder with the screenshots (--ui-out of shots.sfui)")
@@ -298,6 +317,8 @@ def main() -> int:
ap.add_argument("--only", action="append", help="make only this image (repeatable), e.g. --only qremesh-guides")
ap.add_argument("--first-sculpt", action="store_true",
help="the shots are tests/ui/first_sculpt.sfui's: make images/first-sculpt/*.jpg")
+ ap.add_argument("--quick-tour", action="store_true",
+ help="the shots are tests/ui/quick_tour.sfui's: make images/quick-tour/*.jpg")
ap.add_argument("--whats-new", action="store_true", help="make only the What's New pictures (whats_new_shots.sfui)")
args = ap.parse_args()
OUT.mkdir(parents=True, exist_ok=True)
@@ -305,6 +326,10 @@ def main() -> int:
for p in first_sculpt(args.shots):
print(f"{p.relative_to(ROOT)} {p.stat().st_size // 1024} KB")
return 0
+ if args.quick_tour:
+ for p in quick_tour(args.shots):
+ print(f"{p.relative_to(ROOT)} {p.stat().st_size // 1024} KB")
+ return 0
if args.whats_new:
for name, (shot, box) in WHATS_NEW.items():
src = args.shots / f"{shot}.png"