Introducing Gradio Clients
Watch
New to Gradio? Start here: Getting Started
See the Release History
Model3D
gradio.Model3D(···)Description
Creates a component allows users to upload or view 3D Model files (.obj, .glb, .stl, .gltf, .splat, or .ply).
Behavior
As input component: Passes the uploaded file as a str filepath to the function.
Your function should accept one of these types:
def predict(
value: str | None
)
...As output component: Expects function to return a str or pathlib.Path filepath of type (.obj, .glb, .stl, or .gltf)
Your function should return one of these types:
def predict(···) -> str | Path | None
...
return valueInitialization
Parameters
Shortcuts
| Class | Interface String Shortcut | Initialization |
|---|---|---|
| "model3d" | Uses default values |
Event Listeners
Description
Event listeners allow you to respond to user interactions with the UI components you've defined in a Gradio Blocks app. When a user interacts with an element, such as changing a slider value or uploading an image, a function is called.
Supported Event Listeners
The Model3D component supports the following event listeners. Each event listener takes the same parameters, which are listed in the Event Parameters table below.
| Listener | Description |
|---|---|
| Triggered when the value of the Model3D changes either because of user input (e.g. a user types in a textbox) OR because of a function update (e.g. an image receives a value from the output of an event trigger). See |
| This listener is triggered when the user uploads a file into the Model3D. |
| This listener is triggered when the user edits the Model3D (e.g. image) using the built-in editor. |
| This listener is triggered when the user clears the Model3D using the X button for the component. |
Event Parameters
Parameters