跳转至

GFThumbnailRenderRequest

API Reference / Kernel / 类索引

  • 路径：addons/gf/kernel/editor/gf_thumbnail_render_request.gd
  • 模块：Kernel
  • 继承：RefCounted
  • API：public
  • 类别：编辑器 API (editor_api)
  • 首次版本：8.0.0

缩略图渲染请求描述。 请求只描述一次缩略图渲染的输入，不持有执行状态；执行状态由 GFThumbnailRenderTask 承载。

成员概览

类型 名称 签名
枚举 Kind enum Kind
方法 for_node3d_image static func for_node3d_image( source: Node3D, size: Vector2i = Vector2i(256, 256), transparent: bool = true ) -> GFThumbnailRenderRequest:
方法 for_node3d_texture static func for_node3d_texture( source: Node3D, size: Vector2i = Vector2i(256, 256), transparent: bool = true ) -> GFThumbnailRenderRequest:
方法 for_mesh_image static func for_mesh_image( mesh: Mesh, size: Vector2i = Vector2i(256, 256), transparent: bool = true ) -> GFThumbnailRenderRequest:
方法 for_mesh_texture static func for_mesh_texture( mesh: Mesh, size: Vector2i = Vector2i(256, 256), transparent: bool = true ) -> GFThumbnailRenderRequest:
方法 for_mesh_library_preview_plan static func for_mesh_library_preview_plan( mesh_library: MeshLibrary, size: Vector2i = Vector2i(128, 128), overwrite_existing: bool = true ) -> GFThumbnailRenderRequest:
方法 get_kind func get_kind() -> Kind:
方法 get_source_node3d func get_source_node3d() -> Node3D:
方法 get_mesh func get_mesh() -> Mesh:
方法 get_mesh_library func get_mesh_library() -> MeshLibrary:
方法 get_size func get_size() -> Vector2i:
方法 is_transparent func is_transparent() -> bool:
方法 should_overwrite_existing func should_overwrite_existing() -> bool:
方法 is_valid func is_valid() -> bool:

枚举

Kind

  • API：public
  • 首次版本：8.0.0
enum Kind {
    ## 空请求。
    NONE,
    ## 将 Node3D 渲染为 Image。
    NODE3D_IMAGE,
    ## 将 Node3D 渲染为 ImageTexture。
    NODE3D_TEXTURE,
    ## 将 Mesh 渲染为 Image。
    MESH_IMAGE,
    ## 将 Mesh 渲染为 ImageTexture。
    MESH_TEXTURE,
    ## 为 MeshLibrary 构建预览修改计划。
    MESH_LIBRARY_PREVIEW_PLAN,
}

缩略图渲染请求类型。

方法

for_node3d_image

  • API：public
  • 首次版本：8.0.0
static func for_node3d_image( source: Node3D, size: Vector2i = Vector2i(256, 256), transparent: bool = true ) -> GFThumbnailRenderRequest:

创建 Node3D Image 渲染请求。

参数：

名称 说明
source 要渲染的 3D 节点。
size 输出尺寸。
transparent 是否透明背景。

返回：Node3D Image 渲染请求。

for_node3d_texture

  • API：public
  • 首次版本：8.0.0
static func for_node3d_texture( source: Node3D, size: Vector2i = Vector2i(256, 256), transparent: bool = true ) -> GFThumbnailRenderRequest:

创建 Node3D ImageTexture 渲染请求。

参数：

名称 说明
source 要渲染的 3D 节点。
size 输出尺寸。
transparent 是否透明背景。

返回：Node3D ImageTexture 渲染请求。

for_mesh_image

  • API：public
  • 首次版本：8.0.0
static func for_mesh_image( mesh: Mesh, size: Vector2i = Vector2i(256, 256), transparent: bool = true ) -> GFThumbnailRenderRequest:

创建 Mesh Image 渲染请求。

参数：

名称 说明
mesh 要渲染的 Mesh。
size 输出尺寸。
transparent 是否透明背景。

返回：Mesh Image 渲染请求。

for_mesh_texture

  • API：public
  • 首次版本：8.0.0
static func for_mesh_texture( mesh: Mesh, size: Vector2i = Vector2i(256, 256), transparent: bool = true ) -> GFThumbnailRenderRequest:

创建 Mesh ImageTexture 渲染请求。

参数：

名称 说明
mesh 要渲染的 Mesh。
size 输出尺寸。
transparent 是否透明背景。

返回：Mesh ImageTexture 渲染请求。

for_mesh_library_preview_plan

  • API：public
  • 首次版本：8.0.0
static func for_mesh_library_preview_plan( mesh_library: MeshLibrary, size: Vector2i = Vector2i(128, 128), overwrite_existing: bool = true ) -> GFThumbnailRenderRequest:

创建 MeshLibrary 预览计划请求。

参数：

名称 说明
mesh_library 目标 MeshLibrary。
size 预览尺寸。
overwrite_existing 是否覆盖已有预览。

返回：MeshLibrary 预览计划请求。

get_kind

  • API：public
  • 首次版本：8.0.0
func get_kind() -> Kind:

返回请求类型。

返回：请求类型。

get_source_node3d

  • API：public
  • 首次版本：8.0.0
func get_source_node3d() -> Node3D:

返回 Node3D 来源。

返回：Node3D 来源；非 Node3D 请求时返回 null。

get_mesh

  • API：public
  • 首次版本：8.0.0
func get_mesh() -> Mesh:

返回 Mesh 来源。

返回：Mesh 来源；非 Mesh 请求时返回 null。

get_mesh_library

  • API：public
  • 首次版本：8.0.0
func get_mesh_library() -> MeshLibrary:

返回 MeshLibrary 来源。

返回：MeshLibrary 来源；非 MeshLibrary 请求时返回 null。

get_size

  • API：public
  • 首次版本：8.0.0
func get_size() -> Vector2i:

返回请求尺寸。

返回：请求尺寸。

is_transparent

  • API：public
  • 首次版本：8.0.0
func is_transparent() -> bool:

返回是否使用透明背景。

返回：透明背景时返回 true。

should_overwrite_existing

  • API：public
  • 首次版本：8.0.0
func should_overwrite_existing() -> bool:

返回 MeshLibrary 预览计划是否覆盖已有预览。

返回：覆盖已有预览时返回 true。

is_valid

  • API：public
  • 首次版本：8.0.0
func is_valid() -> bool:

返回请求输入是否完整。

返回：请求可执行时返回 true。