よくあるお問い合わせ

CPU の処理負荷を軽減したい

基本的な対処方法には下記があります。

1. デフォルト値から全く変化しないアトリビュートにはキーを打たない。
   例えば、不透明度キーの値が 1 のままで変化しないのであればキーを削除してしまいます。 OPTPiX SpriteStudio 5.3.5 以降で対応される「無変化キーの削除」機能を利用する。

2. 同じ結果をもたらすアトリビュート設定は、なるべく使用アトリビュートを絞って行う。
   例えば、パーツを反転する場合、上下/左右反転アトリビュートを指定するよりも、X/Y スケール値に負数を指定することで反転する方が若干高速になります。
   また、非表示:ON と 不透明度=0 で同様の結果を得られますが、CPU負荷においてはほぼ差はありません。

3. できる限りパーツ数を減らす。
   再生する上で必要のないパーツは削除しましょう。

なお、v1.0 以降では、補間計算をインポート時に行うため、ベジェ補間を減らして 線形補間で代替するなどの工夫を行っても速度に差は出ません。

内部処理の高速化については今後のアップデートで対応を検討しています。

(2014/10/21 v1.1 時点)

補足

非表示=ON の場合、メッシュの該当パーツはバインディングの登録にいかないため、不透明度=0に比べると、

a. パーツの表示登録+ソート
b. バインディング
c. 頂点、ピクセルシェーダ

これらの処理を行わない分、僅かに軽くなります。
とはいえ、アニメの更新処理計算や、主要なパーツ処理は通るため、その差はごく僅かなものと考えられます。

想定以上にドローコールが増えるのはなぜですか？

まず、SS5Player for Unity v1.1 からは、主に OPTPiX SpriteStudio v5.3.0 で追加されたインスタンス機能に対応し、且つ、優先度アトリビュートにより設定された描画順序を守るため、以下の様な手順で描画パーツを並べ替えています。

• １. 各アニメーションオブジェクトのルートパーツ位置での（カメラ座標系に投影後の）Z座標でソート

• ２. 各アニメーションオブジェクト内でパーツの描画優先度でのソート

• "優先度"アトリビュートのキーがあればその値を、なければパーツの順番にならう。

• ３. 2でソートされた各アニメーションオブジェクトを1での優先度に従って収集して、該当する位置にインスタンスパーツを割り込ませた後に、使用マテリアル（テクスチャや合成方法）毎での使用順序を考慮してバッチする。

このため、1オブジェクトに複数のマテリアルを使用している状態では、Z座標を調整してもドローコール回数はほとんど削減できません。 ※2のソートの結果時点で、アニメーション内で複数のマテリアルに分かれているため、そこでドローコールが発生してしまうためです。

ドローコール削減を期待する場合は、なるべく1オブジェクトを複数マテリアルで構成せず、 できる限り1マテリアル（1合成オペレーション・1テクスチャ）で構成する必要があります。

また、使用しているマテリアル（テクスチャや合成方法）が２つであっても、「優先度」と「パーツ位置」の設定によっては、２よりも多くドローコールがかかる場合があります。 「優先度」と「パーツ位置」順で「パーツが表示される順序」を見ていった時に、テクスチャや合成方法が切り替わる回数分だけドローコールがかかります。

※この場合のパーツ位置とは「SSのタイムライン上でのパーツの上下位置」のことで、「異なるパーツで、同じ優先度の値が設定されている場合、SS5のタイムライン上で上に位置しているパーツの方が優先度が低い」という扱いになります。

ドローコールの増え方がよくわかりません

・1. １つのアニメで使っているテクスチャが１つの場合

複数アニメ間でもバッチされドローコールは減ります。 ただし、異なるテクスチャや合成方法を使っているアニメ同士では、Z座標が同じ値の場合、 互いのパーツが重なり合っていなくても自動的にはバッチされません。 このため、テクスチャ別にレイヤーを意識したZ座標の指定が必要になります。

例を出すと下記のようになります。

A) 下記の様に３つのアニメプレハブを互いが重なり合わないようにX/YをずらしてZ座標をすべて同じにすると、ドローコールが２か３になります。 （２になるか３になるかは、Unityの内部処理でのオブジェクトの実行順序に依存し、実行時毎に異なる可能性があります）。

例：

• アニメ1(テクスチャA)　　　　Z座標=0
  • アニメ2(テクスチャB)　　　Z座標=0
    • アニメ3(テクスチャA)　　Z座標=0

B) 上記のZ座標を下記のように３つのレイヤーに分けても、やはりドローコールが３になります。

例：

• アニメ1(テクスチャA)　　　　　Z座標=0
  • アニメ2(テクスチャB)　　　　Z座標=10
    • アニメ3(テクスチャA)　　　Z座標=20

