use super::{
ANGLE_TOLERANCE_DEG, MANUAL, NEW_DESIGN_CREATED, expected_tier,
goal::Goal,
model::{Guide, GuideCategory, GuideStep, StartingState},
perform::attach_performs,
steps::{STEPS, Step},
tour::welcome_tour_guide,
tutorials,
};
pub const WORKED_EXAMPLE_ID: &str = "new-design-walkthrough";
pub const HIGHLIGHT_TARGETS: &[&str] = &[
"",
"new_design_dialog",
"inspector_tier",
"design_settings",
"solve_button",
"tier_table",
"preform_tab",
"auto_solve",
"verdict_badge",
"deep_solve_button",
"optimize_tab",
"retarget_button",
"history_tab",
"snapshot_button",
"compare_button",
"solid_viewport",
"view_modes",
"cut_slider",
"snap_pill",
"slice_pill",
"live_render_tab",
"lighting_combo",
"cutting_mode_button",
"export_asc_button",
"export_menu",
"save_button",
"open_button",
"load_button",
"library_search",
"library_filters",
"library_import",
"mode_switch",
];
pub const EVENTS: &[&str] = &[
NEW_DESIGN_CREATED,
"palette_opened",
"tutorials_opened",
tutorials::TIERS_MULTI_SELECTED,
tutorials::solving_events::SOLVE_REQUESTED,
tutorials::solving_events::AUTO_SOLVE_OFF,
tutorials::solving_events::AUTO_SOLVE_ON,
tutorials::solving_events::VERDICT_OPENED,
tutorials::solving_events::DEEP_SOLVE_STARTED,
tutorials::solving_events::DEEP_SOLVE_FINISHED,
tutorials::solving_events::OPTIMIZE_PRESET_CHOSEN,
tutorials::solving_events::OPTIMIZE_RANGES_OPENED,
tutorials::solving_events::OPTIMIZE_FINISHED,
tutorials::solving_events::OPTIMIZE_CANDIDATE_PICKED,
tutorials::solving_events::VARIANTS_OPENED,
tutorials::solving_events::VARIANT_SAVED,
tutorials::solving_events::VARIANTS_COMPARED,
tutorials::solving_events::SNAPSHOT_TAKEN,
tutorials::solving_events::COMPARE_OPENED,
tutorials::solving_events::COMPARE_WINDOW_OPENED,
tutorials::solving_events::RAW_TEXT_DIFF_SHOWN,
tutorials::viewing_events::TIER_SELECTED,
tutorials::viewing_events::FACET_PICKED,
tutorials::viewing_events::SNAP_TOGGLED,
tutorials::viewing_events::SLICE_STARTED,
tutorials::viewing_events::SLICE_DRAWN,
tutorials::viewing_events::SLICE_FLIPPED,
tutorials::viewing_events::SLICE_CUTS_STONE,
tutorials::viewing_events::SLICE_SYMMETRIC_TOGGLED,
tutorials::viewing_events::CUT_SLIDER_ROUGH,
tutorials::viewing_events::CUT_SLIDER_STEP,
tutorials::viewing_events::CUT_SLIDER_FINISHED,
tutorials::viewing_events::DIAGRAM_PANEL_ENLARGED,
tutorials::viewing_events::CUTTING_STEP_MARKED,
tutorials::viewing_events::ASC_EXPORTED,
tutorials::viewing_events::GCS_EXPORTED,
tutorials::viewing_events::SHEET_EXPORTED,
tutorials::viewing_events::DIAGRAM_EXPORTED,
tutorials::viewing_events::DESIGN_SAVED,
tutorials::viewing_events::DESIGN_REPLACED,
tutorials::viewing_events::LIBRARY_IMPORTED,
tutorials::viewing_events::LIBRARY_SEARCHED,
tutorials::viewing_events::LIBRARY_SEARCH_CLEARED,
tutorials::viewing_events::LIBRARY_FILTERED,
tutorials::viewing_events::LIBRARY_FILTERS_RESET,
tutorials::viewing_events::LIBRARY_DESIGN_SELECTED,
tutorials::viewing_events::ROUGH_PLANNER_OPENED,
tutorials::viewing_events::ROUGH_PLAN_FINISHED,
tutorials::viewing_events::CUSTOM_MATERIAL_SAVED,
tutorials::viewing_events::COEFFICIENT_MATERIAL_SAVED,
tutorials::viewing_events::LIVE_RENDER_OPENED,
tutorials::viewing_events::LIGHTING_PRESET_CHOSEN,
tutorials::viewing_events::DESIGN_LIGHTING_SAVED,
tutorials::viewing_events::DESIGN_LIGHTING_FORGOTTEN,
tutorials::viewing_events::INTERFACE_MODE_CHANGED,
tutorials::viewing_events::HIGH_CONTRAST_CHANGED,
tutorials::viewing_events::UI_SCALE_CHANGED,
tutorials::viewing_events::LARGE_HANDLES_CHANGED,
tutorials::viewing_events::SHORTCUTS_OPENED,
tutorials::viewing_events::HELP_OPENED,
tutorials::viewing_events::GLOSSARY_OPENED,
];
#[must_use]
pub fn goal_from_completion(key: &str) -> Option<Goal> {
if key == MANUAL {
return Some(Goal::Manual);
}
if key == NEW_DESIGN_CREATED {
return Some(Goal::Event(NEW_DESIGN_CREATED.to_owned()));
}
match key {
"solved_closed" => return Some(Goal::SolvedClosed),
"yield_applied" => return Some(Goal::YieldApplied),
_ => {}
}
if let Some(material) = key.strip_prefix("material:") {
return Some(Goal::Material(material.to_owned()));
}
let name = key.strip_prefix("tier_named:")?;
let (angle_deg, indices) = expected_tier(name)?;
Some(Goal::TierMatches {
name: name.to_owned(),
angle_deg,
tol_deg: ANGLE_TOLERANCE_DEG,
indices: Some(indices.to_vec()),
constraint_kind: None,
})
}
fn guide_step_from(step: &Step) -> GuideStep {
GuideStep {
title: step.title.to_owned(),
intro: step.intro.to_owned(),
actions: step.actions.iter().map(|&a| a.to_owned()).collect(),
check: step.check.to_owned(),
why: step.why.to_owned(),
waiting: step.waiting.to_owned(),
highlight_target: step.highlight_target.to_owned(),
goal: goal_from_completion(step.completion).unwrap_or(Goal::Manual),
allow: step.allow.to_vec(),
perform: None,
}
}
#[must_use]
pub fn worked_example_guide() -> Guide {
let mut guide = Guide::new(
WORKED_EXAMPLE_ID,
"New design walkthrough",
"Build an 8-fold round brilliant from an empty design: girdle, pavilion, crown and table.",
GuideCategory::GettingStarted,
)
.starting(StartingState::CurrentDesign);
guide.steps = STEPS.iter().map(guide_step_from).collect();
guide
}
const BUILDERS: &[fn() -> Guide] = &[welcome_tour_guide, worked_example_guide];
#[must_use]
pub fn static_guides() -> Vec<Guide> {
let mut guides: Vec<Guide> = BUILDERS.iter().map(|build| build()).collect();
guides.extend(tutorials::all());
attach_performs(&mut guides);
guides
}
#[derive(Clone, Debug)]
pub struct GuideCatalog {
guides: Vec<Guide>,
built_in: usize,
}
impl Default for GuideCatalog {
fn default() -> Self {
Self::new()
}
}
impl GuideCatalog {
#[must_use]
pub fn new() -> Self {
let guides = static_guides();
let built_in = guides.len();
Self { guides, built_in }
}
#[must_use]
pub fn all(&self) -> &[Guide] {
&self.guides
}
#[must_use]
pub fn get(&self, id: &str) -> Option<&Guide> {
self.guides.iter().find(|guide| guide.id == id)
}
#[must_use]
pub fn is_generated(&self, id: &str) -> bool {
self.guides
.iter()
.skip(self.built_in)
.any(|guide| guide.id == id)
}
pub fn add_generated(&mut self, guide: Guide) -> Result<(), String> {
if let Some(problem) = guide.problem() {
return Err(problem);
}
if self
.guides
.iter()
.take(self.built_in)
.any(|built_in| built_in.id == guide.id)
{
return Err(format!("{:?} is the id of a built-in guide", guide.id));
}
match self
.guides
.iter()
.skip(self.built_in)
.position(|existing| existing.id == guide.id)
{
Some(offset) => self.guides[self.built_in + offset] = guide,
None => self.guides.push(guide),
}
Ok(())
}
}