Editor

.travis.yml

@@ -21,7 +21,7 @@ before_deploy:
   - sed -i "s/__VERSION__/$TRAVIS_BUILD_NUMBER/g" bintray-spec.json
 
 deploy:
-    - provider: pages
+  - provider: pages
     skip_cleanup: true
     github_token: $GITHUB_TOKEN
     keep-history: true

CMakeLists.txt

@@ -20,9 +20,9 @@ option(ENABLE_DOXYGEN "Build documentation" OFF)
 
 # ================ Project ========================
 # Project name and a few useful settings
-project(struct
+project(editor
 	VERSION 0.0.$ENV{TRAVIS_BUILD_NUMBER}
-	DESCRIPTION "OTUS c++ homeworks: struct"
+	DESCRIPTION "OTUS c++ homeworks: editor"
 	LANGUAGES CXX
 )
 

apps/CMakeLists.txt

@@ -0,0 +1 @@
+add_subdirectory(Editor)

apps/Editor/CMakeLists.txt

@@ -0,0 +1,4 @@
+add_and_install_project_app(editor
+    DEPEND
+        lib_Editor
+)

apps/Editor/src/main_GraphicEditor.cpp

@@ -0,0 +1,25 @@
+/**
+ * \brief Main application
+ */
+
+#include <Editor/GraphicEditor.h>
+#include <Editor/Document/Tools/Tools.h>
+#include <Editor/Document/Primitives/Circle.h>
+
+#include <memory>
+
+using namespace document;
+
+int main() {
+    GraphicEditor editor;
+    editor.CreateNewDocument("/tmp/file0.jpg", DocumentType::JPG);
+    editor.ImportDocument("/tmp/file1.jpg");
+    editor.ExportDocument("/tmp/file1_export.jpg", DocumentType::PNG);
+    auto config = PrimitiveConfig{Color::Red, LineStyle::Solid, {0,0}, std::make_shared<Pensil>()};
+    auto circle = std::make_shared<Circle>(1, config);
+    editor.CreatePrimitive(circle);
+    editor.RemovePrimitive(circle);
+    editor.SetActiveDocument();
+
+    return 0;
+}

library/CMakeLists.txt

@@ -0,0 +1 @@
+add_subdirectory(Editor)

library/Editor/CMakeLists.txt

@@ -0,0 +1,3 @@
+add_project_library()
+
+add_subdirectory(test)

library/Editor/README.MD

@@ -0,0 +1,23 @@
+# OTUS course: "C++ Developer. Professional"
+
+## Домашнее Задание 4
+
+Спроектировать простейший графический векторный редактор. Подготовить макеты классов, отражающих структуру будущего проекта.
+
+Функционал для макетирования следующий: - создание нового документа
+
+- импорт документа из файла
+- экспорт документа в файл
+- создание графического примитива - удаление графического примитива
+
+Основной упор сделать на шаблон контроллера (MVC) и полиморфизм. Функции, являющиеся обработчиками GUI, собрать в одном файле с функцией `main`.
+
+Внимание должно быть сосредоточено на декларациях, реализация только в крайнем случае для минимальной демонстрации необходимых вызовов. Проект должен компилироваться, все заголовки должны пройти стадию компиляции.
+
+Задание считается выполненным успешно, если все файлы прошли стадию компиляции, все классы охвачены диаграммами, код успешно прошел анализ.
+Дополнительные рекомендации
+
+1. Заложить в интерфейсы использование умных указателей, тем самым решив вопрос владения объектами.
+2. Помнить про принцип единственности ответственности, разделить код на логические модули (классы, функции).
+3. Избегать дублирования кода.
+

library/Editor/include/Editor/Document/Color/Color.h

@@ -0,0 +1,11 @@
+#pragma once
+
+namespace document {
+
+enum class Color {
+    Red,
+    Green,
+    Blue
+};
+
+} // namespace document {

library/Editor/include/Editor/Document/Document.h

@@ -0,0 +1,25 @@
+#pragma once
+
+#include <Editor/Document/IDocument.h>
+
+#include <filesystem>
+
+namespace document {
+
+class PNG : public IDocument {
+public:
+    PNG(const std::filesystem::path& path): IDocument(path) {}
+    bool SaveAs(const std::filesystem::path& new_path, DocumentType) override {
+        return true;    
+    }
+};
+
+class JPG : public IDocument {
+public:
+    JPG(const std::filesystem::path& path): IDocument(path) {}
+    bool SaveAs(const std::filesystem::path& new_path, DocumentType) override {
+        return true;
+    }
+};
+
+} // namespace document

library/Editor/include/Editor/Document/DocumentType.h

@@ -0,0 +1,15 @@
+#pragma once
+
+namespace document {
+
+/**
+ * @brief Supported type of documents for Graphic Editor
+ * 
+ */
+
+enum class DocumentType {
+    PNG = 0,
+    JPG = 1
+};
+
+} // namespace document

library/Editor/include/Editor/Document/IDocument.h

@@ -0,0 +1,33 @@
+#pragma once
+
+#include <Editor/Document/Primitives/IPrimitive.h>
+#include <Editor/Document/DocumentType.h>
+
+#include <filesystem>
+#include <vector>
+
+namespace document {
+
+class IDocument {
+public:
+    IDocument(const std::filesystem::path& path) :
+        m_path(path) {}
+
+    virtual bool SaveAs(const std::filesystem::path& new_path, DocumentType) = 0;
+
+    bool AddPrimitive(const std::shared_ptr<IPrimitive> primitive) {
+        m_primitives.push_back(primitive);
+        return true;
+    }
+
+    virtual void Update() {};
+
+    std::vector<std::shared_ptr<IPrimitive>>& GetAllPrimitives() { return m_primitives; }
+
+    virtual ~IDocument() = default;
+protected:
+    std::filesystem::path m_path;
+    std::vector<std::shared_ptr<IPrimitive>> m_primitives;
+};
+
+} // namespace document

library/Editor/include/Editor/Document/Primitives/Circle.h

@@ -0,0 +1,16 @@
+#pragma once
+
+#include <Editor/Document/Primitives/IPrimitive.h>
+#include <Editor/Document/Primitives/PrimitiveConfig.h>
+
+namespace document {
+
+class Circle: public IPrimitive {
+public:
+    Circle(const float radius, PrimitiveConfig config):
+        IPrimitive(config), m_radius(radius) {}
+private:
+    float m_radius;
+};
+
+} // namespace document {

library/Editor/include/Editor/Document/Primitives/IPrimitive.h

@@ -0,0 +1,15 @@
+#pragma once
+
+#include <Editor/Document/Primitives/PrimitiveConfig.h>
+
+namespace document {
+
+class IPrimitive {
+public:
+    IPrimitive(const PrimitiveConfig& config):
+        m_config(config) {}
+protected:
+    PrimitiveConfig m_config;
+};
+
+} // namespace document {

library/Editor/include/Editor/Document/Primitives/Line.h

@@ -0,0 +1,16 @@
+#pragma once
+
+#include <Editor/Document/Primitives/IPrimitive.h>
+#include <Editor/Document/Primitives/PrimitiveConfig.h>
+
+namespace document {
+
+class Line: public IPrimitive {
+public:
+    Line(const float width, PrimitiveConfig config):
+        IPrimitive(config), m_width(width) {}
+private:
+    float m_width;
+};
+
+} // namespace document {

library/Editor/include/Editor/Document/Primitives/PrimitiveConfig.h

@@ -0,0 +1,32 @@
+#pragma once
+
+#include <Editor/Document/Tools/ITool.h>
+#include <Editor/Document/Color/Color.h>
+
+#include <memory>
+
+namespace document {
+
+struct Position {
+    float x;
+    float y;
+};
+
+enum class LineStyle {
+    Dash,
+    Solid
+};
+
+struct PrimitiveConfig {
+    Color color;
+    LineStyle line_style;
+    Position position;
+    std::shared_ptr<ITool> tool;
+};
+
+enum class PrimitiveType {
+    Circle,
+    Line
+};
+
+} // namespace document

library/Editor/include/Editor/Document/Tools/ITool.h

@@ -0,0 +1,8 @@
+#pragma once
+
+
+namespace document { 
+
+class ITool {};
+
+} // namespace document {

library/Editor/include/Editor/Document/Tools/Tools.h

@@ -0,0 +1,11 @@
+#pragma once
+
+#include <Editor/Document/Tools/ITool.h>
+
+namespace document {
+
+class Brush: public ITool {};
+
+class Pensil: public ITool {};
+
+} // namespace document

library/Editor/include/Editor/GraphicEditor.h

@@ -0,0 +1,25 @@
+/**
+ * \file Editor.h
+ * \brief Declaration of Simple Vector Graphics Editor
+ * \version 0.1
+ * 
+ * \copyright Copyright (c) 2021
+ * 
+ */
+
+#pragma once
+
+#include <Editor/IEditor.h>
+#include <Editor/Document/IDocument.h>
+#include <Editor/Document/DocumentType.h>
+#include <filesystem>
+
+class GraphicEditor: public IEditor<document::IPrimitive, document::PrimitiveConfig> {
+public:
+    std::shared_ptr<document::IDocument> CreateNewDocument(const std::filesystem::path& path, document::DocumentType) override;
+    void ImportDocument(const std::filesystem::path& path) override;
+    void ExportDocument(const std::filesystem::path& path, document::DocumentType) override;
+
+private:
+    document::DocumentType GetDocumentType(const std::filesystem::path& path);
+};