Interface ISprite3D

Namespace

VMagicMirror.Buddy

画像を3D空間上のスプライトとして表示するAPIです。

public interface ISprite3D

Remarks

このAPIでは .jpg または .png ファイル、およびプリセットとしてアプリケーションに組み込まれた画像をロードできます。

画像は長いほうの辺を1mにするようなスケールでロードされます。 このスケールは GetTransform3D(string) または Transform で得られるTransformのスケールを通じて調整できます。 直感的なサイズ調整のために、スプライトとしては正方形の画像を用意することを推奨しています。 また、サブキャラに表情差分などの画像群がある場合、原則として各画像のサイズを揃えるようにしてください。

Properties

Transform

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

ITransform3D Transform { get; }

Property Value

ITransform3D

Methods

Hide()

スプライトを非表示にします。

void Hide()

Preload(string)

ファイルパスを指定して、該当パスの画像を事前にロードします。

void Preload(string path)

Parameters

path string

画像ファイルのパス

Remarks

この関数を事前に呼ぶことは必須ではありませんが、起動時に呼び出しておくことにより、スプライトの切り替え時に時間がかかるのを防ぐことができます。

Show(string)

ファイルパスを指定して、該当パスの画像をスプライトとしてロードします。

void Show(string path)

Parameters

path string

Remarks

サブキャラが起動中に同一ファイルパスの画像を複数回指定すると、すでにロード済みの画像が再利用されます。

ShowPreset(string)

プリセット画像の名称を指定して画像を表示します。

void ShowPreset(string name)

Parameters

name string

プリセット画像の名称

Remarks

プリセット画像とは、アプリケーション自体に組み込まれていてサブキャラとして利用可能な画像のことです。

name に指定可能な値については ShowPreset(string, Sprite2DTransitionStyle, float) を参照して下さい。