Skip to content

The most powerful and modular diffusion model GUI, api and backend with a graph/nodes interface. The fastest local inference engine in the world.

Report the file saved by Save 3D (Advanced) as a standard 3d output item (#16171)

Terry Jia3074d0e331f0
diff --git a/comfy_api/latest/_ui.py b/comfy_api/latest/_ui.py
index ebee01144..06e725070 100644
--- a/comfy_api/latest/_ui.py
+++ b/comfy_api/latest/_ui.py
@@ -457,17 +457,28 @@ class PreviewUI3D(_UIOutput):
class PreviewUI3DAdvanced(_UIOutput):
- def __init__(self, model_file, camera_info, model_3d_info, folder_type: FolderType | None = None):
+ def __init__(
+ self,
+ model_file,
+ camera_info,
+ model_3d_info,
+ folder_type: FolderType | None = None,
+ saved_result: SavedResult | None = None,
+ ):
self.model_file = model_file
self.camera_info = camera_info
self.model_3d_info = model_3d_info
self.folder_type = folder_type
+ self.saved_result = saved_result
def as_dict(self):
model_file = self.model_file
if self.folder_type is not None:
model_file = f"{model_file} [{FolderType(self.folder_type).value}]"
- return {"result": [model_file, self.camera_info, self.model_3d_info]}
+ data = {"result": [model_file, self.camera_info, self.model_3d_info]}
+ if self.saved_result is not None:
+ data["3d"] = [self.saved_result]
+ return data
class PreviewText(_UIOutput):
diff --git a/comfy_extras/nodes_save_3d.py b/comfy_extras/nodes_save_3d.py
index a5033b36d..c0de41f07 100644
--- a/comfy_extras/nodes_save_3d.py
+++ b/comfy_extras/nodes_save_3d.py
@@ -876,18 +876,19 @@ class GetMeshInfo(IO.ComfyNode):
return IO.NodeOutput(mesh, info, ui=UI.PreviewText(info))
-def _save_file3d_to_output(model_3d: Types.File3D, filename_prefix: str) -> str:
+def _save_file3d_to_output(model_3d: Types.File3D, filename_prefix: str) -> UI.SavedResult:
full_output_folder, filename, counter, subfolder, filename_prefix = folder_paths.get_save_image_path(
filename_prefix, folder_paths.get_output_directory()
)
ext = model_3d.format or "glb"
saved_filename = f"{filename}_{counter:05}.{ext}"
model_3d.save_to(os.path.join(full_output_folder, saved_filename))
- return f"{subfolder}/{saved_filename}" if subfolder else saved_filename
+ return UI.SavedResult(saved_filename, subfolder, IO.FolderType.output)
def execute_save_3d_advanced(model_3d, viewport_state, width, height, filename_prefix, kwargs) -> IO.NodeOutput:
- model_file = _save_file3d_to_output(model_3d, filename_prefix)
+ saved = _save_file3d_to_output(model_3d, filename_prefix)
+ model_file = f"{saved.subfolder}/{saved.filename}" if saved.subfolder else saved.filename
viewport_state = viewport_state if isinstance(viewport_state, dict) else {}
camera_info_input = kwargs.get("camera_info", None)
camera_info = camera_info_input if camera_info_input is not None else viewport_state.get('camera_info')
@@ -899,7 +900,7 @@ def execute_save_3d_advanced(model_3d, viewport_state, width, height, filename_p
camera_info,
width,
height,
- ui=UI.PreviewUI3DAdvanced(model_file, camera_info, model_3d_info),
+ ui=UI.PreviewUI3DAdvanced(model_file, camera_info, model_3d_info, saved_result=saved),
)
diff --git a/tests-unit/comfy_api_test/preview_ui_3d_test.py b/tests-unit/comfy_api_test/preview_ui_3d_test.py
index 66b590f77..f429787a6 100644
--- a/tests-unit/comfy_api_test/preview_ui_3d_test.py
+++ b/tests-unit/comfy_api_test/preview_ui_3d_test.py
@@ -7,6 +7,7 @@ import pytest
import folder_paths
from comfy_api.latest import IO, UI, Types
from comfy_extras.nodes_load_3d import Preview3DAdvanced, PreviewGaussianSplat, PreviewPointCloud
+from comfy_extras.nodes_save_3d import Save3DAdvanced, SaveGaussianSplat, SavePointCloud
def test_preview_ui_3d_advanced_keeps_bare_path_by_default():
@@ -15,6 +16,16 @@ def test_preview_ui_3d_advanced_keeps_bare_path_by_default():
assert ui.as_dict() == {"result": ["3d/model.glb", {"fov": 35}, []]}
+def test_preview_ui_3d_advanced_reports_saved_result_as_standard_output_item():
+ saved = UI.SavedResult("model_00001.glb", "3d", IO.FolderType.output)
+ ui = UI.PreviewUI3DAdvanced("3d/model_00001.glb", None, [], saved_result=saved)
+
+ assert ui.as_dict() == {
+ "result": ["3d/model_00001.glb", None, []],
+ "3d": [{"filename": "model_00001.glb", "subfolder": "3d", "type": "output"}],
+ }
+
+
@pytest.mark.parametrize("folder_type", [IO.FolderType.temp, "temp"])
def test_preview_ui_3d_advanced_annotates_folder_type(folder_type):
ui = UI.PreviewUI3DAdvanced("preview.glb", None, [], folder_type=folder_type)
@@ -48,3 +59,22 @@ def test_preview_nodes_report_where_they_wrote_the_file(tmp_path, node_cls, file
assert name.startswith(prefix)
assert base_dir == str(tmp_path)
assert os.path.isfile(os.path.join(tmp_path, name))
+
+
+ ("node_cls", "file_format"),
+ [(Save3DAdvanced, "glb"), (SaveGaussianSplat, "spz"), (SavePointCloud, "ply")],
+)
+def test_save_nodes_report_the_saved_file_as_a_3d_output_item(tmp_path, node_cls, file_format):
+ model = Types.File3D(BytesIO(b"model-bytes"), file_format)
+
+ with patch.object(folder_paths, "get_output_directory", return_value=str(tmp_path)):
+ output = node_cls.execute(model, viewport_state={}, width=1, height=1, filename_prefix="3d/ComfyUI")
+
+ ui = output.ui.as_dict()
+ (item,) = ui["3d"]
+ assert item["subfolder"] == "3d"
+ assert item["type"] == "output"
+ assert item["filename"].startswith("ComfyUI_") and item["filename"].endswith(f".{file_format}")
+ assert ui["result"][0] == f"3d/{item['filename']}"
+ assert os.path.isfile(os.path.join(tmp_path, "3d", item["filename"]))