#5629: Introduce a way for Python scripts to hit every selected face

install/scripts/test.py

@@ -91,6 +91,14 @@ def visit(self, node):
 visitor = Walker()
 GlobalSelectionSystem.foreachSelected(visitor)
 
+# Visit every selected face
+class FaceVisitor(dr.SelectedFaceVisitor) :
+	def visitFace(self, face):
+		print(face.getShader())
+
+visitor = FaceVisitor()
+GlobalSelectionSystem.foreachSelectedFace(visitor)
+
 print('Map name is ' + GlobalMap.getMapName())
 
 print(GlobalMap.getEditMode())

plugins/script/interfaces/SelectionInterface.cpp

@@ -18,6 +18,14 @@ void SelectionInterface::foreachSelectedComponent(const SelectionSystem::Visitor
 	GlobalSelectionSystem().foreachSelectedComponent(visitor);
 }
 
+void SelectionInterface::foreachSelectedFace(SelectedFaceVisitor& visitor)
+{
+    GlobalSelectionSystem().foreachFace([&](IFace& face)
+    {
+        visitor.visitFace(face);
+    });
+}
+
 void SelectionInterface::setSelectedAll(int selected)
 {
 	GlobalSelectionSystem().setSelectedAll(static_cast<bool>(selected));
@@ -55,12 +63,18 @@ void SelectionInterface::registerInterface(py::module& scope, py::dict& globals)
 	visitor.def(py::init<>());
 	visitor.def("visit", &SelectionSystem::Visitor::visit);
 
+    // Expose the SelectionFaceVisitor interface
+    py::class_<SelectedFaceVisitor, SelectedFaceVisitorWrapper> faceVisitor(scope, "SelectedFaceVisitor");
+    faceVisitor.def(py::init<>());
+    faceVisitor.def("visitFace", &SelectedFaceVisitor::visitFace);
+
 	// Add the module declaration to the given python namespace
 	py::class_<SelectionInterface> selSys(scope, "SelectionSystem");
 
 	selSys.def("getSelectionInfo", &SelectionInterface::getSelectionInfo, py::return_value_policy::reference);
 	selSys.def("foreachSelected", &SelectionInterface::foreachSelected);
 	selSys.def("foreachSelectedComponent", &SelectionInterface::foreachSelectedComponent);
+	selSys.def("foreachSelectedFace", &SelectionInterface::foreachSelectedFace);
 	selSys.def("setSelectedAll", &SelectionInterface::setSelectedAll);
 	selSys.def("setSelectedAllComponents", &SelectionInterface::setSelectedAllComponents);
 	selSys.def("ultimateSelected", &SelectionInterface::ultimateSelected);

plugins/script/interfaces/SelectionInterface.h

@@ -8,6 +8,7 @@
 #include <map>
 
 #include "SceneGraphInterface.h"
+#include "BrushInterface.h"
 
 namespace script 
 {
@@ -31,6 +32,31 @@ class SelectionVisitorWrapper :
 	}
 };
 
+// Special interface only used by Python scripts to visit selected faces
+class SelectedFaceVisitor
+{
+public:
+    virtual ~SelectedFaceVisitor() {}
+
+    virtual void visitFace(IFace& face) = 0;
+};
+
+class SelectedFaceVisitorWrapper :
+    public SelectedFaceVisitor
+{
+public:
+    void visitFace(IFace& face) override
+    {
+        // Wrap this method to python
+        PYBIND11_OVERLOAD_PURE(
+            void,			/* Return type */
+            SelectedFaceVisitor,    /* Parent class */
+            visitFace,			/* Name of function in C++ (must match Python name) */
+            ScriptFace(face)			/* Argument(s) */
+        );
+    }
+};
+
 class SelectionInterface :
 	public IScriptInterface
 {
@@ -40,6 +66,7 @@ class SelectionInterface :
 
 	void foreachSelected(const SelectionSystem::Visitor& visitor);
 	void foreachSelectedComponent(const SelectionSystem::Visitor& visitor);
+	void foreachSelectedFace(SelectedFaceVisitor& visitor);
 
 	void setSelectedAll(int selected);
 	void setSelectedAllComponents(int selected);