C) テクスチャAを前面(Z=0) に テクスチャBを背面(Z=10) にするとドローコールは２になります。

例：

• アニメ1(テクスチャA)　　　　　　Z座標=0
  • アニメ2(テクスチャB)　　　　　Z座標=10
    • アニメ3(テクスチャA)　　　　Z座標=0

・2. １つのアニメで２つ以上のテクスチャを使っている場合

別のオブジェクト間では、ほとんどバッチングはされません。 (※理由は "Q. 想定以上にドローコールが増えるのはなぜですか？" をご覧ください) つまり、１つのアニメで２つのテクスチャを使いドローコールが２となる場合は、 同じアニメのオブジェクトでパーツが重ならないように配置しても、 ほぼオブジェクトの数だけドローコールが増えます。

テクスチャを２枚使用したアニメーションオブジェクトを３つ配置した場合の例。

• アニメーションオブジェクト1

  • パーツ1(テクスチャAの描画)
  • パーツ2(テクスチャBの描画)

• アニメーションオブジェクト2

  • パーツ1(テクスチャAの描画)
  • パーツ2(テクスチャBの描画)

• アニメーションオブジェクト3

  • パーツ1(テクスチャAの描画)
  • パーツ2(テクスチャBの描画)

この場合テクスチャAとテクスチャBの切り替え時にドローコールが発生し、ドローコールは６になります。

ただし、バッチングが一切きかないかというと、そうではなく、ドローコールが削減される場合があります。 その場合の例には、下記のような場合があります。

• アニメーションオブジェクト1

  • パーツ1(テクスチャA)
  • パーツ2(テクスチャB)
  • パーツ3(テクスチャA) ↓アニメーションオブジェクト2のパーツ1とバッチングされる

• アニメーションオブジェクト2

  • パーツ1(テクスチャA) ↑アニメーションオブジェクト1のパーツ3とバッチングされる
  • パーツ2(テクスチャB)
  • パーツ3(テクスチャA) ↓アニメーションオブジェクト3のパーツ1とバッチングされる

• アニメーションオブジェクト3

  • パーツ1(テクスチャA) ↑アニメーションオブジェクト2のパーツ3とバッチングされる
  • パーツ2(テクスチャB)
  • パーツ3(テクスチャA)

この場合ドローコールは（９ではなく）７になります。

OPTPiX SpriteStudio Import-SettingsダイアログにImportボタンが表示されない

• 対応方法：ダイアログを広げる

  OPTPiX SpriteStudio Import-SettingsダイアログにImportボタンが表示されない場合があります。 ボタンはダイアログのしたの方に隠れており、ダイアログの右下をドラッグし広げることで表示されます。

OPTPiX SpriteStudio 5 と SS5PlayerForUnity で描画結果が異なる

• 対応方法：アニメデータのVer.4との互換性を確認する

  SS5PlayerForUnityではSpriteStudio本体のVer.4との互換性に対応していません。 プロジェクト設定の互換性の項目にあります、Ver.4との互換性はすべてチェックを外した状態でデータを作成してください。

アバターの着せ替えのような、パーツの差し替えをしたい

• SS5PU v1.1の場合

  アバターの差し替え可能なパーツをインスタンスパーツとして作成・設定して、 それを「Script_SpriteStudio_PartsInstanceのPrefabChangeInstance関数」などで差し替えます。

  ・応用テクニック：インスタンスパーツの切り替え

  インスタンスパーツを使い、普段はダミーの透明のアニメーションオブジェクトを呼び出すようにしておきます。 「実験機能」として提供されているScript_SpriteStudio_PartsInstanceのAnimationChangeInstance/PrefabChangeInstance関数を使用して再生するインスタンスアニメーションオブジェクトを切り替える事ができます。

  例えばアバターの衣装などを変更した場合に、追加のエフェクト等を表示するといった使い方が考えられます。（望まれる動作仕様によっては、同関数の改造が必要になる場合があります）

• SS5PU v1.0の場合

  A. 着せ替えのある箇所（例えば「髪」「服」など）を別のテクスチャ（セルマップ）で作成する。（その際に、新しいセルマップは、大元のセルと同じ大きさ・同じ配置・同じピボットでセルマップを作成する必要があります）

  B. Unity上で、そのテクスチャを割り当てた新規マテリアルをインスタンスのScript_SpriteStudio_PartsRootの「public Material[] TableMaterial」の該当箇所に設定を行う。

  以上の方法で差し替えが可能です。（AとBは同時に行う必要があり、どちらか片方だけでは実現が不可能です）

  アバターのようなキャラクタを作成する場合、アプリケーション全体でのドローコールの増加の可能性があります。

