Skip to content

Commit d8e8765

Browse files
authored
Update load 3d node doc (#254)
* Add lode 3d docs * Update navigation * Update load 3d docs * Remove upload texture
1 parent 55542a5 commit d8e8765

File tree

14 files changed

+292
-0
lines changed

14 files changed

+292
-0
lines changed

built-in-nodes/Load3D.mdx

Lines changed: 140 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,140 @@
1+
---
2+
title: "Load3D - ComfyUI Built-in Node Documentation"
3+
description: "The Load3D node is a core node in ComfyUI for loading and previewing various 3D model files, supporting multi-format import and rich three-dimensional view operations."
4+
sidebarTitle: "Load3D"
5+
icon: "circle"
6+
---
7+
8+
The Load3D node is a core node for loading and processing 3D model files. When loading the node, it automatically retrieves available 3D resources from `ComfyUI/input/3d/`. You can also upload supported 3D files for preview using the upload function.
9+
10+
**Supported Formats**
11+
Currently, this node supports multiple 3D file formats, including `.gltf`, `.glb`, `.obj`, `.fbx`, and `.stl`.
12+
13+
**3D Node Preferences**
14+
Some related preferences for 3D nodes can be configured in ComfyUI's settings menu. Please refer to the following documentation for corresponding settings:
15+
16+
[Settings Menu - 3D](/interface/settings/3d)
17+
18+
Besides regular node outputs, Load3D has lots of 3D view-related settings in the canvas menu.
19+
20+
## Inputs
21+
22+
| Parameter Name | Type | Description | Default | Range |
23+
|---------------|----------|---------------------------------|---------|--------------|
24+
| model_file | File Selection | 3D model file path, supports upload, defaults to reading model files from `ComfyUI/input/3d/` | - | Supported formats |
25+
| width | INT | Canvas rendering width | 1024 | 1-4096 |
26+
| height | INT | Canvas rendering height | 1024 | 1-4096 |
27+
28+
## Outputs
29+
30+
| Parameter Name | Data Type | Description |
31+
|-----------------|----------------|------------------------------------|
32+
| image | IMAGE | Canvas rendered image |
33+
| mask | MASK | Mask containing current model position |
34+
| mesh_path | STRING | Model file path |
35+
| normal | IMAGE | Normal map |
36+
| lineart | IMAGE | Line art image output, corresponding `edge_threshold` can be adjusted in the canvas model menu |
37+
| camera_info | LOAD3D_CAMERA | Camera information |
38+
| recording_video | VIDEO | Recorded video (only when recording exists) |
39+
40+
All corresponding outputs preview
41+
![View Operation Demo](/images/comfy_core/load3d/load3d_outputs.jpg)
42+
43+
## Canvas Area Description
44+
45+
The Load3D node's Canvas area contains numerous view operations, including:
46+
- Preview view settings (grid, background color, preview view)
47+
- Camera control: Control FOV, camera type
48+
- Global illumination intensity: Adjust lighting intensity
49+
- Video recording: Record and export videos
50+
- Model export: Supports `GLB`, `OBJ`, `STL` formats
51+
- And more
52+
53+
![Load 3D Node UI](/images/comfy_core/load3d/load3d_ui.jpg)
54+
55+
1. Contains multiple menus and hidden menus of the Load 3D node
56+
2. Menu for `resizing preview window` and `canvas video recording`
57+
3. 3D view operation axis
58+
4. Preview thumbnail
59+
5. Preview size settings, scale preview view display by setting dimensions and then resizing window
60+
61+
### 1. View Operations
62+
63+
<video
64+
controls
65+
muted
66+
loop
67+
playsInline
68+
className="w-full aspect-video rounded-xl"
69+
src="/images/comfy_core/load3d/view_operations.mp4"
70+
></video>
71+
72+
View control operations:
73+
- Left-click + drag: Rotate the view
74+
- Right-click + drag: Pan the view
75+
- Middle wheel scroll or middle-click + drag: Zoom in/out
76+
- Coordinate axis: Switch views
77+
78+
### 2. Left Menu Functions
79+
80+
![Menu](/images/comfy_core/load3d/menu.jpg)
81+
82+
In the canvas, some settings are hidden in the menu. Click the menu button to expand different menus
83+
- 1. Scene: Contains preview window grid, background color, preview settings
84+
- 2. Model: Model rendering mode, texture materials, up direction settings
85+
- 3. Camera: Switch between orthographic and perspective views, and set the perspective angle size
86+
- 4. Light: Scene global illumination intensity
87+
- 5. Export: Export model to other formats (GLB, OBJ, STL)
88+
89+
#### Scene
90+
91+
![scene menu](/images/comfy_core/load3d/menu_scene.jpg)
92+
93+
The Scene menu provides some basic scene setting functions
94+
1. Show/Hide grid
95+
2. Set background color
96+
3. Click to upload a background image
97+
4. Hide the preview
98+
99+
#### Model
100+
101+
![Menu_Scene](/images/comfy_core/load3d/menu_model.jpg)
102+
103+
The Model menu provides some model-related functions
104+
1. **Up direction**: Determine which axis is the up direction for the model
105+
2. **Material mode**: Switch model rendering modes - Original, Normal, Wireframe, Lineart
106+
107+
#### Camera
108+
109+
![menu_modelmenu_camera](/images/comfy_core/load3d/menu_camera.jpg)
110+
111+
This menu provides switching between orthographic and perspective views, and perspective angle size settings
112+
1. **Camera**: Quickly switch between orthographic and orthographic views
113+
2. **FOV**: Adjust FOV angle
114+
115+
#### Light
116+
117+
![menu_modelmenu_camera](/images/comfy_core/load3d/menu_light.jpg)
118+
119+
Through this menu, you can quickly adjust the scene's global illumination intensity
120+
121+
#### Export
122+
123+
![menu_export](/images/comfy_core/load3d/menu_export.jpg)
124+
125+
This menu provides the ability to quickly convert and export model formats
126+
127+
### 3. Right Menu Functions
128+
129+
<video
130+
controls
131+
muted
132+
loop
133+
playsInline
134+
className="w-full aspect-video rounded-xl"
135+
src="/images/comfy_core/load3d/recording.mp4"
136+
></video>
137+
138+
The right menu has two main functions:
139+
1. **Reset view ratio**: After clicking the button, the view will adjust the canvas rendering area ratio according to the set width and height
140+
2. **Video recording**: Allows you to record current 3D view operations as video, allows import, and can be output as `recording_video` to subsequent nodes

docs.json

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -326,6 +326,12 @@
326326
}
327327
]
328328
},
329+
{
330+
"group": "3D",
331+
"pages": [
332+
"built-in-nodes/Load3D"
333+
]
334+
},
329335
{
330336
"group": "API Node",
331337
"pages": [
@@ -866,6 +872,12 @@
866872
}
867873
]
868874
},
875+
{
876+
"group": "3D",
877+
"pages": [
878+
"zh-CN/built-in-nodes/Load3D"
879+
]
880+
},
869881
{
870882
"group": "API 节点",
871883
"pages": [
560 KB
Loading
165 KB
Loading

images/comfy_core/load3d/menu.jpg

103 KB
Loading
297 KB
Loading
77.2 KB
Loading
139 KB
Loading
589 KB
Loading
279 KB
Loading

0 commit comments

Comments
 (0)