Interface IGlb

Namespace

VMagicMirror.Buddy

GLB形式の3Dモデルの読み込みと操作に関するAPIです。 本APIは作成途上のものであり、VMagicMirror v4.0.0の時点では本APIは利用できません。

public interface IGlb

Remarks

VMagicMirror v4.0.0の時点では機能整備が完了していないため、本APIの利用手段は提供していません。 ここでは、想定している機能を提示する目的でドキュメントを公開しています。

VRMやGLBによる3Dオブジェクトをサブキャラとして表示する機能は、 v4.0.0 以降のマイナーアップデートとして提供予定です。

Properties

Transform

オブジェクトの基本姿勢に関する値を取得します。

ITransform3D Transform { get; }

Property Value

ITransform3D

Methods

GetAnimationNames()

読み込んだGLBデータに定義されたアニメーションの名称を取得します。

string[] GetAnimationNames()

Returns

string[]

アニメーション名の一覧

Remarks

Load(string)よりも前にこの関数を呼び出した場合や、GLBデータにアニメーションが定義されていない場合は空の配列を取得します。

Hide()

オブジェクトを非表示にします。

void Hide()

Load(string)

ファイルパスを指定して3Dデータをロードし、表示します。

void Load(string path)

Parameters

path string

GLB

RunAnimation(string, bool)

名前を指定してアニメーションを実行します。

void RunAnimation(string name, bool isLoop)

Parameters

name string

アニメーション名

isLoop bool

ループ再生を行うかどうか

Remarks

この関数で開始させたアニメーションは、アニメーションの実行完了、または別のアニメーションの開始、 または StopAnimation() の呼び出しによって停止します。

読み込んだGLBデータに定義されていないアニメーション名を指定して呼び出した場合は何も起こりません。

Show()

オブジェクトを表示します。Hide() 関数で

void Show()

StopAnimation()

RunAnimation(string, bool) で実行したアニメーションを停止します。

void StopAnimation()

Remarks

アニメーションがすでに停止している場合、この関数を呼んでもとくに何も起こりません。 この関数でアニメーションを停止させると、オブジェクトの見た目が不連続に変化することがあります。