Class ModelLoader
Model load utility
In principle, callback called asynchronously
Anything with Async will be executed asynchronously, success result Task will be returned
Inherited Members
Namespace: Pixiv.VroidSdk
Assembly: VRoidSDK.dll
Syntax
public static class ModelLoaderMethods
Initialize(ISdkConfig, IDownloadLicensePublishable, String, UInt32, SynchronizationContext)
初期化
Declaration
public static void Initialize(ISdkConfig config, IDownloadLicensePublishable downloadApi, string cacheEncryptPassword, uint maxCacheCount = 10U, SynchronizationContext context = null)Parameters
| Type | Name | Description |
|---|---|---|
| ISdkConfig | config | VRoid SDKの利用設定 |
| IDownloadLicensePublishable | downloadApi | ダウンロードAPIをリクエストするクライアント |
| String | cacheEncryptPassword | モデルデータを暗号化するアプリケーション固有の任意文字列 |
| UInt32 | maxCacheCount | 保持するモデルの最大数 |
| SynchronizationContext | context | メインスレッドのSynchronizationContext |
LoadVrm(CharacterModel, Action<GameObject>, Action<Single>, Action<ModelLoadFailException>, Func<VRMData, VRMImporterContext>)
VRMモデルを読み込む
Declaration
public static void LoadVrm(CharacterModel characterModel, Action<GameObject> onSuccess, Action<float> onProgress, Action<ModelLoadFailException> onFailed, Func<VRMData, VRMImporterContext> onGenerateVRMImporterContext = null)Parameters
| Type | Name | Description |
|---|---|---|
| CharacterModel | characterModel | ダウンロードをするモデル |
| Action<GameObject> | onSuccess | 成功コールバック |
| Action<Single> | onProgress | 進捗コールバック |
| Action<ModelLoadFailException> | onFailed | 失敗コールバック |
| Func<VRMData, VRMImporterContext> | onGenerateVRMImporterContext | 読み込んだVRMDataからVRMImporterContextを生成したい場合に使用します(オプショナル) |
Remarks
デバイスにキャッシュがある場合はキャッシュから読み込む。 キャッシュが存在しない場合はダウンロードを行う。
Exceptions
| Type | Condition |
|---|---|
| Exception | ModelLoaderが初期化されていない場合にスローされる例外 |
See Also
LoadVrmAsync(CharacterModel, Action<Single>, Func<VRMData, VRMImporterContext>)
VRMモデルを読み込む
Declaration
public static async Task<GameObject> LoadVrmAsync(CharacterModel characterModel, Action<float> onProgress, Func<VRMData, VRMImporterContext> onGenerateVRMImporterContext = null)Parameters
| Type | Name | Description |
|---|---|---|
| CharacterModel | characterModel | ダウンロードをするモデル |
| Action<Single> | onProgress | 進捗コールバック |
| Func<VRMData, VRMImporterContext> | onGenerateVRMImporterContext | 読み込んだVRMDataからVRMImporterContextを生成したい場合に使用します(オプショナル) |
Returns
| Type | Description |
|---|---|
| Task<GameObject> |
Remarks
デバイスにキャッシュがある場合はキャッシュから読み込む。 キャッシュが存在しない場合はダウンロードを行う。
Exceptions
| Type | Condition |
|---|---|
| Exception | ModelLoaderが初期化されていない場合にスローされる例外 |