Class ModelLoader

モデルの読み込みユーティリティ

原則、コールバックは非同期に呼び出される

Asyncがつくものは非同期に実行されるかつ、成功結果のTaskが返ってくる

Inheritance
Object
ModelLoader
Inherited Members
Namespace: Pixiv.VroidSdk
Assembly: VRoidSDK.dll
Syntax
public static class ModelLoader

Methods

DeleteModelCache(ISdkConfig)

モデルのキャッシュを削除します

Declaration
public static void DeleteModelCache(ISdkConfig config)
Parameters
Type Name Description
ISdkConfig config

Initialize(ISdkConfig, IDownloadLicensePublishable, String, UInt32, SynchronizationContext)で使用した、あるいは使用する予定のconfigを指定します
Remarks

Initialize(ISdkConfig, IDownloadLicensePublishable, String, UInt32, SynchronizationContext)を呼び出した後に呼び出した場合は、メモリからもキャッシュを削除します。

Exceptions
Type Condition
InvalidOperationException

その他の理由で削除に失敗しました。

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>, IMaterialDescriptorGenerator)

VRMモデルを読み込む

Declaration
public static void LoadVrm(CharacterModel characterModel, Action<GameObject> onSuccess, Action<float> onProgress, Action<ModelLoadFailException> onFailed, IMaterialDescriptorGenerator materialGenerator = null)
Parameters
Type Name Description
CharacterModel characterModel

ダウンロードをするモデル
Action<GameObject> onSuccess

成功コールバック
Action<Single> onProgress

進捗コールバック
Action<ModelLoadFailException> onFailed

失敗コールバック
IMaterialDescriptorGenerator materialGenerator

VRMロード時に使用するMaterialDescriptorGenerator
Remarks

デバイスにキャッシュがある場合はキャッシュから読み込む。 キャッシュが存在しない場合はダウンロードを行う。

Exceptions
Type Condition
Exception

ModelLoaderが初期化されていない場合にスローされる例外
See Also

LoadVrmAsync(CharacterModel, Action<Single>, IMaterialDescriptorGenerator)

VRMモデルを読み込む

Declaration
public static async Task<GameObject> LoadVrmAsync(CharacterModel characterModel, Action<float> onProgress, IMaterialDescriptorGenerator materialGenerator = null)
Parameters
Type Name Description
CharacterModel characterModel

ダウンロードをするモデル
Action<Single> onProgress

進捗コールバック
IMaterialDescriptorGenerator materialGenerator
Returns
Type Description
Task<GameObject>
Remarks

デバイスにキャッシュがある場合はキャッシュから読み込む。 キャッシュが存在しない場合はダウンロードを行う。

Exceptions
Type Condition
Exception

ModelLoaderが初期化されていない場合にスローされる例外
See Also