A Rust CAD System

(API Docs)

An extensible framework for creating 2D CAD applications, written in Rust based on an Entity-Component-System architecture.

Project Goals and Milestones

I've broken the direction of this project up into a handful of milestones, each containing a list of related features or concepts.

• Milestone: MVP

  • Geometry primitives (Arc, Point, Line, etc.)
  • Basic styling component (e.g. LineStyle with a colour and stroke width)
  • All drawing objects are attached to a Layer
  • Drawing objects have a BoundingBox which gets recalculated whenever something changes
  • Render drawing objects on a canvas
  • Example showing all of the above and rendering a simple drawing (render_to_image.rs)

• Milestone: Online demo

  • Render correctly to a HTML5 <canvas>
  • Interactive tools for creating drawing objects:
    • Point
    • Line
    • Arc
  • Move items between layers
  • Selectively show/hide layers
  • Viewport panning
  • Zoom Viewport in/out

• Milestone: Required by Real-World Applications (see `Michael-F-Bryan/rustmatic#38)

  • Robust undo/redo mechanism

• Wish List

  • Z-levels so objects can be drawn on top of each other
  • Entities can be tagged with a name to give them semantic meaning
  • Approximation algorithm
  • Translation algorithm
  • Uniform scale algorithm
  • Scaling algorithm without maintaining aspect ratio
  • Calculate the length of a geometric primitive
  • B-Splines
  • Interpolated splines
  • Bézier curves
  • Elliptical sections
  • Closest point algorithm for all geometric primitives

License

This project is licensed under either of

• Apache License, Version 2.0, (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
• MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)

at your option.

Contribution

The easiest way to start contributing is to check the issue tracker and look for an easy issue to tackle. Alternatively the wishlist contains a list of features we'd like to implement, although these may require more effort or experience.

We're always keen to help mentor contributors!

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.