目次 クイックスタート ( 無料版の Unity で利用する場合 )... 3 クイックスタート (Unity Pro で利用する場合 )...6 Chroma Key Compositing( クロマキー合成 )... 9 MascotMakerFree クラスリファレンス Masco

Transcription

1 Desktop Mascot Maker for Unity4.6 リファレンスマニュアル Ver /03/05 by PanzerSoft 注意事項 DesktopMascotMaker は Unity 上でデスクトップマスコットを作るツールです Unity のカメラに映るものなら 3D でも 2D でも何でも簡単にデスクトップマスコットを作ることができます! このアセットを利用する前に 以下の点にご注意下さい ビルドのターゲットとなるプラットフォームは Windows だけとなります このアセットは無料版の Unity でも利用できますが もし マシンパフォーマンスを最大限に活かしたい場合は Unity Pro を利用することをおすすめします Unity5 なら Personal edition Professional edition ともに機能の制限なく Desktop Mascot Maker を利用できます 移行が可能であれば Unity5 を利用しましょう 連絡先 1

2 目次 クイックスタート ( 無料版の Unity で利用する場合 )... 3 クイックスタート (Unity Pro で利用する場合 )...6 Chroma Key Compositing( クロマキー合成 )... 9 MascotMakerFree クラスリファレンス MascotMakerFree FAQ MascotMakerPro クラスリファレンス...14 MascotMakerPro FAQ...17 一般的な FAQ...19 ugui の利用方法 ビルドセッティング

3 クイックスタート ( 無料版の Unity で利用する場合 ) 無料版の Unity で利用する場合は MacotMakerFree コンポーネントを使って下さい 無料版の Unity では MacotMakerPro コンポーネントは動きません (1) マスコットをシーンに置いて下さい 3

4 (2) カメラに MascotMakerFree コンポーネントをアタッチして下さい MascotMakerFree コンポーネントは メニューの Menu>Component>DesktopMascotMaker>MascotMakerFree から追加します 以下が MascotMakerFree の設定項目です 適宜設定して下さい これらの変数には スクリプトから MascotMakerFree.Instance.xxx を経由してもアクセスできます Play On Awake : もし true なら マスコットは起動と同時に表示されます Top Most : もし true なら マスコットは常に最前面に表示されます Drag Move : もし true なら マスコットを左クリック & ドラッグで移動できます Chroma Key Compositing : クロマキーモードで描画します ( 詳細は後述 ) 4

5 以上です! プレイボタンを押して マスコットを確認して下さい さらに高度な使い方について Assets/DesktopMascotMaker/Demo/ForUnityFree のフォルダにあるデモを見て下さい Demo01_ForFree_General.unity は Unity からマスコットとインタラクションする方法をデモします Demo02_ForFree_Event.unity は DesktopMascotMaker で利用できるイベント処理についてデモします Demo03_ForFree_Physics.unity は Unity で発生した物理挙動をマスコットに反映する方法についてデモします Demo04_ForFree_uGUI.unity は DesktopMascotMaker での ugui の使い方についてデモします Demo05_ForFree_HideMainWindow.unity は Unity のメインウィンドウを消したり 半透明にしたりする方法についてデモします 5

6 クイックスタート (Unity Pro で利用する場合 ) もしあなたが Unity Pro を使っているなら 是非 MascotMakerPro コンポーネントを利用して下さい! MascotMakerPro は MascotMakerFree よりもずっと処理パフォーマンスが良いです (1) マスコットをシーンに置いて下さい 6

7 (2) カメラに MascotMakerPro コンポーネントをアタッチして下さい MascotMakerPro コンポーネントは メニューの Menu > Component > DesktopMascotMaker > MascotMakerPro (Pro Only) から追加します 以下が MascotMakerPro の設定項目です 適宜設定して下さい これらの変数には スクリプトから MascotMakerPro.Instance.xxx を経由してもアクセスできます Play On Awake : もし true なら マスコットは起動と同時に表示されます Top Most : もし true なら マスコットは常に最前面に表示されます Drag Move : もし true なら マスコットを左クリック & ドラッグで移動できます Chroma Key Compositing : クロマキー合成モードでレンダリングします ( 詳細は後述 ) 7