スクリプトからのアニメの切替時に再生フレームが０に戻らないようにする方法

• 対応方法

  Script_SpriteStudio_PartsRootの「AnimationPlay」関数の引数「FrameInitial」にあらかじめ読み出しておいた（同クラスの）FrameNoNowの値を設定することで可能です。

  ラベルなどで再生区間を規定していた場合には、FrameNoStart～FrameNoEndの間になるように配慮して値を与える必要があります。

• 制限 再生していたアニメーションと新規に再生するアニメーションとで、フレーム毎の動きが同じである必要があります。

  最低でも、全フレーム数は同じでなくてはなりません。異なる場合「配列外を参照した」と言う例外エラーが出てしまう場合があります。全フレームの動きが同じでない場合、コマ飛びしたような現象が起こります。

NGUI 上のコントロールの間に挟みたい

• 概要

  原則として「NG」となります。

  ドローコール削減の最適化と、マルチマテリアル使用の際の表示の厳密性を保つために次のような設計となっています。

  SSで作成したアニメーションをパーツ毎で描画するのではなく、SSで作成されたアニメーションデータのみをまとめて最適化しメッシュバッチングして「パーツの描画順序を考慮してできる限り少ないメッシュに合成して」しまい、Unityに描画指示行います。 この動作によってUnity-Nativeオブジェクトとの描画を混在させる事が難しくなっています。

• 対応方法：ssaeの分割を行う

  間にNGUIやUnity-Nativeオブジェクトをはさむ位置でSS上でアニメーションオブジェクトを分割し、別々のssaeにします。 同じssaeの中で2つのアニメーションを作って分割する方法でも良いですが、格納データとしては無駄が多くなります。

  この2オブジェクトを2つのViewに別々に配置し、ViewのDrawManagerの描画順設定を変更します。その際に両Viewの間に「Render-Queue Offset」を使用して、ある程度の「（描画Queueの）空き」を作っておきます。 間に挟むNGUIやUnity-Nativeオブジェクトの描画Queueを、その「空き」の間に入るように設定します。

動的にアニメ全体の色や透明度を変更する

• 対応方法：一度レンダリングを行ってから操作する。

  アニメ全体の色や透明度などを変更したい場合、一度当該アニメーションをテクスチャにレンダリングして、そのレンダリング画像を描画に用いる際に、Quadなどのメッシュの頂点カラーを操作して色や透明度を変更するといった方法になります。

• 理由

  透明度を変更する場合、SS5PUでは各パーツは別々にメッシュ管理されているため、半透明値を操作すると多重半透明（別のパーツとの継ぎ目が見えてしまう）描画が起こってしまい、期待する結果が得られません。

  頂点カラーを操作する場合、UnityのMeshクラスのメンバ変数を使いきっている形になるため（本来頂点カラーを入れるための領域が、オーバーレイ色を入れるための領域に変用されております）、頂点カラーを格納する領域が存在していません。

特定パーツの色や透明度を変更する

特定パーツの色を変える場合はアニメーション再生処理のメッシュ加工の処理に手を加える必要があります。

• 対応方法：SS5PUを改造する

  特定パーツのオーバーレイ色を動的に設定するためのSS5PUの改造方法になります。

  これを応用して、Script_SpriteStudio_PartsRootに動的オーバーレイ色を持つことで、各Script_SpriteStudio_Triangle2/4からScriptRootメンバを経由して、アニメーション全体の色を動的に変化させる方法にも転用可能です。

  パーツのインスタンス毎に存在しているScript_SpriteStudio_Triangle2/4.csのUpdate関数の中にある「SpriteStudioData.UpdateMesh」の処理の直後にdataMeshのcolor32メンバの値を書き換えます。

  安全なのは、別個に「Color32[] DataColor32 = new Color32[CountVertexData];」として希望するオーバーレイ色のテーブルを作成し、それをdataMeshのcolor32メンバに再割り当てする方法となります。

  オーバーレイ色の合成オペレーション方法の設定は、dataMeshのuv2メンバの.yにオペレーション番号（Library_SpriteStudio.KindColorOperation列挙）を設定することで設定可能です。

  ただし、列挙の値をfloatにキャストしてそのまま与えてしまうと、浮動小数の丸め誤差が起こる可能性があるので、キャスト後に+0.01f程度の微小な値を加算しておくことを推奨します。

• 注意点

  CountVertexDataの具体的な値については、呼び出すスプライトパーツのスクリプトが「～_Triangle2」「～_Triangle4」とで異なります。

  Color32のAの成分は、SS上でのカラーブレンドの「％」に対応している点です。SS上のカラーブレンドのAに対応しているのは、dataMeshのuv2メンバの.xになります。 この値を変更するとパーツが透けてしまいますので、基本的には変更しないことを推奨します。

