Kisetter API使用ガイド

APIを含むKisetterがインストールされたプロジェクトで進めてください。本ガイドは2026-10-22のDev / 6c0de6a3ソースと統合Sampleに基づきます。入力の準備は衣装自動対応ガイド、ProfileのインストールはProfileガイドを参照してください。

1. Editorコードとインスタンスの準備#

公開APIのEden.Kisetter.API.KisetterApiはインスタンスクラスです。以下のファイルを確認してください。

連携スクリプトをプロジェクトのEditorフォルダーに置き、次のnamespaceを追加します。独自のasmdefを使う外部ツールでは、EditorアセンブリからKisetter_Editorを参照するように構成してください。Sample専用asmdefやDummyファイルは不要です。

using System.Collections.Generic;
using Eden.Kisetter.API;
using UnityEngine;

外部EditorクラスのフィールドとしてAPIインスタンスを作成します。

private readonly KisetterApi api = new KisetterApi();

以下のメソッド例は、このクラス内に配置してシーンのオブジェクトを引数で渡す形です。例をすべて続けて実行せず、目的に合う呼び出しを一つ選んでください。対応例で使うOnCompletedは実行結果を処理するで定義します。

インストール確認Sampleを使う#

IsKisetterInstalled()は公開APIのメソッドではなく、統合Sampleが提供します。次のコードはEditorメソッド内で使用します。

var sample = new Eden.Kisetter.Samples.KisetterApiSample();
if (!sample.IsKisetterInstalled())
    return;

現在のEditorセッションでKisetter Editorの型を読み込めるか確認します。個々のAPIへの対応やバージョン互換性を検査するものではありません。

未インストール時、SampleのラッパーはAPIを呼び出しません。実行関数はfalse、Profile取得は空の配列、TryGetCurrentAvatarOptions(out options)はfalseを返します。この場合のoptionsは使わず、完了コールバックも呼ばれません。以下の例は、インストール済みの公開APIを直接呼び出します。

2. Avatarモードで対応を開始する#

シーン内の変換元Humanoidアバター、そのアバターに属する衣装、変換先Humanoidアバターを準備します。入力条件は既存のKisetter UIと同じです。

現在の設定で実行する#

public bool FitAvatar(
    GameObject sourceAvatar,
    GameObject sourceClothes,
    GameObject targetAvatar)
{
    // Omitted options use the current, saved, or built-in settings.
    return api.RunKisetter_AvatarMode(
        sourceAvatar, sourceClothes, targetAvatar,
        onCompleted: OnCompleted);
}

optionsを省略するかnullを渡すと、開いているウィンドウの現在の設定を使用します。新しく開く場合は保存済み設定を読み込み、保存値がなければKisetterの初期値を使用します。

一部のオプションを変更して実行する#

public bool FitAvatarWithOptions(
    GameObject sourceAvatar,
    GameObject sourceClothes,
    GameObject targetAvatar)
{
    // Read a copy before changing individual settings.
    KisetterAvatarOptions options = api.GetCurrentAvatarOptions();
    options.BodyGap = 0.0025f; // Example value, not a required setting.

    return api.RunKisetter_AvatarMode(
        sourceAvatar, sourceClothes, targetAvatar,
        options: options,
        onCompleted: OnCompleted,
        CloseKisetterOnCompletion: true);
}

GetCurrentAvatarOptions()はKisetterウィンドウを開き、現在の設定のコピーを返します。コピーを編集するだけではウィンドウの設定は変わりません。実行関数に渡すとUIに反映され、既存Editorの保存対象となる設定は保存されます。A-pose選択やシーンのMesh参照など、通常は保存されない値は現在のウィンドウ内だけで保持されます。

new KisetterAvatarOptions()やdefaultはC#の既定値で構成された構造体です。Kisetterの初期設定は読み込みません。一部だけ変更する場合は、先に現在の設定を取得してください。

完了後にウィンドウを閉じる#

CloseKisetterOnCompletionはオプション構造体のフィールドではなく、実行関数の独立した引数です。

自動終了は今回の呼び出しだけに適用され、保存されません。キャンセル・失敗・拒否では自動終了しません。ユーザーが手動でウィンドウを閉じてキャンセルした場合、そのウィンドウは閉じた状態です。UsePreAdjustment = falseでもKisetterウィンドウは開き、必要に応じて身体Mesh選択などの既存UIが表示されます。

3. ProfileとBlendShapeを選択する#

Editorメソッド内でインストール済みProfileを取得します。GetProfileList()はウィンドウを開きません。

KisetterProfile[] profiles = api.GetProfileList();
foreach (KisetterProfile profile in profiles)
{
    Debug.Log(profile.ProfileName + ": " + profile.BlendShapeCount);
    foreach (ProfileBlendShape shape in profile.BlendShapes)
        Debug.Log(shape.Id + " / " + shape.Name + " / " + shape.IsSelected);
}

DisplayNameフィールドはありません。取得のたびに独立した新しい配列を返し、IsSelectedはすべてfalseです。Profileがなければ空の一覧、保存済みBlendShapeがなければ空のBlendShape配列を返します。読み取れないProfileはConsoleの警告とともに除外します。