8 以上です! プレイボタンを押して マスコットを確認して下さい さらに高度な使い方について Assets/DesktopMascotMaker/Demo/ForUnityPro のフォルダにあるデモを見て下さい Demo01_ForPro_General.unity は Unity からマスコットとインタラクションする方法をデモします Demo02_ForPro_Event.unity は DesktopMascotMaker で利用できるイベント処理についてデモします Demo03_ForPro_Physics.unity は Unity で発生した物理挙動をマスコットに反映する方法についてデモします Demo04_ForPro_uGUI.unity は DesktopMascotMaker での ugui の使い方についてデモします Demo05_ForPro_HideMainWindow.unity は Unity のメインウィンドウを消したり 半透明にしたりする方法についてデモします 8

9 Chroma Key Compositing( クロマキー合成 ) 透過シェーダを利用している場合 マスコットのレンダリングが乱れることがあります そのような時は Chroma Key Compositing をオンにして下さい 透過シェーダを利用しない場合は Chroma Key Compositing をオフにすることをおすすめします Chroma Key Compositing Off Chroma Key Compositing On Chroma Key Compositing のチェックで クロマキー合成モードを On/Off します Chroma Key Color はクロマキー合成を行うための背景色です この色が透明色になります Chroma Key Range はクロマキー合成の強度です [ ] 9

10 MascotMakerFree クラスリファレンス シングルトン インスタンスを通して変数や関数にアクセスする MascotMakerFree クラスはシングルトンデザインパターンで実装されています そのため MascotMakerFree クラスの変数や関数にアクセスするためには MascotMakerFree.Instance を利用します using DesktopMascotMaker; // 左のように namespace を定義します... MascotMakerFree.Instance.xxx =... // この様な形式で変数や関数にアクセスします マスコットの位置 マスコットの位置は Left, Top( または Location) で操作できます int MascotMakerFree.Instance.Left int MascotMakerFree.Instance.Top System.Drawing.Point MascotMakerFree.Instance.Location int MascotMakerFree.Instance.Width // read only です Form の幅 int MascotMakerFree.Instance.Height // read only です Form の高さ int MascotMakerFree.Instance.ScreenWidth // read only です 画面の幅 int MascotMakerFree.Instance.ScreenHeight // read only です 画面の高さ 10

11 マスコットの不透明度 マスコットの不透明度 表示 非表示は以下のようにして変更します MascotMakerFree.Instance.Opacity = 128; // [0-255] 0 で透明 255 で不透明です MascotMakerFree.Instance.Hide(); // マスコットを非表示にします MascotMakerFree.Instance.Show(); // マスコットを表示します マウスがマスコットに重なっているか? マウスカーソルがマスコットの上に重なっているかを検知します bool mouseover = MascotMakerFree.Instance.IsMouseOver; // read only です 11

