mirror of
https://github.com/storytold/vectorcraft.git
synced 2026-11-18 23:31:18 +00:00
Object › Plug-ins › Packaging Tools is a new built-in add-on for the dielines of boxes and other folded packaging. A path, compound path or live shape is a fold line when its top stroke is painted with the swatch of a line role: Cut, Crease, Partial Cut or Perforation. Each document has a role table (`packagingRoles`) that names the swatch of each role. By default the swatches are named after the roles. Native files keep the table and the strokes. PDF prints a role line on its swatch's separation when the swatch is a spot color, as the default role swatches are. SVG, DXF and HP-GL keep the stroke's color, so the default role swatches come out as four colors. - `addon.packaging.setRole` (Make Cut Line, Make Crease Line, Make Partial Cut Line, Make Perforation Line) paints the top stroke of each path among the objects with the role's swatch at 100%, through groups and clip groups. Locked and hidden objects are left out, also when named by id. A path without a stroke gets a 1 pt stroke, a hidden stroke is shown, and the stroke overprints unless `overprint` is false. A missing role swatch is made as a global spot swatch in the document's color mode (Cut 100% magenta, Crease 100% cyan, Partial Cut 100% yellow, Perforation 50% magenta and 50% cyan). When a color group or a swatch that can't carry a role has that name, the swatch is made as "Cut 2" and so on. `none` takes the role away and keeps the color. One undo step, none when nothing changes. - `addon.packaging.roles` counts each role in the selection, or in the document while nothing is selected, locked and hidden lines included. The Fold Lines panel shows these counts, gives the selected paths a role when a row is clicked, and says when nothing is selected. - `addon.packaging.setRoleSwatch` (the panel menu's Role Swatches…) makes another global or spot color swatch carry a role. It refuses missing, gradient, pattern, process, tint, [None] and [Registration] swatches and a swatch another role has. When `swatch.edit` renames a role swatch, the role stays with it under the new name. When it turns Global off, the role moves to a new swatch name that the next Make … Line makes. When `swatch.merge` merges a role swatch into a global swatch that carries no role, the kept swatch takes the role. Docs: docs/mcp.md (Packaging Tools add-on) and ROADMAP.
135 lines
5.9 KiB
Rust
135 lines
5.9 KiB
Rust
//! Packaging Tools' submenu (Object › Plug-ins › Packaging Tools) and its Fold Lines panel. The
|
||
//! panel lists the fold line roles, each with its swatch's chip and how many of the selected objects
|
||
//! have it (of the whole document while nothing is selected); clicking a role gives the selected
|
||
//! paths that role (`addon.packaging.setRole`). Its menu's Role Swatches… picks the swatch that
|
||
//! carries a role (`addon.packaging.setRoleSwatch`).
|
||
|
||
use egui::{Align, Layout, Sense, Ui, vec2};
|
||
use serde_json::{Value, json};
|
||
|
||
use crate::VectorcraftApp;
|
||
use crate::menus::Item;
|
||
use crate::panels::{empty_state, pstate, set_pstate};
|
||
use crate::widgets::{self, dim_label};
|
||
|
||
/// The panel's id (`window.panel {panel: "foldLines"}`).
|
||
pub const ID: &str = "foldLines";
|
||
/// The command that gives objects a role.
|
||
pub const SET_ROLE: &str = "addon.packaging.setRole";
|
||
/// The command that picks a role's swatch.
|
||
pub const SET_ROLE_SWATCH: &str = "addon.packaging.setRoleSwatch";
|
||
/// The roles by name, as `addon.packaging.setRole` and Role Swatches… take them.
|
||
pub const ROLES: &[(&str, &str)] =
|
||
&[("Cut Line", "cut"), ("Crease Line", "crease"), ("Partial Cut Line", "partialCut"), ("Perforation Line", "perforation")];
|
||
|
||
/// Where the panel keeps the last `addon.packaging.roles` answer (panel state).
|
||
const STATE: &str = "fold-lines";
|
||
|
||
/// Object › Plug-ins › Packaging Tools.
|
||
pub fn menu() -> Vec<Item> {
|
||
let make = |label, role: &str| Item::Cmd(label, SET_ROLE, json!({ "role": role }));
|
||
vec![
|
||
Item::Cmd("Fold Lines", "window.panel", json!({ "panel": ID })),
|
||
Item::Sep,
|
||
make("Make Cut Line", "cut"),
|
||
make("Make Crease Line", "crease"),
|
||
make("Make Partial Cut Line", "partialCut"),
|
||
make("Make Perforation Line", "perforation"),
|
||
]
|
||
}
|
||
|
||
/// One role row: (role id, swatch name, the swatch's paint if the document has it, count).
|
||
type Row = (String, String, Option<vectorcraft_color::Paint>, u64);
|
||
|
||
/// The panel's rows for one document state.
|
||
#[derive(Clone, Default)]
|
||
struct Rows {
|
||
/// What they were read for: the document, its revision and its selection.
|
||
key: Option<(u64, u64, Vec<u64>)>,
|
||
rows: Vec<Row>,
|
||
}
|
||
|
||
/// The rows for the active document as it is now, read again only when it changed.
|
||
fn rows(app: &mut VectorcraftApp, ctx: &egui::Context) -> Vec<Row> {
|
||
let Some(st) = app.session.active() else { return vec![] };
|
||
let key = (st.uid, st.revision, st.selection.objects.iter().map(|id| id.0).collect::<Vec<_>>());
|
||
let mut kept: Rows = pstate(ctx, STATE);
|
||
if kept.key.as_ref() == Some(&key) {
|
||
return kept.rows;
|
||
}
|
||
let answer = app.session.execute("addon.packaging.roles", &json!({})).unwrap_or(Value::Null);
|
||
let d = app.session.active().map(|st| st.doc.clone());
|
||
let row = |r: &Value| {
|
||
let swatch = r["swatch"].as_str()?.to_string();
|
||
let paint = d.as_ref().and_then(|d| d.swatch(&swatch)).map(|s| s.paint.clone());
|
||
Some((r["role"].as_str()?.to_string(), swatch, paint, r["count"].as_u64()?))
|
||
};
|
||
kept = Rows { key: Some(key), rows: answer["roles"].as_array().into_iter().flatten().filter_map(row).collect() };
|
||
set_pstate(ctx, STATE, kept.clone());
|
||
kept.rows
|
||
}
|
||
|
||
pub fn show(app: &mut VectorcraftApp, ui: &mut Ui) {
|
||
let Some(st) = app.session.active() else {
|
||
empty_state(ui, "scissors", tl!("No document"), tl!("Open a document to mark its fold lines."));
|
||
return;
|
||
};
|
||
let selected = !st.selection.is_empty();
|
||
if !selected {
|
||
dim_label(ui, tl!("No objects are selected."));
|
||
ui.add_space(4.0);
|
||
}
|
||
let mut picked = None;
|
||
for (role, swatch, paint, count) in rows(app, ui.ctx()) {
|
||
let label = ROLES.iter().find(|(_, id)| *id == role).map_or(role.as_str(), |(l, _)| *l);
|
||
let clicked = ui
|
||
.add_enabled_ui(selected, |ui| {
|
||
ui.horizontal(|ui| {
|
||
let (chip, _) = ui.allocate_exact_size(vec2(14.0, 14.0), Sense::hover());
|
||
widgets::paint_chip(ui, chip, paint.as_ref().unwrap_or(&vectorcraft_color::Paint::None));
|
||
let resp = ui.selectable_label(false, tl!(label)).on_hover_text(swatch.as_str());
|
||
ui.with_layout(Layout::right_to_left(Align::Center), |ui| dim_label(ui, &count.to_string()));
|
||
resp.clicked()
|
||
})
|
||
.inner
|
||
})
|
||
.inner;
|
||
if clicked {
|
||
picked = Some(role);
|
||
}
|
||
}
|
||
if let Some(role) = picked
|
||
&& let Err(e) = app.run(SET_ROLE, json!({ "role": role }))
|
||
{
|
||
app.status(e);
|
||
}
|
||
}
|
||
|
||
/// Role Swatches… (the dialog of `addon.packaging.setRoleSwatch`): when another role is picked, its
|
||
/// Swatch field shows that role's current swatch. `__role` keeps the role the field was filled for.
|
||
pub(crate) fn follow_role(app: &mut VectorcraftApp, d: &mut crate::state::Dialog) {
|
||
let role = d.str("role");
|
||
if d.str("__role") == role {
|
||
return;
|
||
}
|
||
let answer = app.session.execute("addon.packaging.roles", &json!({})).unwrap_or(Value::Null);
|
||
let current = answer["roles"].as_array().into_iter().flatten().find(|r| r["role"] == role.as_str()).and_then(|r| r["swatch"].as_str());
|
||
if let Some(swatch) = current {
|
||
d.fields.insert("swatch".into(), json!(swatch));
|
||
}
|
||
d.fields.insert("__role".into(), json!(role));
|
||
}
|
||
|
||
/// The panel's ≡ menu: Role Swatches… opens the options of `addon.packaging.setRoleSwatch` on the
|
||
/// Cut role and its current swatch.
|
||
pub fn panel_menu(app: &mut VectorcraftApp, ui: &mut Ui) {
|
||
if widgets::menu_item(ui, tl!("Role Swatches…"), app.session.active().is_some(), false) {
|
||
let swatch = rows(app, ui.ctx()).into_iter().find(|r| r.0 == "cut").map_or_else(|| "Cut".to_string(), |r| r.1);
|
||
let (id, p) = crate::menus::click_target("Role Swatches…", SET_ROLE_SWATCH, &json!({ "role": "cut", "swatch": swatch }));
|
||
crate::menus::invoke(app, &id, p);
|
||
}
|
||
}
|
||
|
||
#[cfg(test)]
|
||
mod tests;
|