Merge branch 'release/v1.3'

README.md

@@ -1,3 +1,7 @@
+<p align="center">
+	<img src="doc/logo.png"/>
+</p>
+
 # DXF Plotter
 
 > Fast and easy to use DXF to GCode converter for laser and router CNC
@@ -13,13 +17,20 @@ This application helps users converting DXF files to GCode with minimal settings
 It targets only laser and router CNC following every lines and arcs from DXF file with optional desired depth.
 
 
-## Features
+## ⚙ Features
 
 * DXF support of line, arc, circle, polyline, spline
 * Customizable GCode command format
+* Saving current work to file
 * Multi selected path setting edition
 * Path offseting (Tool Compensation)
+* Pocket generation with islands capabilities
 * Multi passes with depth
+* Scale and translate paths
+
+<p align="center">
+	<img src="doc/pocket.gif" width="80%"/>
+</p>
 
 ## Installation
 
@@ -34,22 +45,20 @@ chmod +x dxfplotter-*.AppImage
 ./dxfplotter-*.AppImage
 ```
 
-### Manual installation from source
+### 🏗 Manual installation from source
 
-This project depends on Qt5, yaml-cpp and fmt, for debian like distribution following command install all dependencies:
+This project depends on Qt5, for debian like distribution following command install all dependencies:
 
 ```sh
-sudo apt-get install qtbase5-dev libyaml-cpp-dev libfmt-dev
+sudo apt-get install qtbase5-dev
 ```
 
 ```sh
 git submodule init
 git submodule update
 
