1. 组件
  2. Model3D

刚开始使用 Gradio？ 从这里开始： 入门指南

查看 发布历史

←

Markdown

MultimodalTextbox

→

Model3D

gradio.Model3D(···)

描述

创建一个允许用户上传或查看 3D 模型文件（.obj、.glb、.stl、.gltf、.splat 或 .ply）的组件。

行为

作为输入组件: 将上传的文件作为 str 文件路径传递给函数。

您的函数应接受其中一种类型
def predict(
	value: str | None
)
	...

作为输出组件: 期望函数返回一个 str 或 pathlib.Path 文件路径，类型为（.obj、.glb、.stl 或 .gltf）。

您的函数应返回其中一种类型
def predict(···) -> str | Path | None
	...	
	return value

初始化

参数
🔗 
value: str | Callable | None
默认 = None

用于在 model3D 查看器中显示的（.obj、.glb、.stl、.gltf、.splat 或 .ply）文件的路径。如果提供了函数，则每次应用加载时都会调用该函数来设置此组件的初始值。

🔗 
display_mode: Literal['solid', 'point_cloud', 'wireframe'] | None
默认 = None

场景中 3D 模型的显示模式。可以是“solid”（将模型渲染为实体对象）、“point_cloud”或“wireframe”。对于 .splat 或 .ply 文件，此参数将被忽略，因为这些文件只能渲染为实体对象。

🔗 
clear_color: tuple[float, float, float, float] | None
默认 = None

场景的背景颜色，应为介于 0 和 1 之间的 4 个浮点数的元组，表示 RGBA 值。

🔗 
camera_position: tuple[int | float | None, int | float | None, int | float | None]
默认值 = (None, None, None)

场景的初始相机位置，以 `(alpha, beta, radius)` 元组形式提供。每个值都是可选的。如果提供，`alpha` 和 `beta` 应以度为单位，分别反映沿经向和纬向的角位置。Radius 对应于对象中心到相机的距离。

🔗 
zoom_speed: float
默认值 = 1

当旋转鼠标滚轮或在移动设备上捏合屏幕时，场景的缩放速度。应为正浮点数，增加此值可使缩放更快，减小可使缩放更慢。影响相机的 `wheelPrecision` 属性。

🔗 
pan_speed: float
默认值 = 1

当拖动鼠标或在移动设备上拖动屏幕时，场景的平移速度。应为正浮点数，增加此值可使平移更快，减小可使平移更慢。影响相机的 `panSensibility` 属性。

🔗 
height: int | str | None
默认 = None

Model3D 组件的高度，如果传入数字，则以像素为单位指定；如果传入字符串，则以 CSS 单位指定。

🔗 
label: str | I18nData | None
默认 = None

此组件的标签。显示在组件上方，如果该组件有示例表格，也用作标题。如果为 None 且在 `gr.Interface` 中使用，则标签将是此组件分配到的参数名称。

🔗 
show_label: bool | None
默认 = None

如果为 True，将显示标签。

🔗 
every: Timer | float | None
默认 = None

持续调用 `value` 来重新计算它（如果 `value` 是一个函数，否则无效）。可以提供一个 Timer，其滴答声会重置 `value`，或者提供一个浮点数来为重置 Timer 提供常规间隔。

🔗 
inputs: Component | list[Component] | set[Component] | None
默认 = None

用作计算 `value` 的输入的组件（如果 `value` 是一个函数，否则无效）。`value` 在输入更改时会重新计算。

🔗 
container: bool
默认 = True

如果为 True，则会将组件放置在容器中，在边框周围提供一些额外的填充。

🔗 
scale: int | None
默认 = None

与相邻组件相比的相对大小。例如，如果组件 A 和 B 在一个 Row 中，A 的 scale 为 2，B 的 scale 为 1，则 A 的宽度将是 B 的两倍。应为整数。scale 适用于 Rows，以及 Blocks 中 fill_height=True 的顶级组件。

🔗 
min_width: int
默认 = 160

最小像素宽度，如果屏幕空间不足以满足此值，则会换行。如果某个 scale 值导致此组件比 min_width 窄，则将首先考虑 min_width 参数。

🔗 
interactive: bool | None
默认 = None

