Resources

Ploy3D • Docs

---

Ploy3D / Resources

Class: Resources

资源管理器。

Constructors

new Resources()

new Resources(_global): Resources

构造函数。

Parameters

• _global: Ploy3D

模块实例对象。

Returns

Resources

Properties

Animator

Animator: Animator_kernel

动画组件内核实现。

---

Camera

Camera: Camera_kernel

相机组件内核实现。

---

Dioramas

Dioramas: Dioramas_kernel

倾斜摄影组件内核实现。

---

Light

Light: Light_kernel

光源组件内核实现。

---

Material

Material: Material_kernel

材质资源内核实现。

---

Mesh

Mesh: Mesh_kernel

网格资源内核实现。

---

MeshRenderer

MeshRenderer: MeshRenderer_kernel

网格渲染器组件内核实现。

---

Object

Object: Object_kernel

3D对象内核实现。

---

Scene

Scene: Scene_kernel

场景内核实现。

---

Shader

Shader: Shader_kernel

着色器资源实例管理器（没有内核实现）。

---

Texture

Texture: Texture_kernel

贴图资源实例管理器（没有内核实现）。

---

VMath

VMath: VMath_kernel

矢量数学方法内核实现。

---

Volume

Volume: Volume_kernel

体积组件内核实现。

Accessors

packageList

get packageList(): PackageReg[]

资源包注册表（该清单可缓存）。

Returns

PackageReg[]

Methods

Browse()

Browse(pkg): Promise<object>

浏览资源包中的可用资源。

Parameters

• pkg: PackageReg

资源包注册信息。

Returns

Promise<object>

资源信息列表。

list

list: object[]

资源清单。

thumbnail?

optional thumbnail: string

缩略图文件路径。

thumbnail_blob?

optional thumbnail_blob: Blob

缩略图数据对象。

thumbnail_per_row?

optional thumbnail_per_row: number

缩略图文件中每行包含缩略图数量。

thumbnail_row_count?

optional thumbnail_row_count: number

缩略图行数。

---

Dispose()

Dispose(): Promise<void>

清除对象。

Returns

Promise<void>

---

Download()

Download(keys): Promise<void>

下载资源包并注册到缓存。

Parameters

• keys: object | object

资源访问键。

Returns

Promise<void>

---

Find()

Find(keys): Promise<PackageReg>

查找资源包注册信息。

Parameters

• keys: object | object

资源访问键。

Returns

Promise<PackageReg>

返回资源包注册信息。

---

GC()

GC(): void

进行动态资源回收。

Returns

void

---

GetPackageByKey()

GetPackageByKey(key): PackageReg

根据资源包名称获取资源包注册信息。

Parameters

• key: string

资源包名称。

Returns

PackageReg

返回资源包注册信息。

---

GetPackageByUUID()

GetPackageByUUID(uuid): PackageReg

根据资源包UUID获取资源包注册信息。

Parameters

• uuid: string

资源包UUID。

Returns

PackageReg

返回资源包注册信息。

---

Init()

Init(): Promise<Resources>

初始化资源管理器。

Returns

Promise<Resources>

返回资源管理器。

---

Load_file()

Load_file<T>(type, uri, not_cache?, cur_pkg?): Promise<object>

加载指定URI的文件数据。

Type Parameters

• T

Parameters

• type: "text" | "json" | "arrayBuffer"

资源文件类型。

• uri: string

资源文件URI。

• not_cache?: boolean

是否缓存文件数据。

• cur_pkg?: PackageReg

当前包注册信息。

Returns

Promise<object>

返回文件数据。

data

data: T

path

path: string

pkg

pkg: PackageReg

---

ParseUri()

ParseUri(uri, cur_pkg?): object | object

解析资源UIR。 资源URI有以下4种模式： "1-1-1.Miaokit.Builtin:/aa/bb/cc.json" ":/aa/bb/cc.json" "1-1-1-17-1" "17-1"

Parameters

• uri: string

资源URI。

• cur_pkg?: PackageReg

当前资源包。

Returns

object | object

返回资源访问键。

---

Preview()

Preview(pkg): Promise<void>

预览资源包（完成资源包预览后，可以通过RESID访问资源包内的内容）。

Parameters

• pkg: PackageReg

Returns

Promise<void>

---

Refresh()

Refresh(): Promise<void>

刷新本地资源包目录（在允许访问本地文件系统的前提下进行）。

Returns

Promise<void>

---

Register()

Register(entry, files?): void

注册资源包。

Parameters

• entry: PackageReg

资源包注册信息。

• files?: Record<string, any>

Returns

void

---

Remove()

Remove(classid, id): void

移除资源类型（何时移除交由内核实现决定）。

Parameters

• classid: CLASSID

资源类型ID。

• id: number

资源实例ID。

Returns

void

---

Scan()

Scan(): Promise<PackageReg[]>

扫描本地资源包目录（在允许访问本地文件系统的前提下进行）。

Returns

Promise<PackageReg[]>

返回资源包可注册信息列表。

---

ToUUID()

ToUUID(uri, cur_pkg?): string

资源URI转资源UUID。

Parameters

• uri: string

资源URI。

• cur_pkg?: PackageReg

当前包注册信息。

Returns

string

返回资源UUID。