Package
Ploy3D / Package
Class: Package
资源包实例。
Hierarchy
Table of contents
Constructors
Accessors
- classid
- guid
- instanceID
- internalPtr
- label
- package
- path
- previewBlob
- previewUrl
- snapshotBlob
- snapshotPerRow
- snapshotUrl
- state
Methods
Constructors
constructor
• new Package(id)
构造函数。
Parameters
| Name | Type | Description |
|---|---|---|
id | number | 资源实例ID。 |
Overrides
Accessors
classid
• get classid(): ClassID
实例类型ID。
Returns
Inherited from
Resource.classid
guid
• get guid(): string
资源全球唯一ID。
Returns
string
Inherited from
Resource.guid
instanceID
• get instanceID(): number
实例ID。
Returns
number
Inherited from
Resource.instanceID
internalPtr
• get internalPtr(): io_ptr
实例内部指针。
Returns
Inherited from
Resource.internalPtr
label
• get label(): string
实例用户可理解的外部标签。
Returns
string
Inherited from
Resource.label
• set label(label): void
Parameters
| Name | Type |
|---|---|
label | string |
Returns
void
Inherited from
Resource.label
package
• get package(): Package
资源所属资源包。
Returns
Inherited from
Resource.package
path
• get path(): string
资源包路径。
Returns
string
previewBlob
• get previewBlob(): Blob
资源包预览文件。
Returns
Blob
previewUrl
• get previewUrl(): string
资源预览文件路径。
Returns
string
snapshotBlob
• get snapshotBlob(): Blob
资源包快照文件。
Returns
Blob
snapshotPerRow
• get snapshotPerRow(): number
资源包快照文件每行图片数量。
Returns
number
snapshotUrl
• get snapshotUrl(): string
资源快照文件路径。
Returns
string
state
• get state(): ResState
实例状态。
Returns
Inherited from
Resource.state
Methods
Clear
▸ Clear(): void
清除资源内部状态。
Returns
void
Inherited from
Init
▸ Init(_package, _asset): Promise<Package>
异步初始化资源实例
Parameters
| Name | Type | Description |
|---|---|---|
_package | Package | 资源包实例。 |
_asset | Asset | 资源数据。 |
Returns
Promise<Package>
返回异步对象。
Inherited from
LoadAsset
▸ LoadAsset<T>(uri): Promise<{ asset: T ; package: Package }>
异步装载资产数据。
Type parameters
| Name |
|---|
T |
Parameters
| Name | Type | Description |
|---|---|---|
uri | string | 资产数据URI。 |
Returns
Promise<{ asset: T ; package: Package }>
返回异步对象。
LoadBinary
▸ LoadBinary(uri, offset?, size?): Promise<Uint8Array>
异步读取数据文件数据。
Parameters
| Name | Type | Description |
|---|---|---|
uri | string | 数据文件资产URI。 |
offset? | number | 读取偏移。 |
size? | number | 读取大小。 |
Returns
Promise<Uint8Array>
返回异步对象。
LoadResource
▸ LoadResource<T>(uri): Promise<T>
异步加载资源实例。
Type parameters
| Name | Type |
|---|---|
T | extends Resource<T> |
Parameters
| Name | Type | Description |
|---|---|---|
uri | string | 资源实例URI。 |
Returns
Promise<T>
返回异步对象。