外部ツールのUIでprofilesから有効なselectedProfileIndexを選び、返されたIDでISet<string> selectedIdsを構成した場合の例です。

// Use an index chosen and validated by your tool's UI.
KisetterProfile profile = profiles[selectedProfileIndex];

// Clone the array if another copy must keep independent selections.
profile.BlendShapes = (ProfileBlendShape[])profile.BlendShapes.Clone();

// selectedIds is an ISet<string> populated from the returned Id values.
for (int i = 0; i < profile.BlendShapeCount; i++)
    profile.BlendShapes[i].IsSelected =
        selectedIds.Contains(profile.BlendShapes[i].Id);

ここでのインデックスはUIで選んだProfile一覧の位置であり、BlendShapeのIDではありません。BlendShapeは返されたIdで識別し、IsSelectedだけを変更してください。複数項目を選択できます。選択フラグは保存Snapshotの適用を指定するもので、任意のBlendShapeウェイトを渡す機能ではありません。

• 選択なし、またはBlendShapesがnull・空配列の場合は基本Profileを使用し、以前のウィンドウの選択を引き継ぎません。
• ウィンドウに互換性のあるPresetが設定されている場合は、PresetのBlendShape設定を優先します。
• 存在しないProfileや選択IDはRejectedになります。
• 実行時に選択情報をコピーするため、その後に入力配列を変更しても実行中の要求には影響しません。
• KisetterProfile構造体だけをコピーすると配列は共有されます。独立した選択を保持する必要がある場合に、例のように配列を複製してください。

4. Profileモードで対応を開始する#

RunKisetter_ProfileModeの最初の引数は名前文字列ではなく、取得して選択したKisetterProfile構造体です。衣装と変換先アバターにはシーンのオブジェクトを渡します。

現在の設定で実行する#

public bool FitProfile(
    KisetterProfile profile,
    GameObject sourceClothes,
    GameObject targetAvatar)
{
    return api.RunKisetter_ProfileMode(
        profile, sourceClothes, targetAvatar,
        onCompleted: OnCompleted);
}

一部のオプションを変更して実行する#

public bool FitProfileWithOptions(
    KisetterProfile profile,
    GameObject sourceClothes,
    GameObject targetAvatar)
{
    KisetterAvatarOptions options = api.GetCurrentAvatarOptions();
    options.BodyGap = 0.0025f; // Change only the settings you need.

    return api.RunKisetter_ProfileMode(
        profile, sourceClothes, targetAvatar,
        options: options,
        onCompleted: OnCompleted,
        CloseKisetterOnCompletion: false);
}

Avatarモードと同じKisetterAvatarOptions?、Action<KisetterRunResult>、CloseKisetterOnCompletionを使います。既定値はそれぞれnull、null、falseです。

Profileが元の身体データを提供するため、SourceAvatarIsAPoseとSourceBodyMeshesは使用しません。変換先側のオプションは適用されます。Avatarモードの元オブジェクト・ポーズ・身体Mesh入力は、後でUIから再利用できるよう保持されます。

5. 実行結果を処理する#

Avatar/Profile実行関数のbool戻り値は開始できたかどうかを示します。trueだけで対応や保存が完了したと判断しないでください。最終結果はonCompleted: Action<KisetterRunResult>で受け取ります。

private void OnCompleted(KisetterRunResult result)
{
    // This can run before the start method returns.
    switch (result.Status)
    {
        case KisetterRunStatus.Succeeded:
            Debug.Log("Fitting completed.", result.TargetClothes);
            // Use result.TargetAvatar and result.TargetClothes here.
            break;
        case KisetterRunStatus.Canceled:
            Debug.Log("Fitting canceled: " + result.Message);
            break;
        case KisetterRunStatus.Failed:
            Debug.LogError(result.ErrorCode + " / " + result.Message);
            if (result.Exception != null)
                Debug.LogException(result.Exception);
            break;
        case KisetterRunStatus.Rejected:
            Debug.LogWarning(result.ErrorCode + " / " + result.Message);
            break;
    }
}

結果オブジェクトは成功時だけ提供されます。それ以外のTargetAvatarとTargetClothesはnullです。

コールバックを渡した要求は、Editorメインスレッドで要求ごとに1回結果を受け取ります。拒否や開始エラーでは、実行関数が戻る前に呼ばれることがあります。外部ツールの進行状態やコールバックで使う値は呼び出し前に準備し、falseが返った後に同じ完了処理を重複実行しないでください。アセンブリ再ロード後に処理は再開されず、Unityの強制終了時は通知を保証できません。

6. Mesh StudioとTexture Studioを開く#

Studioの呼び出しはウィンドウを開いて編集対象を割り当てます。trueは対象割り当ての成功を表し、編集・保存完了ではありません。完了コールバック、オプション構造体、自動終了の引数はありません。その後の編集と保存はユーザーがStudio上で行います。

Mesh Studio#

シーンのGameObject rootObjectを渡します。KisetterウィンドウがMesh Studioタブに切り替わり、Root Objectが割り当てられます。