• 備考

  このあたりの処理については、Library_SpriteStudio.csのAnimationDataSpriteクラス内「UpdateMesh」関数の「Set Vertex-Datas」の注釈以降の処理が参考になると思います。

  「SpriteStudioData.UpdateMesh」関数に引数を追加した上で、「UpdateMesh」関数の内容を改造される形でも構いません。 それぞれのクラス内にColor/Color32とオペレーション方法を格納するような場合、privateスコープで変数宣言を行い、プロパティで外部から操作する方法を推奨します。

インスタンスパーツの描画順序が OPTPiX SpriteStudio 5 と異なる

• 対応方法：優先度を設定する

同じ階層に複数のインスタンスパーツが配置されている場合、SpriteStudio 上では常にパーツの並び順(上が奥)になりますが、 Unity 上ではその通りにならないケースがあります。 この場合は、"優先度"アトリビュートのキーを打ち、描画順序を明示的に指定するようにしてください。

カラーブレンド値・不透明度値などのアトリビュート値の取得方法

例) 親パーツのカレントフレームの不透明度を得る。

FrameNo = RootNode.FrameNoNow;
OpacityRate = ParentNode.SpriteStudioData.AnimationDataOpacityRate[FrameNo];

・カラーブレンドの場合

ParentNode.AnimationDataColorBlend

・その他、各種アトリビュート

SpriteStudioData メンバが保持しています。

各種アトリビュートの配列名は以下のクラスの定義位置をご覧ください。

Library_SpriteStudio.AnimationData

不透明度アニメ(キーフレーム)を持っているか？

通常パーツ(Script_SpriteStudio_Triangle* クラス) Part に対して

if (Part.SpriteStudioData.AnimationDataOpacityRate.Length > 0)
{
	// アニメがある
}

パーツにアタッチされるスクリプトの違い

Script_SpriteStudio_PartsRoot	ルートパーツ
Script_SpriteStudio_PartsNULL	NULLパーツ
Script_SpriteStudio_Triangle2	通常パーツ(頂点変形なし)
Script_SpriteStudio_Triangle4	通常パーツ(頂点変形あり)

ルートパーツの取得方法

下記メンバがルートパーツを指します。
public Script_SpriteStudio_PartsRoot ScriptRoot;

ルートパーツ(Script_SpriteStudio_PartsRoot)自身はこのメンバを持っていません

インポート時に xxxx keyframe is out of range!! Parts:パーツ名 frame:時間 というエラーが出る

• 原因
  これは アニメーションの最終フレームを超える場所にキーフレームが打たれたssaeファイルをインポートした際に出ます。
  xxxx の部分は該当するアトリビュートの型を示します。
  例えば Vector3.Z とある場合は、Z座標か、Z軸回転のキーを示します。
  Float の場合は不透明度や当たり半径、Bool なら反転、非表示フラグなどと推測されます。

• 対処方法

1. 問題のssae ファイルを OPTPiX SpriteStudio で開いて該当パーツの該当時間に移動し、カーブエディタを開きます。
2. 前述のアトリビュートの型から推測されるアトリビュートに切り替えて、最終フレームを超えた時間に置かれたキーフレームを探します。
3. (範囲外のキーフレームと１つ前のキーフレームが補間でつながっている場合、フレームコントロール上で、該当アトリビュートの最終フレームにキーを打ちます)
4. 次に、カーブエディタ上で範囲外のキーフレームを左ドラッグで囲んで選択し、Delete キーか、Ctrl+X を押して削除します。
5. ファイルを保存し、再度Unity でプロジェクトファイルをインポートしてください。

v1.0 ではマテリアルもテクスチャも１つしか使っていないのにドローコールがアニメの数だけ増える

• 2014/9/24 現在 v1.1 beta2 にて改善済みです。

• 原因
  こちらは下記の理由により現在の仕様になっています。

1. SS5での「優先度」アトリビュートの再現性の確実性の向上（1オブジェクト内で複数マテリアルを使用した場合の描画の正しさ）
2. 複数オブジェクトのZ座標での描画優先度を確実性の向上
3. 複数オブジェクトを同一Z値で配置した際の、Zファイトでの処理速度低下の軽減
4. Flash パブリッシングへの対応のため

以上を実現するためにマテリアルをアニメーション毎に複製し、シェーダ内の描画優先度を書き換えるようになっています。

• 対処方法
  現在のところユーザー様側で対処する方法はありません。
  しかしながら前述の理由の幾つかとトレードオフすることでドローコールを増やさない改修作業をv1.1にて予定しております。
  対応状況はこちらで確認できます。