Table of Contents

Interface ISprite2D

Namespace
VMagicMirror.Buddy

画像をアバターウィンドウの最前面に平面的に表示するAPIです。

public interface ISprite2D

Remarks

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

画像のサイズ等は画面全体のサイズがおおよそ 1280x720 であるとした場合の値を用いて指定します。 サイズ調整を直感的に行うために、画像アセットとスプライトはいずれも正方形の形状にしておくことを推奨しています。 また、サブキャラに表情差分などの画像群がある場合、原則として各画像のサイズを揃えるようにしてください。

Properties

DefaultSpritesSetting

SetupDefaultSprites(string, string, string, string) や ShowDefaultSprites(Sprite2DTransitionStyle, float) を用いて適用できる、 デフォルトの立ち絵についての動作の設定を取得します。

IDefaultSpritesSetting DefaultSpritesSetting { get; }

Property Value

IDefaultSpritesSetting

Effects

スプライトに適用するエフェクトの設定を取得します。

ISpriteEffect Effects { get; }

Property Value

ISpriteEffect

Size

スプライトのサイズを取得、設定します。

Vector2 Size { get; set; }

Property Value

Vector2

Remarks

サイズは、アバターウィンドウ全体のサイズがおおよそ 1280x720 であるとした場合の値として指定します。 例えば、new Vector2(150, 150) 程度の値はスプライトの基本的なサイズとして適しています。

TalkText

この画像に紐づけたテキスト表示を行うAPIを取得します。

ITalkText TalkText { get; }

Property Value

ITalkText

Transform

位置や回転などの、オブジェクトの基本的な配置に関するAPIを取得します。

ITransform2D Transform { get; }

Property Value

ITransform2D

Methods

Hide()

サブキャラを非表示にします。

void Hide()

Preload(string)

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

void Preload(string path)

Parameters

path string

画像ファイルのパス

Remarks

この関数をサブキャラのロード直後に呼び出すことで、サブキャラの動作中の画像切り替えがスムーズに行えます。

SetupDefaultSprites(string, string, string, string)

まばたき、および口の開閉の組み合わせからなる4枚の画像を指定することで、 サブキャラの基本となる立ち絵スプライトをセットアップします。

void SetupDefaultSprites(string defaultImagePath, string blinkImagePath, string mouthOpenImagePath, string blinkMouthOpenImagePath)

Parameters

defaultImagePath string

目を開き、口を閉じている立ち絵の画像ファイルのパス

blinkImagePath string

目を閉じ、口を開いている立ち絵の画像ファイルのパス

mouthOpenImagePath string

目を開き、口を開いている立ち絵の画像ファイルのパス

blinkMouthOpenImagePath string

目を閉じ、口を開いている立ち絵の画像ファイルのパス

Remarks

この関数はセットアップのために一度だけ呼び出します。 その後、 ShowDefaultSprites(Sprite2DTransitionStyle, float) を呼び出すことで指定した画像が表示されます。

簡易的なセットアップでサブキャラのまばたき、口パクを動かしたい場合、この関数で基本の立ち絵をセットアップします。 まばたきや口パクをより詳細に制御したい場合、このメソッドは使用せず、代わりに Show(string) や Show(string, Sprite2DTransitionStyle, float) を使用します。

SetupDefaultSpritesByPreset()

サブキャラの立ち絵スプライトとして、プリセットで定義されたキャラクター画像を適用します。

void SetupDefaultSpritesByPreset()

Remarks

このメソッドではプリセットのサブキャラを立ち絵として適用します。

Show(string)

ファイルパスを指定して画像を表示します。

void Show(string path)

Parameters

path string

画像ファイルのパス

Remarks

このメソッドでは画像は指定されたものへ直ちに切り替わります。

アニメーションを適用しながら画像を切り替えたい場合は　Show(string, Sprite2DTransitionStyle, float) を使用します。

Show(string, Sprite2DTransitionStyle, float)

ファイルパスと切り替え演出を指定して画像を表示します。

void Show(string path, Sprite2DTransitionStyle style, float duration)

Parameters

path string

画像ファイルのパス

style Sprite2DTransitionStyle

画像切り替えのスタイル。。

duration float

画像切り替え動作を実行する秒数。0以下の値を指定した場合、ただちに画像が切り替わります。

Remarks

Preload(string) を呼び出したことのある画像や起動後に表示したことのある画像のパスを指定した場合、 すでに読み込み済みの画像が再利用されます。

style として Immediate を指定した場合、 duration の値は無視され、ただちに画像が切り替わります。 これは Show(string) と同じ動作です。

ShowDefaultSprites()