bool opened = api.RunMeshStudio(rootObject);
if (!opened)
    Debug.LogWarning("Mesh Studio could not open. Check the Console.");

Texture Studio：Root Objectから検索する#

bool opened = api.RunTextureStudio(rootObject);

非アクティブな子も含めてRoot以下のSkinnedMeshRendererとMeshRendererを検索します。MeshRendererにはMeshが設定されたMeshFilterが必要です。MeshのないRendererや非対応の種類は除外され、有効な対象が一つもなければfalseを返します。

Texture Studio：Renderer一覧を渡す#

シーン内のSkinnedMeshRenderer clothesSkinnedMeshRendererとMeshRenderer accessoryMeshRendererを用意した場合の、別の呼び出し例です。

// Use scene components with meshes, not Mesh assets.
Renderer[] meshes = { clothesSkinnedMeshRenderer, accessoryMeshRenderer };
bool opened = api.RunTextureStudio(meshes);

このオーバーロードはIReadOnlyList<Renderer>を受け取り、配列とList<Renderer>の両方を使用できます。

• 指定したRendererだけを登録し、子は検索しません。
• 重複参照を除き、最初に出現した順序を維持します。先頭の項目がMain Meshになります。
• 空一覧、null項目、アセット、Meshなし、非対応Rendererのいずれかがあると要求全体を拒否し、既存の編集対象を維持します。
• 同じGameObjectに両方のRendererがある場合はSkinnedMeshRendererを使用します。そのオブジェクトの別のRendererを明示すると拒否されます。
• 入力一覧をコピーするため、呼び出し後に元の一覧を変えても現在のセッションは変わりません。

進行中のStudio作業を保護する#

操作中でも未保存の変更がある状態でもなければ、Studioタブは必要なタブに自動で切り替わります。実行中の対応、未保存編集、開いているMesh Studioの保存・分離ウィンドウ、Texture Studioの選択・描画・ドラッグは保護されます。作業を終えるか変更を保存・破棄してから再度呼び出してください。

Studioがfalseを返した場合はConsoleを確認します。Texture Studioはインストール済みKisetterで有効になっている必要があります。現在のソースは既存のKisetterDev.isEarlyAccessMode条件に従い、APIがこの条件を迂回することはありません。

7. 共通オプション一覧#

GetCurrentAvatarOptions()で取得したコピーの必要なフィールドだけを変更し、実行関数のoptionsに渡します。以下は公開フィールドの一覧です。設定の基本概念はパラメータの説明も参照してください。

入力と事前調整#

身体Mesh配列がnullなら現在の選択を維持し、空配列なら選択を解除します。指定したアバター外のMeshは除外します。選択された身体Meshがなければ既存の選択UIが表示されます。

変形とMeshごとの選択#

ClothMeshesは現在のSource Clothesに属するMeshだけに作用します。nullや省略した項目は既存の選択を維持し、新しく検出したMeshは既定で選択されます。GameObjectのアクティブ状態は変更しません。

結果とボーン#

身体Meshと対応から外す衣装Meshを指定する例#

sourceBodyMesh、targetBodyMesh、clothesMeshはシーン内のSkinnedMeshRenderer参照です。コピーを変更したら、AvatarまたはProfileの実行関数一つに渡します。

KisetterAvatarOptions options = api.GetCurrentAvatarOptions();
options.AutoAssignBodyMeshes = false;
options.SourceBodyMeshes = new[] { sourceBodyMesh }; // Avatar mode only.
options.TargetBodyMeshes = new[] { targetBodyMesh };
options.ClothMeshes = new[]
{
    new KisetterClothMeshOption
    {
        Mesh = clothesMesh,
        ApplyFitting = false
    }
};
// Pass options to ONE Avatar-mode or Profile-mode call.

取得・適用時に配列はコピーされますが、配列内のUnityオブジェクトは同じオブジェクトへの参照です。

8. 実行できない場合の確認#

確認済みの実行範囲と未確認事項

2026-10-22のUnity 6000.2.6f2の検証記録では、Avatarと基本Profile対応、Mesh保存、コールバック・キャンセル・拒否、Studio切り替え、実際のTexture編集の保護を、対象シナリオで確認しました。

UIとAPIの数値的な同一性は確認できていません。その環境での最大World頂点差は、UI/API間で約29.06 mm、UIの反復実行で約35.08 mmでした。API固有の原因と断定したり、同一結果を保証したりする根拠にはなりません。

検証したShinanoのBody_base::Toe_heels Snapshotは、Torso Gridデータ不一致により既存UI・APIの両方で失敗しました。未選択の基本Profileは成功しましたが、すべてのProfile・BlendShape・Presetの組み合わせを検証したわけではありません。この事例が全Profileの利用制限を意味するわけではありません。

Unity 2022、実行中のPlay Mode移行・アセンブリ再ロード、FBX書き出しなどは今回の実行検証の対象外です。上記の呼び出し仕様は確認したソースに基づき、個々の組み合わせの結果は各プロジェクトで確認してください。

検証範囲を閉じる