12 イベント関数の設定 Desktop Mascot Maker では マウスイベント マスコットのアクティベート / ディアクティベートイベント キーイベント ドラッグアンドドロップイベント ムーブイベントが利用できます 以下の様に特定の関数をイベントハンドラに登録して利用します // MascotMakerFree の EventHandler に関数を登録します MascotMakerFree.Instance.OnLeftMouseDown += MouseDown;... void MouseDown(object sender, MouseEventArgs e) { // マウスを押すとこの部分のコードが実行されます } MascotMakerFree で利用できるイベントハンドラのリストです Event Event Handler Type OnLeftMouseDown MouseEventHandler マウス左ボタンが押されたときに発生 OnLeftMouseUp MouseEventHandler マウス左ボタンが放されたときに発生 OnLeftDoubleClick MouseEventHandler マウス左ボタンがダブルクリックされたときに発生 OnRightMouseDown MouseEventHandler マウス右ボタンが押されたときに発生. OnRightMouseUp MouseEventHandler マウス右ボタンが放されたときに発生 OnRightDoubleClick MouseEventHandler マウス右ボタンがダブルクリックされたときに発生 OnMiddleMouseDown MouseEventHandler マウス中ボタンが押されたときに発生 OnMiddleMouseUp MouseEventHandler マウス中ボタンが放されたときに発生 OnMiddleDoubleClick MouseEventHandler マウス中ボタンがダブルクリックされたときに発生 OnMouseWheel MouseEventHandler マウスホイールが回転したときに発生 OnActivated EventHandler マスコットの Form がアクティベートされたときに発生 OnDeactivate EventHandler マスコットの Form がディアクティベートされたときに発生 OnKeyDown KeyEventHandler マスコットの Form でキーが押されてたときに発生 OnKeyUp KeyEventHandler マスコットの Form でキーが放されたときに発生 OnDragDrop DragEventHandler ドラッグアンドドロップ動作が完了したときに発生 OnDragEnter DragEventHandler マスコットの Form 内にドラッグで入ったときに発生 OnDragLeave EventHandler マスコットの Form 内からドラッグで出たときに発生 OnDragOver DragEventHandler マスコットの Form 上をドラッグしているときに発生 OnMove EventHandler マスコットの Form がマウス操作で動いているときに発生 詳しくは Demo02_ForFree_Event.unity のデモを御覧ください 12

13 MascotMakerFree FAQ Q : MascotMakerFree を使っている時に マスコットの解像度を変えたい場 合どうしたらいいですか? A : PlayerSettings の Default Screen Width/Height の値を変えて下さい MascotMakerFree では マスコットの解像度は PlayerSettings の Default Screen Width/Height で変化します マスコットの解像度はパフォーマンスに大きく影響します なるべく小さい値にしましょう 13

14 MascotMakerPro クラスリファレンス シングルトン インスタンスを通して変数や関数にアクセスする MascotMakerPro クラスはシングルトンデザインパターンで実装されています そのため MascotMakerPro クラスの変数や関数にアクセスするためには MascotMakerPro.Instance を利用します using DesktopMascotMaker; // 左のように namespace を定義します... MascotMakerPro.Instance.xxx =... // この様な形式で変数や関数にアクセスします マスコットの位置 マスコットの位置は Left, Top( または Location) で操作できます int MascotMakerPro.Instance.Left int MascotMakerPro.Instance.Top System.Drawing.Point MascotMakerPro.Instance.Location int MascotMakerPro.Instance.Width // read only です Form の幅 int MascotMakerPro.Instance.Height // read only です Form の高さ int MascotMakerPro.Instance.ScreenWidth // read only です 画面の幅 int MascotMakerPro.Instance.ScreenHeight // read only です 画面の高さ 14

15 マスコットの不透明度 マスコットの不透明度 表示 非表示は以下のようにして変更します MascotMakerPro.Instance.Opacity = 128; // [0-255] 0 で透明 255 で不透明です MascotMakerPro.Instance.Hide(); // マスコットを非表示にします MascotMakerPro.Instance.Show(); // マスコットを表示します マウスがマスコットに重なっているか? マウスカーソルがマスコットの上に重なっているかを検知します bool mouseover = MascotMakerPro.Instance.IsMouseOver; // read only です 15