-mkdir build
-cd build
-cmake ..
-make
+cmake -B build
+cmake --build build -j $(nproc)
 ```
 
 ## Usage example
@@ -76,16 +85,15 @@ Once opened, select path from left panel or from viewport and modify settings of
 
 Export with `File->Export` or `Ctrl+E`
 
-
-## Configuration
+## ✏ Configuration
 
 ![](doc/configuration.png)
 
 Configuration settings are exposed in `Configuration->Settings`, the configuration is splitted in two:
 * general settings aiming dxf importing or default values
 * tools with settings such as radius and gcode formatting
 
-## GCode format
+## 📝 GCode format
 
 Simple set of GCode command is used per tool:
 

resource/resource.qrc

@@ -19,8 +19,10 @@
 		<file>icons/list-remove.svg</file>
 		<file>icons/path-inset.svg</file>
 		<file>icons/path-outset.svg</file>
+		<file>icons/pocket-shape.svg</file>
 		<file>icons/resizecol.svg</file>
 		<file>icons/show-path-outline.svg</file>
 		<file>icons/transform-rotate.svg</file>
+		<file>icons/zoom-in.svg</file>
     </qresource>
 </RCC> 

src/common/aggregable.h

@@ -5,7 +5,7 @@
 #include <set>
 #include <memory>
 
-namespace Common
+namespace common
 {
 
 template <class Item>
@@ -16,6 +16,7 @@ class Aggregable
 
 	using List = std::vector<Item>;
 	using ListPtr = std::vector<Item *>;
+	using ListCPtr = std::vector<const Item *>;
 	using ListUPtr = std::vector<UPtr>;
 
 	template <size_t Size>

src/common/exception.h

@@ -3,7 +3,7 @@
 #include <sstream>
 #include <string>
 
-namespace Common
+namespace common
 {
 
 class FileCouldNotOpenException : public std::exception
@@ -14,7 +14,7 @@ class GCodeFormatException : public std::runtime_error
 {
 private:
 	template <class ... Args>
-	std::string errorMessage(const std::string &format, const char *error, Args&& ... args)
+	static std::string errorMessage(const std::string &format, const char *error, Args&& ... args)
 	{
 		std::ostringstream stream;
 		stream << "Formatting error, format \"" << format << "\" with arguments";

src/common/function.h

@@ -1,6 +1,6 @@
 #pragma once
 
-namespace Common
+namespace common
 {
 
 template <typename Func>

src/config/config.cpp

@@ -13,7 +13,7 @@ Config::Config(const std::string &filePath)
 	try {
 		m_yamlRoot = YAML::LoadFile(filePath);
 	}
-	catch (const YAML::BadFile &e) {
+	catch (const YAML::BadFile&) {
 		qInfo() << "Initializing configuration from defaults";
 	}
 
@@ -43,7 +43,7 @@ const Root &Config::root() const
 	return m_root;
 }
 
-void Config::save()
+void Config::save() const
 {
 	std::ofstream outStream(m_filePath);
 	outStream << m_yamlRoot;

src/config/config.h.in

@@ -107,7 +107,7 @@ public:
 	Root& root();
 	const Root& root() const;
 
-	void save();
+	void save() const;
 };
 
 }

src/config/list.h

@@ -19,7 +19,7 @@ class List : public Node
 	YAML::Node m_yamlNode;
 
 public:
-	explicit List(const std::string& name, const std::string &description, YAML::Node yamlNode)
+	explicit List(const std::string& name, const std::string &description, const YAML::Node &yamlNode)
 		:Node(name, description),
 		m_yamlNode(yamlNode)
 	{
@@ -29,7 +29,7 @@ class List : public Node
 		}
 		else {
 			// Create items from yaml node
-			for (std::pair<YAML::Node, YAML::Node> pair : m_yamlNode) {
+			for (const auto &pair : m_yamlNode) {
 				const std::string &name = pair.first.as<std::string>();
 				m_children.emplace(name, Child(name, pair.second));
 			}
@@ -45,8 +45,7 @@ class List : public Node
 
 	const Child *get(const std::string &name) const
 	{
-		const auto it = m_children.find(name);
-		if (it != m_children.end()) {
+		if (const auto it = m_children.find(name); it != m_children.end()) {
 			return &it->second;
 		}
 
@@ -84,7 +83,7 @@ class List : public Node
 		template <class Visitor>
 	void visitChildren(Visitor &&visitor) const
 	{
-		for (auto &pair : m_children) {
+		for (const auto &pair : m_children) {
 			visitor(pair.second);
 		}
 	}

src/config/node.h

@@ -9,7 +9,7 @@ namespace config
 
 class Node
 {
-protected:
+private:
 	std::string m_name;
 	std::string m_description;
 

src/exporter/gcode/exporter.cpp

@@ -41,7 +41,7 @@ void Exporter::convertToGCode(const model::Path &path, std::ostream &output) con
 class PassesIterator
 {
 private:
-	bool m_odd;
+	bool m_odd = true;
 	const bool m_closed;
 	const bool m_cuttingBackward;
 	const geometry::Polyline& m_polyline;
@@ -54,18 +54,17 @@ class PassesIterator
 
 	const geometry::Polyline &polylineForward() const
 	{
-		return (m_cuttingBackward) ? m_polylineInverse : m_polyline;
+		return m_cuttingBackward ? m_polylineInverse : m_polyline;
 	}
 
 	const geometry::Polyline &polylineBackward() const
 	{
-		return (m_cuttingBackward) ? m_polyline : m_polylineInverse;
+		return m_cuttingBackward ? m_polyline : m_polylineInverse;
 	}
 
 public:
 	explicit PassesIterator(const geometry::Polyline &polyline, geometry::CuttingDirection direction)
-		:m_odd(true),
-		m_closed(polyline.isClosed()),
+		:m_closed(polyline.isClosed()),
 		m_cuttingBackward(direction == geometry::CuttingDirection::BACKWARD),
 		m_polyline(polyline),
 		m_polylineInverse(needPolylineInverse() ? m_polyline.inverse() : geometry::Polyline())
@@ -126,15 +125,11 @@ void Exporter::convertToGCode(PathPostProcessor &processor, const geometry::Bulg
 		const QVector2D relativeCenter = circle.center() - bulge.start();
 		switch (circle.orientation()) {
 			case geometry::Orientation::CW:
-			{
 				processor.cwArcMove(relativeCenter, bulge.end());
 				break;
-			}
 			case geometry::Orientation::CCW:
-			{
 				processor.ccwArcMove(relativeCenter, bulge.end());
 				break;
-			}
 			default:
 				break;
 		}
@@ -151,6 +146,8 @@ struct CommentLineStream
 		m_output << "; " << prefix;
 	}
 
+	CommentLineStream(CommentLineStream &) = delete;
+
 	~CommentLineStream()
 	{
 		m_output << "\n";
@@ -175,13 +172,13 @@ struct ConfigToCommentVisitor
 	}
 
 	template <class ValueType>
-	void operator()(const config::Property<ValueType> &property)
+	void operator()(const config::Property<ValueType> &property) const
 	{
 		commentLineStream() << property.name() << " = " << config::toSerializable((ValueType)property);
 	}
 
 	template <class Node>
-	void operator()(const Node &node)
+	void operator()(const Node &node) const
 	{
 		commentLineStream() << node.name();
 		node.visitChildren(ConfigToCommentVisitor{m_output, m_prefix + "  "});
@@ -191,7 +188,7 @@ struct ConfigToCommentVisitor
 template <class Group>
 void convertConfigNodeToComments(const Group &group, std::ostream &output)
 {
-	ConfigToCommentVisitor visitor{output, ""};
+	const ConfigToCommentVisitor visitor{output, ""};
 	visitor(group);
 }
 

src/exporter/gcode/postprocessor.h

@@ -30,7 +30,7 @@ class PostProcessor
 			m_stream << fmt::format(format, std::forward<Args>(args)...) << "\n";
 		}
 		catch (const fmt::format_error &exception) {
-			throw Common::GCodeFormatException(format, exception.what(), fmt::to_string(args.name)...);
+			throw common::GCodeFormatException(format, exception.what(), fmt::to_string(args.name)...);
 		}
 	}
 

src/geometry/CMakeLists.txt

@@ -7,6 +7,7 @@ set(SRC
 	cleaner.cpp
 	circle.cpp
 	cubicspline.cpp
+	pocketer.cpp
 	polyline.cpp
 	quadraticspline.cpp
 	spline.cpp