Status

right now, this PR is just a rough hard-coding of the type of code that a macro like #[sketchlist] would generate.

Aesthetically (in both the UI and the macros) there is a bit to figure out still, but the foundation seems solid enough.

Todo

• [ ] Add sketchlist macro. The scratch commit in this PR has it as an attribute macro, but that might be kind of clunky since it needs to apply to an item. In this case, a module is the only semi-appropriate item, and even that feels clunky since its contents are not really going to be passed through to the resulting code. A better choice might be a proc macro function-like macro.
• [ ] Prettier sketch selection in UI. Right now it is hard-coded radio buttons as a proof of concept. egui selectable labels might be more visually appealing, but a drop down might make the most sense.
• [ ] Adding a sketch to the sketch list (in whatever form it takes) should be a one line operation (regardless of egui or clap).

1. set's the "js" function of the getrandom crate to enable sketches to use random values when compiled to wasm.
2. Addresses trivial clippy warnings
3. With the release of the clap 3.0.0 release candidates, a "derive" feature now needs to be set to use derive macros.

• Corrects bug in PathBuilder's smooth() + close() case.
• Removes generation of short names for sketch parameters since they are too likely to collider with global options or other parameters.
• Adds a builder for Poly
• Adds "App Settings" section to the UI's side panel, currently only for a UI scale setting.
• Adds five sketches

A reset button should be present in the "Sketch Settings" collapsible heading section that returns zoom, and all parameters to their defaults.

Currently, defaults are not communicated to the UI, so nightsketch::metadata::ParamMetadata should have a default value field added, or functions should be provided that return the default val by id, like how getting/setting currently works.

Previously, stroke widths were all set to a hard coded value (0.5mm for SVG, 2px for egui), and there was no way for individual shapes to have different stroke widths.

Now, a stroke_width field is present on all shapes, and an option exists for setting them in TextBuilder and PathBuilder.

Additionally, paths drawn in nightgraph-ui were a fixed size regardless of zoom level. Now they scale accordingly.

Adds a path argument to nightgraphics::render::svg::SvgRenderer and an --output arg to nightgraph-cli

nightgraph-cli

nightgraph-cli 0.1.0

Kyle Kneitinger <[email protected]>

A runner for nightgraph sketches

USAGE:
    nightgraph-cli [OPTIONS] <SUBCOMMAND>

OPTIONS:
    -h, --help               Print help information
        --output <OUTPUT>    Path where the resulting SVG file is stored [default: drawing.svg]
    -V, --version            Print version information

SUBCOMMANDS:
    blossom    A series of lightly complex sine modulated rings around the center of the page
               with optional text cutout
    help       Print this message or the help of the given subcommand(s)

Fixes #12

For information see #15. The first prototype is featured there, but a slightly different approach was taken here, and the sketch crate was heavily refactored since then too, so it made sense to post a new PR.

Design considerations covered in #15 as well

Fixes #2

Moves sketch related data and associated UI controls to own module (sketch_control).

Moves drawing/page controls to drawing module.

Moves font setup operations to own function (this pattern should be followed for other setup ops, such as UI scaling, etc.

Breaks sketch related traits and parameter metadata structs/enums out of nightsketch/src/lib.rs and into nightsketch/src/sketch.rs and nightsketch/src/metadata.rs respectively.

Additionally, moves the Blossom sketch's exp_dec and sin_component functions into a new nightgraphics::utils module.

There are currently 3 places assets live:

• ui/assets for GUI fonts
• graphics/assets for nightgraphics::geometry::TextBuilder built-in fonts
• img for README/doc images)

Combining these into an assets directory with subdirectories for fonts, 'imgs`, etc would be a nice thing to do :)

Currently, nightgraph-cli saves the rendered SVG as image.svg in the current working directory. This should obviously be able to be set by the user at runtime.

Eventually, a stronger system of timestamped files/dirs and stored argument metadata should be implemented so that all images are reproducible. An issue should be filed for that when this issue's fix is in place.

When using many parameters in a sketch, the UI's parameter tab can get a bit cluttered. To relieve this,

it would be nice to allow parameters to be grouped, for example the parameters for a sine wave being next to each other and padded from others with a separator...or even all of them being in an egui CollapsingHeader

Even easier, it would be helpful to allow parameters to be tagged as important (or some similar and shorter word) and appear in the parameter panel as bold text

#[param(default = 3, important)]
sine_wave_count: u32

With the addition of optionally-precomputed bounding boxes, and specifiable stroke widths (#25) the configuration options for a shape are getting quite numerous.

Following the lead of PathBuilder and TextBuilder, all shapes should have an associated builder, and if appropriate, a central shape builder that can instantiate any shape might be nice.

Currently, by zooming in to a drawing, the zoom point is the center of the canvas. It would feel far more natural to zoom to the point underneath the cursor.

Goal

At least 80% test coverage in repo.

Tasks

• [ ] nightsketch_derive macro internals
• [x] #19
• [ ] nightsketch features (testing clap derivations, etc)
• [ ] nightgraphics geometry/canvas/render coverage improvement
• [ ] nightgraph-ui custom components (sketch loading, parameter control generation, etc)

Note

I don't believe sketches themselves make sense to include in this figure

The #[sketch] attribute macro in sketch_derive will currently autogenerate clap/custom code for setting integral, floating point and boolean values. A lot of my recent work uses text, and having that be a cli option or UI setting would be great.

The general infrastructure for this is already in place; the main hurdle is just handling lifetimes/ownership with aggregate datatypes.

For cli settings, quotations handle any whitespace/newlines. For UI, this setting should likely be a multiline text box.

Currently each lib has decent error types, but their clarity/usage/etc. is inconsistent. All crate/mod error types should be reviewed and refined, and every occurrence of unwrap() should be checked and replaced unless completely certain a case is infallible.

Once the errors are refined, nightgraph-cli and nightgraph-ui should report errors cleanly to the user. ui can have an error console, or use the tab/panel/etc described in #6