16 イベント関数の設定 Desktop Mascot Maker では マウスイベント マスコットのアクティベート / ディアクティベートイベント キーイベント ドラッグアンドドロップイベント ムーブイベントが利用できます 以下の様に特定の関数をイベントハンドラに登録して利用します // MascotMakerPro の EventHandler に関数を登録します MascotMakerPro.Instance.OnLeftMouseDown += MouseDown;... void MouseDown(object sender, MouseEventArgs e) { // マウスを押すとこの部分のコードが実行されます } MascotMakerPro で利用できるイベントハンドラのリストです Event Event Handler Type OnLeftMouseDown MouseEventHandler マウス左ボタンが押されたときに発生 OnLeftMouseUp MouseEventHandler マウス左ボタンが放されたときに発生 OnLeftDoubleClick MouseEventHandler マウス左ボタンがダブルクリックされたときに発生 OnRightMouseDown MouseEventHandler マウス右ボタンが押されたときに発生.. OnRightMouseUp MouseEventHandler マウス右ボタンが放されたときに発生 OnRightDoubleClick MouseEventHandler マウス右ボタンがダブルクリックされたときに発生 OnMiddleMouseDown MouseEventHandler マウス中ボタンが押されたときに発生 OnMiddleMouseUp MouseEventHandler マウス中ボタンが放されたときに発生 OnMiddleDoubleClick MouseEventHandler マウス中ボタンがダブルクリックされたときに発生 OnMouseWheel MouseEventHandler マウスホイールが回転したときに発生 OnActivated EventHandler マスコットの Form がアクティベートされたときに発生 OnDeactivate EventHandler マスコットの Form がディアクティベートされたときに発生 OnKeyDown KeyEventHandler マスコットの Form でキーが押されてたときに発生. OnKeyUp KeyEventHandler マスコットの Form でキーが放されたときに発生 OnDragDrop DragEventHandler ドラッグアンドドロップ動作が完了したときに発生 OnDragEnter DragEventHandler マスコットの Form 内にドラッグで入ったときに発生 OnDragLeave EventHandler マスコットの Form 内からドラッグで出たときに発生 OnDragOver DragEventHandler マスコットの Form 上をドラッグしているときに発生 OnMove EventHandler マスコットの Form がマウス操作で動いているときに発生 詳しくは Demo02_ForPro_Event.unity のデモを御覧ください 16

17 MascotMakerPro FAQ Q :MascotMakerPro を使っている時に マスコットの解像度を変えたい場合 どうしたらいいですか? A : 下図の RenderTexture の解像度を変更して下さい 注意 : RenderTexture の名前を変更しないで下さい (MascotMakerProTexture). Q: 以下のような警告が出ます どうしたらいいですか? A: すみません この警告は現在のところ消えません ugui の描画を適切に行うために 特殊なレンダリングしているためこの様な警告が出てしまいます 検討の結果 MascotMakerPro では現在のレンダリング方法がベストだと判断しています ですのでこちらの警告は無視して下さい ご不便をおかけいたしまして申し訳ございません 17

18 Q: プレイモードにしてみたのですが ユニティちゃんが見当たりません A: プロジェクトを再起動してみてください 18

19 一般的な FAQ Q: このメッセージボックスは何ですか? A: すみません これは Mono の内部的なメッセージです しかし このメッ セージはあなたのプロジェクトに影響しません 無視して下さい ご不便をおかけいたしまして申し訳ございません このメッセージウィンドウは Unity に含まれる mono の dll 内で生成されています (... Unity Editor Data Mono lib mono 2.0 System.Windows.Forms.dll) こちらのコードの 894 行目が呼び出されることによって発生します このメッセージウィンドウは Unity のエディタ環境内で Win32RegisterClass が false を返してしまうため に表示されます このメッセージウィンドウは Unity のエディタ環境内でのみ表示されます あなたが最終 的にビルドして作るプログラムではこちらのメッセージウィンドウは表示されませんのでご安心下さい 19

20 ugui の利用方法 ugui を Desktop Mascot Maker で利用するためには ugui の Canvas の RenderMode を ScreenSpace - Camera にして Canvas の Render Camera にマスコットを表示するためのカメラを設定して下さい 詳しくは Demo04_ForFree_uGUI.unity Demo04_ForPro_uGUI.unity のデモをご覧下さい 20

21 ビルドセッティング Desktop Mascot Maker は Unity4.6 では 32bit ソフトウェアとしてビルドする必要があります Build Settings を以下のように設定してビルドして下さい Unity4.6 でビルドする場合 21