SetupDefaultSprites(string, string, string, string) でセットアップした立ち絵を直ちに表示します。 メソッドの詳細は　ShowDefaultSprites(Sprite2DTransitionStyle, float) を参照して下さい。

void ShowDefaultSprites()

ShowDefaultSprites(Sprite2DTransitionStyle, float)

SetupDefaultSprites(string, string, string, string) でセットアップしたデフォルトの立ち絵を表示します。

void ShowDefaultSprites(Sprite2DTransitionStyle style, float duration)

Parameters

style Sprite2DTransitionStyle

画像切り替えのスタイル。指定しない場合、ただちに画像が切り替わります。

duration float

画像切り替え動作を実行する秒数。0以下の値を指定した場合、ただちに画像が切り替わります。

Remarks

この関数を呼び出す場合、あらかじめ SetupDefaultSprites(string, string, string, string) でセットアップを行う必要があります。 事前に SetupDefaultSprites(string, string, string, string) を呼び出していなかった場合、このメソッドを呼び出しても何も起こりません。

ShowPreset(string)

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

void ShowPreset(string name)

Parameters

name string

プリセット画像の名称

Remarks

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

name に指定可能な値の詳細や、画像切り替え時の演出を調整する場合の呼び出しについては ShowPreset(string, Sprite2DTransitionStyle, float) を参照して下さい。

ShowPreset(string, Sprite2DTransitionStyle, float)

プリセット画像の名称、および切り替え演出を指定して画像を表示します。

void ShowPreset(string name, Sprite2DTransitionStyle style, float duration)

Parameters

name string

プリセット画像の名称

style Sprite2DTransitionStyle

画像切り替えのスタイル

duration float

画像切り替え動作を実行する秒数。0以下の値を指定した場合、ただちに画像が切り替わります。

Remarks

プリセット画像とは、アプリケーション自体に組み込まれていてサブキャラとして利用可能な画像のことです。 v4.0.0では name として以下の値を指定できます。

  • "A_default"
  • "A_blink"
  • "A_mouthOpen"
  • "A_blink_mouthOpen"
  • "A_happy"
  • "A_angry"
  • "A_sad"
  • "A_relaxed"
  • "A_surprised"
  • "A_wink"
  • "A_smug_face"

この関数はサブキャラの表情を切り替える場合などに適しています。

その他の用途については Show(string, Sprite2DTransitionStyle, float) を参照して下さい。

Events

PointerClick

この画像上でポインター(マウスカーソルなど)で左クリックに相当するボタンでクリック操作を行うと発火します。

event Action<Pointer2DData> PointerClick

Event Type

Action<Pointer2DData>

Remarks

クリックのエリアはスプライトのサイズ全体の矩形で決定されます。 透過部分の多い画像を表示している場合、画像がないエリアでの操作にも反応することに注意して下さい。

このイベントは、ボタンを押した場所でドラッグ操作を行わずに離すことで発火します。 ボタンを押した瞬間が検出したい場合などは、代わりに PointerDown を使用します。

PointerDown

この画像上でポインター(マウスカーソルなど)で左クリックに相当するボタンを押すと発火します。

event Action<Pointer2DData> PointerDown

Event Type

Action<Pointer2DData>

Remarks

クリックのエリアはスプライトのサイズ全体の矩形で決定されます。 透過部分の多い画像を表示している場合、画像がないエリアでの操作にも反応することに注意して下さい。

このイベントはボタン等のクリックと異なり、クリックの開始の瞬間に発火します。 クリックを検出したい場合には PointerClick を使用します。

PointerEnter

この画像の領域にポインター(マウスカーソルなど)が進入すると発火します。

event Action<Pointer2DData> PointerEnter

Event Type

Action<Pointer2DData>

Remarks

画像の領域はスプライトのサイズ全体の矩形で決定されます。 透過部分の多い画像を表示している場合、画像がないエリアでの操作にも反応することに注意して下さい。

PointerLeave

この画像の領域からポインター(マウスカーソルなど)が離れると発火します。

event Action<Pointer2DData> PointerLeave

Event Type

Action<Pointer2DData>

Remarks

画像の領域はスプライトのサイズ全体の矩形で決定されます。 透過部分の多い画像を表示している場合、画像がないエリアでの操作にも反応することに注意して下さい。

PointerUp

この画像上でポインター(マウスカーソルなど)の左クリックに相当するボタンを離すと発火します。

event Action<Pointer2DData> PointerUp

Event Type

Action<Pointer2DData>

Remarks

クリックのエリアはスプライトのサイズ全体の矩形で決定されます。 透過部分の多い画像を表示している場合、画像がないエリアでの操作にも反応することに注意して下さい。

このイベントはドラッグ操作を含むような操作の後でも発火します。 クリックを検出したい場合には PointerClick を使用します。