如果为 True，将允许用户上传文件；如果为 False，只能用于显示文件。如果未提供，则根据组件是用作输入还是输出来推断。

🔗 
visible: bool | Literal['hidden']
默认 = True

如果为 False，则组件将隐藏。如果为“hidden”，则组件将视觉上隐藏并且不会在布局中占用空间，但仍存在于 DOM 中。

🔗 
elem_id: str | None
默认 = None

一个可选字符串，用作此组件在 HTML DOM 中的 id。可用于定位 CSS 样式。

🔗 
elem_classes: list[str] | str | None
默认 = None

一个可选的字符串列表，用作此组件在 HTML DOM 中的类。可用于定位 CSS 样式。

🔗 
render: bool
默认 = True

如果为 False，则组件不会在 Blocks 上下文中渲染。如果打算现在分配事件监听器，但稍后渲染组件，则应使用此选项。

🔗 
key: int | str | tuple[int | str, ...] | None
默认 = None

在 `gr.render` 中，跨重渲染具有相同键的组件被视为同一个组件，而不是一个新组件。在 `preserved_by_key` 中设置的属性在重渲染时不会重置。

🔗 
preserved_by_key: list[str] | str | None
默认 = "value"

此组件构造函数中的参数列表。在 `gr.render()` 函数内部，如果一个组件使用相同的键进行重渲染，则这些（也是唯一的）参数将在 UI 中被保留（如果它们已被用户或事件监听器更改），而不是根据构造函数中提供的值进行重渲染。

🔗 
buttons: list[Button] | None
默认 = None

显示在组件右上角的 `gr.Button()` 实例列表。自定义按钮将出现在工具栏中，并显示其配置的图标和/或标签，点击它们将触发在按钮上注册的任何 `.click()` 事件。

快捷方式

快捷方式
gradio.Model3D
接口字符串快捷方式 "model3d"
初始化 使用默认值

事件监听器

描述

事件监听器允许您响应 Gradio Blocks 应用中定义的 UI 组件的用户交互。当用户与元素交互时（例如，更改滑块值或上传图像），会调用一个函数。

支持的事件监听器

Model3D 组件支持以下事件监听器。每个事件监听器接受相同的参数，这些参数在下表 事件参数 中列出。

监听器
Model3D.change(fn, ···)

当 Model3D 的值发生更改时触发，无论是由于用户输入（例如，用户在文本框中键入）还是由于函数更新（例如，图像从事件触发器的输出接收到值）。有关仅由用户输入触发的监听器，请参阅 .input()。

Model3D.upload(fn, ···)

当用户将文件上传到 Model3D 时触发此监听器。

Model3D.edit(fn, ···)

当用户使用内置编辑器编辑 Model3D（例如图像）时触发此监听器。

Model3D.clear(fn, ···)

当用户使用组件的清除按钮清除 Model3D 时触发此监听器。

事件参数

参数
🔗 
fn: Callable | None | Literal['decorator']
默认 = "decorator"

当此事件触发时调用的函数。通常是机器学习模型的预测函数。函数的每个参数对应一个输入组件，函数应返回一个单一值或一个值元组，元组中的每个元素对应一个输出组件。

🔗 
inputs: Component | BlockContext | list[Component | BlockContext] | Set[Component | BlockContext] | None
默认 = None

用作输入的 gradio.components 列表。如果函数不接受输入，则此列表应为空。

🔗 
outputs: Component | BlockContext | list[Component | BlockContext] | Set[Component | BlockContext] | None
默认 = None

用作输出的 gradio.components 列表。如果函数不返回输出，则此列表应为空。

🔗 
api_name: str | None
默认 = None

定义该端点在 API 文档中如何显示。可以是字符串或 None。如果设置为字符串，则该端点将在 API 文档中以给定名称显示。如果为 None（默认），则使用函数的名称作为 API 端点。

🔗 
api_description: str | None | Literal[False]
默认 = None

API 端点的描述。可以是字符串、None 或 False。如果设置为字符串，则该端点将在 API 文档中以给定描述显示。如果为 None，则使用函数的 docstring 作为 API 端点描述。如果为 False，则 API 文档中不会显示任何描述。

🔗 
scroll_to_output: bool
默认 = False

完成后是否滚动到输出组件

