Merge pull request #3 from phil-QS/pr/plugin-gizmo

feat: add runtime plugin gizmo slot

Author: xushiwei

.github/workflows/build_all.yml

@@ -4,6 +4,7 @@ on:
   push:
     branches:
      - main
+     - xgo
      - release/*
     paths:
      - 'deps/**'
@@ -18,6 +19,7 @@ on:
   pull_request:
     branches:
      - main
+     - xgo
      - release/*
     paths:
      - 'deps/**'

CMakeLists.txt

@@ -899,6 +899,8 @@ endfunction()
 # libslic3r, OrcaSlicer GUI and the OrcaSlicer executable.
 add_subdirectory(deps_src)
 add_subdirectory(src)
+# Plugin extension hook — absent in xgo/upstream PR branch, present only in x3d branch.
+include("${CMAKE_SOURCE_DIR}/x3d_root.cmake" OPTIONAL)
 set_property(DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR} PROPERTY VS_STARTUP_PROJECT OrcaSlicer_app_gui)
 
 add_dependencies(gettext_make_pot hintsToPot)

src/slic3r/CMakeLists.txt

@@ -807,3 +807,6 @@ endif ()
 
 # Add a definition so that we can tell we are compiling slic3r.
 target_compile_definitions(libslic3r_gui PRIVATE SLIC3R_CURRENTLY_COMPILING_GUI_MODULE)
+
+# Plugin extension hook — absent in xgo/upstream PR branch, present only in x3d branch.
+include("${CMAKE_CURRENT_SOURCE_DIR}/x3d_plugin.cmake" OPTIONAL)

src/slic3r/GUI/Gizmos/GLGizmoPainterBase.hpp

@@ -312,9 +312,10 @@ class GLGizmoPainterBase : public GLGizmoBase
 
     TriangleSelector::ClippingPlane get_clipping_plane_in_volume_coordinates(const Transform3d &trafo) const;
 
-private:
+protected:
     std::vector<std::vector<ProjectedMousePosition>> get_projected_mouse_positions(const Vec2d &mouse_position, double resolution, const std::vector<Transform3d> &trafo_matrices) const;
 
+private:
     std::vector<ProjectedHeightRange> get_projected_height_range(const Vec2d& mouse_position, double resolution, const std::vector<const ModelVolume*>& part_volumes, const std::vector<Transform3d>& trafo_matrices) const;
 
     bool is_mesh_point_clipped(const Vec3d& point, const Transform3d& trafo) const;
@@ -381,6 +382,18 @@ class GLGizmoPainterBase : public GLGizmoBase
     friend class ::Slic3r::GUI::GLGizmoMmuSegmentation;
 };
 
+// Plugin interface: custom gizmos registered at runtime via pluginSpriteFactory
+class IGLSprite : public GLGizmoPainterBase {
+public:
+    using GLGizmoPainterBase::GLGizmoPainterBase;
+    virtual void set_icon(bool is_dark) = 0;
+    virtual bool gizmo_event(SLAGizmoEventType action, const Vec2d& mouse_position, bool shift_down, bool alt_down, bool control_down) = 0;
+};
+
+using IGLSpriteFactory = IGLSprite*(*)(GLCanvas3D&);
+
+// Returns a reference to the global factory slot — safe to call before main().
+IGLSpriteFactory& get_plugin_factory_slot();
 
 } // namespace Slic3r::GUI
 

src/slic3r/GUI/Gizmos/GLGizmosManager.cpp

@@ -1,5 +1,6 @@
 #include "libslic3r/libslic3r.h"
 #include "GLGizmosManager.hpp"
+#include "slic3r/GUI/Gizmos/GLGizmoPainterBase.hpp"
 #include "slic3r/GUI/GLCanvas3D.hpp"
 #include "slic3r/GUI/3DScene.hpp"
 #include "slic3r/GUI/Camera.hpp"
@@ -43,6 +44,13 @@ const float GLGizmosManager::Default_Icons_Size = 40;
 const float GLGizmosManager::Default_Icons_Size = 64;
 #endif
 
+// Function-local static — guaranteed to be initialized on first call, before any use.
+// Safe to call from QAgentAutoRegister constructor (before main).
+IGLSpriteFactory& get_plugin_factory_slot() {
+    static IGLSpriteFactory s_factory = nullptr;
+    return s_factory;
+}
+
 GLGizmosManager::GLGizmosManager(GLCanvas3D& parent)
     : m_parent(parent)
     , m_enabled(false)
@@ -131,6 +139,7 @@ void GLGizmosManager::switch_gizmos_icon_filename()
         m_background_texture.texture.load_from_file(resources_dir() + "/images/" + m_background_texture.metadata.filename, false, GLTexture::SingleThreaded, false);
 
     for (auto& gizmo : m_gizmos) {
+        if (!gizmo) continue; // nullptr = unregistered plugin slot, skip
         gizmo->on_change_color_mode(m_is_dark);
         switch (gizmo->get_sprite_id())
         {
@@ -176,6 +185,10 @@ void GLGizmosManager::switch_gizmos_icon_filename()
         case (EType::BrimEars):
             gizmo->set_icon_filename(m_is_dark ? "toolbar_brimears_dark.svg" : "toolbar_brimears.svg");
             break;
+        case (EType::CustomEType):
+            if (auto* sprite = dynamic_cast<IGLSprite*>(gizmo.get()))
+                sprite->set_icon(m_is_dark);
+            break;
         }
 
     }
@@ -219,6 +232,14 @@ bool GLGizmosManager::init()
     m_gizmos.emplace_back(new GLGizmoAssembly(m_parent, m_is_dark ? "toolbar_assembly_dark.svg" : "toolbar_assembly.svg", EType::Assembly));
     m_gizmos.emplace_back(new GLGizmoSimplify(m_parent, "reduce_triangles.svg", EType::Simplify));
     m_gizmos.emplace_back(new GLGizmoBrimEars(m_parent, m_is_dark ? "toolbar_brimears_dark.svg" : "toolbar_brimears.svg", EType::BrimEars));
+    if (auto* factory = get_plugin_factory_slot()) {
+        if (auto* sprite = factory(m_parent))
+            m_gizmos.emplace_back(sprite);
+        else
+            m_gizmos.emplace_back(nullptr);
+    } else {
+        m_gizmos.emplace_back(nullptr);
+    }
     //m_gizmos.emplace_back(new GLGizmoSlaSupports(m_parent, "sla_supports.svg", sprite_id++));
     //m_gizmos.emplace_back(new GLGizmoFaceDetector(m_parent, "face recognition.svg", sprite_id++));
     //m_gizmos.emplace_back(new GLGizmoHollow(m_parent, "hollow.svg", sprite_id++));
@@ -228,6 +249,7 @@ bool GLGizmosManager::init()
         m_assemble_view_data.reset(new AssembleViewDataPool(&m_parent));
 
     for (auto& gizmo : m_gizmos) {
+        if (!gizmo) continue; // nullptr = unregistered plugin slot, skip
         if (! gizmo->init()) {
             m_gizmos.clear();
             return false;
@@ -528,6 +550,11 @@ bool GLGizmosManager::gizmo_event(SLAGizmoEventType action, const Vec2d& mouse_p
         return dynamic_cast<GLGizmoMeshBoolean*>(m_gizmos[MeshBoolean].get())->gizmo_event(action, mouse_position, shift_down, alt_down, control_down);
     else if (m_current == BrimEars)
         return dynamic_cast<GLGizmoBrimEars*>(m_gizmos[BrimEars].get())->gizmo_event(action, mouse_position, shift_down, alt_down, control_down);
+    else if (m_current == CustomEType && CustomEType < (int)m_gizmos.size()) {
+        if (auto* sprite = dynamic_cast<IGLSprite*>(m_gizmos[CustomEType].get()))
+            return sprite->gizmo_event(action, mouse_position, shift_down, alt_down, control_down);
+        return false;
+    }
     else
         return false;
 }

src/slic3r/GUI/Gizmos/GLGizmosManager.hpp

@@ -24,6 +24,9 @@ struct Snapshot;
 
 namespace GUI {
 
+// Forward declaration — full definition in GLGizmoPainterBase.hpp
+class IGLSprite;
+
 class GLCanvas3D;
 class ClippingPlane;
 enum class SLAGizmoEventType : unsigned char;
@@ -94,6 +97,7 @@ class GLGizmosManager : public Slic3r::ObjectBase
         // BBS
         //FaceRecognition,
         //Hollow,
+        CustomEType, // plugin gizmo slot — index must match position in m_gizmos vector
         Undefined,
     };