🔗 
show_progress: Literal['full', 'minimal', 'hidden']
默认 = "full"

事件运行时如何显示进度动画：“full”显示一个覆盖输出组件区域的加载指示器，并在右上角显示运行时信息，“minimal”仅显示运行时信息，“hidden”不显示任何进度动画。

🔗 
show_progress_on: Component | list[Component] | None
默认 = None

用于显示进度动画的组件或组件列表。如果为 None，则进度动画将显示在所有输出组件上。

🔗 
queue: bool
默认 = True

如果为 True，则会将请求放在队列中（如果队列已启用）。如果为 False，则不会将此事件放入队列，即使队列已启用。如果为 None，则将使用 Gradio 应用的队列设置。

🔗 
batch: bool
默认 = False

如果为 True，则函数应处理一批输入，这意味着它应该为每个参数接受一个输入值列表。列表的长度应相同（最多为 `max_batch_size`）。然后，该函数*必须*返回一个元组的列表（即使只有一个输出组件），元组中的每个列表对应一个输出组件。

🔗 
max_batch_size: int
默认 = 4

如果从队列调用（仅在 batch=True 时相关），则要批处理的最大输入数量

🔗 
preprocess: bool
默认 = True

如果为 False，则在运行 'fn' 之前不会进行组件数据预处理（例如，当使用 `Image` 组件调用此方法时，将其保留为 base64 字符串）。

🔗 
postprocess: bool
默认 = True

如果为 False，则在将 'fn' 输出返回到浏览器之前，不会进行组件数据后处理。

🔗 
cancels: dict[str, Any] | list[dict[str, Any]] | None
默认 = None

取消其他事件的列表，当此监听器触发时。例如，设置 cancels=[click_event] 将会取消 click_event，其中 click_event 是另一个组件的 .click 方法的返回值。尚未运行的函数（或正在迭代的生成器）将被取消，但正在运行的函数将被允许完成。

🔗 
trigger_mode: Literal['once', 'multiple', 'always_last'] | None
默认 = None

如果设置为 "once"（除 `.change()` 之外所有事件的默认值），则在事件挂起时不允许任何提交。如果设置为 "multiple"，则在事件挂起时允许无限次提交，而 "always_last"（`.change()` 和 `.key_up()` 事件的默认值）则允许在挂起事件完成后进行第二次提交。

🔗 
js: str | Literal[True] | None
默认 = None

在运行 'fn' 之前运行可选的前端 JS 方法。JS 方法的输入参数是 'inputs' 和 'outputs' 的值，返回值应为输出组件的值列表。

🔗 
concurrency_limit: int | None | Literal['default']
默认 = "default"

如果设置，这是可以同时运行的此事件的最大数量。可以设置为 None，表示没有并发限制（此事件可以同时运行任意数量）。设置为 "default" 可使用 `Blocks.queue()` 中的 `default_concurrency_limit` 参数定义的默认并发限制（该参数本身默认为 1）。

🔗 
concurrency_id: str | None
默认 = None

如果设置，这是并发组的 ID。具有相同 `concurrency_id` 的事件将受到最低设置的 `concurrency_limit` 的限制。

🔗 
api_visibility: Literal['public', 'private', 'undocumented']
默认 = "public"

控制此端点的可见性和可访问性。可以是 "public"（在 API 文档中显示并可由客户端调用）、"private"（在 API 文档中隐藏，不可由客户端调用）或 "undocumented"（在 API 文档中隐藏，但可由客户端通过 gr.load 调用）。如果 fn 为 None，则 api_visibility 将自动设置为 "private"。

🔗 
time_limit: int | None
默认 = None
🔗 
stream_every: float
默认 = 0.5
🔗 
key: int | str | tuple[int | str, ...] | None
默认 = None

此事件监听器的唯一键，用于 @gr.render()。如果设置，此值标识在重渲染时具有相同键的事件为相同的事件。

🔗 
validator: Callable | None
默认 = None

可选的验证函数，在主函数运行之前执行。如果提供，此函数将首先使用 queue=False 执行，只有在成功完成后才会调用主函数。验证器接收与主函数相同的输入，并应为每个输入值返回一个 `gr.validate()`。

←

Markdown

MultimodalTextbox

→
gradio